java.lang.String requestId
java.lang.String errorCode
AmazonServiceException.ErrorType errorType
AmazonServiceException.ErrorType
java.lang.String errorMessage
int statusCode
java.lang.String serviceName
java.lang.String details
PauseStatus status
java.lang.String activityId
The ID of the activity.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
The name of the Auto Scaling group.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String description
A friendly, more verbose description of the activity.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String cause
The reason the activity began.
Constraints:
Length: 1 - 1023
Pattern: [ --�𐀀-\r\n\t]*
java.util.Date startTime
The start time of the activity.
java.util.Date endTime
The end time of the activity.
java.lang.String statusCode
The current status of the activity.
Constraints:
Allowed Values: PendingSpotBidPlacement,
WaitingForSpotInstanceRequestId, WaitingForSpotInstanceId,
WaitingForInstanceId, PreInService, InProgress,
WaitingForELBConnectionDraining, MidLifecycleAction,
WaitingForInstanceWarmup, Successful, Failed, Cancelled
java.lang.String statusMessage
A friendly, more verbose description of the activity status.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer progress
A value between 0 and 100 that indicates the progress of the activity.
java.lang.String details
The details about the activity.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String adjustmentType
The policy adjustment type. The valid values are
ChangeInCapacity
, ExactCapacity
, and
PercentChangeInCapacity
.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String alarmName
The name of the alarm.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String alarmARN
The Amazon Resource Name (ARN) of the alarm.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> instanceIds
One or more instance IDs.
java.lang.String autoScalingGroupName
The name of the group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
The name of the group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> loadBalancerNames
One or more load balancer names.
java.lang.String autoScalingGroupName
The name of the group.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupARN
The Amazon Resource Name (ARN) of the group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String launchConfigurationName
The name of the associated launch configuration.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer minSize
The minimum size of the group.
java.lang.Integer maxSize
The maximum size of the group.
java.lang.Integer desiredCapacity
The desired size of the group.
java.lang.Integer defaultCooldown
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.
java.util.List<E> availabilityZones
One or more Availability Zones for the group.
java.util.List<E> loadBalancerNames
One or more load balancers associated with the group.
java.lang.String healthCheckType
The service to use for the health checks. The valid values are
EC2
and ELB
.
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer healthCheckGracePeriod
The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service.
java.util.List<E> instances
The EC2 instances associated with the group.
java.util.Date createdTime
The date and time the group was created.
java.util.List<E> suspendedProcesses
The suspended processes associated with the group.
java.lang.String placementGroup
The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String vPCZoneIdentifier
One or more subnet IDs, if applicable, separated by commas.
If you specify VPCZoneIdentifier
and
AvailabilityZones
, ensure that the Availability Zones of the
subnets match the values for AvailabilityZones
.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> enabledMetrics
The metrics enabled for the group.
java.lang.String status
The current state of the group when DeleteAutoScalingGroup is in progress.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> tags
The tags for the group.
java.util.List<E> terminationPolicies
The termination policies for the group.
java.lang.Boolean newInstancesProtectedFromScaleIn
Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
java.lang.String instanceId
The ID of the instance.
Constraints:
Length: 1 - 19
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
The name of the Auto Scaling group associated with the instance.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String availabilityZone
The Availability Zone for the instance.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String lifecycleState
The lifecycle state for the instance. For more information, see Auto Scaling Lifecycle in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String healthStatus
The health status of this instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and Auto Scaling should terminate and replace it.
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String launchConfigurationName
The launch configuration associated with the instance.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean protectedFromScaleIn
Indicates whether the instance is protected from termination by Auto Scaling when scaling in.
java.lang.String virtualName
The name of the virtual device (for example, ephemeral0
).
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String deviceName
The device name exposed to the EC2 instance (for example,
/dev/sdh
or xvdh
).
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
Ebs ebs
The information about the Amazon EBS volume.
java.lang.Boolean noDevice
Suppresses a device mapping.
If this parameter is 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.
java.lang.String lifecycleHookName
The name of the lifecycle hook.
Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+
java.lang.String autoScalingGroupName
The name of the group for the lifecycle hook.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String lifecycleActionToken
A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.
Constraints:
Length: 36 - 36
java.lang.String lifecycleActionResult
The action for the group to take. This parameter can be either
CONTINUE
or ABANDON
.
java.lang.String instanceId
The ID of the instance.
Constraints:
Length: 1 - 19
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
The name of the group. This name must be unique within the scope of your AWS account.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String launchConfigurationName
The name of the launch configuration. Alternatively, specify an EC2 instance instead of a launch configuration.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String instanceId
The ID of the instance used to create a launch configuration for the group. Alternatively, specify a launch configuration instead of an EC2 instance.
When you specify an ID of an instance, Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.
For more information, see Create an Auto Scaling Group Using an EC2 Instance in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 19
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer minSize
The minimum size of the group.
java.lang.Integer maxSize
The maximum size of the group.
java.lang.Integer desiredCapacity
The number of EC2 instances that should be running in the group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.
java.lang.Integer defaultCooldown
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.
For more information, see Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
java.util.List<E> availabilityZones
One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets.
java.util.List<E> loadBalancerNames
One or more load balancers.
For more information, see Using a Load Balancer With an Auto Scaling Group in the Auto Scaling Developer Guide.
java.lang.String healthCheckType
The service to use for the health checks. The valid values are
EC2
and ELB
.
By default, health checks use Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Checks in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer healthCheckGracePeriod
The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default is 300.
This parameter is required if you are adding an ELB
health
check.
For more information, see Health Checks in the Auto Scaling Developer Guide.
java.lang.String placementGroup
The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String vPCZoneIdentifier
A comma-separated list of subnet identifiers for your virtual private cloud (VPC).
If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.
For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> terminationPolicies
One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.
For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Auto Scaling Developer Guide.
java.lang.Boolean newInstancesProtectedFromScaleIn
Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
java.util.List<E> tags
One or more tags.
For more information, see Tagging Auto Scaling Groups and Instances in the Auto Scaling Developer Guide.
java.lang.String launchConfigurationName
The name of the launch configuration. This name must be unique within the scope of your AWS account.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String imageId
The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see Finding an AMI in the Amazon Elastic Compute Cloud User Guide.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String keyName
The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon Elastic Compute Cloud User Guide.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> securityGroups
One or more security groups with which to associate the instances.
If your instances are launched in EC2-Classic, you can either specify security group names or the security group IDs. For more information about security groups for EC2-Classic, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide.
If your instances are launched into a VPC, specify security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
java.lang.String classicLinkVPCId
The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter is supported only if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> classicLinkVPCSecurityGroups
The IDs of one or more security groups for the specified ClassicLink-enabled VPC. This parameter is required if you specify a ClassicLink-enabled VPC, and is not supported otherwise. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
java.lang.String userData
The user data to make available to the launched EC2 instances. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide.
Constraints:
Length: - 21847
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String instanceId
The ID of the instance to use to create the launch configuration.
The new launch configuration derives attributes from the instance, with the exception of the block device mapping.
To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.
For more information, see Create a Launch Configuration Using an EC2 Instance in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 19
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String instanceType
The instance type of the EC2 instance. For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String kernelId
The ID of the kernel associated with the AMI.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String ramdiskId
The ID of the RAM disk associated with the AMI.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> blockDeviceMappings
One or more mappings that specify how block devices are exposed to the instance. For more information, see Block Device Mapping in the Amazon Elastic Compute Cloud User Guide.
InstanceMonitoring instanceMonitoring
Enables detailed monitoring if it is disabled. Detailed monitoring is enabled by default.
When detailed monitoring is enabled, Amazon CloudWatch generates metrics
every minute and your account is charged a fee. When you disable detailed
monitoring, by specifying False
, CloudWatch generates
metrics every 5 minutes. For more information, see Monitoring Your Auto Scaling Instances and Groups in the Auto
Scaling Developer Guide.
java.lang.String spotPrice
The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. For more information, see Launching Spot Instances in Your Auto Scaling Group in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 255
java.lang.String iamInstanceProfile
The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.
EC2 instances launched with an IAM role will automatically have AWS security credentials available. You can use IAM roles with Auto Scaling to automatically enable applications running on your EC2 instances to securely access other AWS resources. For more information, see Launch Auto Scaling Instances with an IAM Role in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean ebsOptimized
Indicates whether the instance is optimized for Amazon EBS I/O. By default, the instance is not optimized for EBS I/O. The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional usage charges apply. For more information, see Amazon EBS-Optimized Instances in the Amazon Elastic Compute Cloud User Guide.
java.lang.Boolean associatePublicIpAddress
Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling Developer Guide.
If you specify this parameter, be sure to specify at least one subnet when you create your group.
Default: If the instance is launched into a default subnet, the default
is true
. If the instance is launched into a nondefault
subnet, the default is false
. For more information, see Supported Platforms in the Amazon Elastic Compute Cloud User
Guide.
java.lang.String placementTenancy
The tenancy of the instance. An instance with a tenancy of
dedicated
runs on single-tenant hardware and can only be
launched into a VPC.
You must set the value of this parameter to dedicated
if
want to launch Dedicated Instances into a shared tenancy VPC (VPC with
instance placement tenancy attribute set to default
).
If you specify this parameter, be sure to specify at least one subnet when you create your group.
For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling Developer Guide.
Valid values: default
| dedicated
Constraints:
Length: 1 - 64
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> tags
One or more tags.
java.lang.String autoScalingGroupName
The name of the group to delete.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean forceDelete
Specifies that the group will be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions associated with the group.
java.lang.String launchConfigurationName
The name of the launch configuration.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String lifecycleHookName
The name of the lifecycle hook.
Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+
java.lang.String autoScalingGroupName
The name of the Auto Scaling group for the lifecycle hook.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
The name of the Auto Scaling group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String topicARN
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
The name of the Auto Scaling group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String policyName
The name or Amazon Resource Name (ARN) of the policy.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
The name of the Auto Scaling group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String scheduledActionName
The name of the action to delete.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> tags
One or more tags.
java.lang.Integer maxNumberOfAutoScalingGroups
The maximum number of groups allowed for your AWS account. The default limit is 20 per region.
java.lang.Integer maxNumberOfLaunchConfigurations
The maximum number of launch configurations allowed for your AWS account. The default limit is 100 per region.
java.lang.Integer numberOfAutoScalingGroups
The current number of groups for your AWS account.
java.lang.Integer numberOfLaunchConfigurations
The current number of launch configurations for your AWS account.
java.util.List<E> adjustmentTypes
The policy adjustment types.
java.util.List<E> autoScalingGroupNames
The group names.
java.lang.String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer maxRecords
The maximum number of items to return with this call.
java.util.List<E> autoScalingGroups
The groups.
java.lang.String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> instanceIds
The instances to describe; up to 50 instance IDs. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.
java.lang.Integer maxRecords
The maximum number of items to return with this call.
java.lang.String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> autoScalingInstances
The instances.
java.lang.String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> autoScalingNotificationTypes
One or more of the following notification types:
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
java.util.List<E> launchConfigurationNames
The launch configuration names.
java.lang.String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer maxRecords
The maximum number of items to return with this call. The default is 100.
java.util.List<E> launchConfigurations
The launch configurations.
java.lang.String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
The name of the group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> lifecycleHookNames
The names of one or more lifecycle hooks.
java.util.List<E> lifecycleHooks
The lifecycle hooks for the specified group.
java.util.List<E> lifecycleHookTypes
One or more of the following notification types:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
java.lang.String autoScalingGroupName
The name of the group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer maxRecords
The maximum number of items to return with this call.
java.util.List<E> loadBalancers
The load balancers.
java.lang.String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> metrics
One or more metrics.
java.util.List<E> granularities
The granularities for the metrics.
java.util.List<E> autoScalingGroupNames
The name of the group.
java.lang.String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer maxRecords
The maximum number of items to return with this call.
java.util.List<E> notificationConfigurations
The notification configurations.
java.lang.String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
The name of the group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> policyNames
One or more policy names or policy ARNs to be described. If you omit this list, all policy names are described. If an group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.
java.util.List<E> policyTypes
One or more policy types. Valid values are SimpleScaling
and
StepScaling
.
java.lang.String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer maxRecords
The maximum number of items to be returned with each call.
java.util.List<E> scalingPolicies
The scaling policies.
java.lang.String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> activityIds
The activity IDs of the desired scaling activities. If this list is omitted, all activities are described. If you specify an Auto Scaling group, 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
The name of the group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer maxRecords
The maximum number of items to return with this call.
java.lang.String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> activities
The scaling activities.
java.lang.String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> processes
The names of the process types.
java.lang.String autoScalingGroupName
The name of the group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> scheduledActionNames
Describes one or more scheduled actions. If you omit this list, the call describes all scheduled actions. If you specify an unknown scheduled action it is ignored with no error.
You can describe up to a maximum of 50 instances with a single call. If there are more items to return, the call returns a token. To get the next set of items, repeat the call with the returned token.
java.util.Date startTime
The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
java.util.Date endTime
The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
java.lang.String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer maxRecords
The maximum number of items to return with this call.
java.util.List<E> scheduledUpdateGroupActions
The scheduled actions.
java.lang.String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> filters
A filter used to scope the tags to return.
java.lang.String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer maxRecords
The maximum number of items to return with this call.
java.util.List<E> tags
One or more tags.
java.lang.String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> terminationPolicyTypes
The termination policies supported by Auto Scaling (
OldestInstance
, OldestLaunchConfiguration
,
NewestInstance
, ClosestToNextInstanceHour
, and
Default
).
java.util.List<E> instanceIds
One or more instance IDs.
java.lang.String autoScalingGroupName
The name of the group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean shouldDecrementDesiredCapacity
If True
, the Auto Scaling group decrements the desired
capacity value by the number of instances detached.
java.util.List<E> activities
The activities related to detaching the instances from the Auto Scaling group.
java.lang.String autoScalingGroupName
The name of the group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> loadBalancerNames
One or more load balancer names.
java.lang.String autoScalingGroupName
The name or Amazon Resource Name (ARN) of the group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> metrics
One or more of the following metrics. If you omit this parameter, all metrics are disabled.
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
java.lang.String snapshotId
The ID of the snapshot.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer volumeSize
The volume size, in GiB. For standard
volumes, specify a
value from 1 to 1,024. For io1
volumes, specify a value from
4 to 16,384. For gp2
volumes, specify a value from 1 to
16,384. If you specify a snapshot, the volume size must be equal to or
larger than the snapshot size.
Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the snapshot size.
Constraints:
Range: 1 - 16384
java.lang.String volumeType
The volume type. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Valid values: standard
| io1
| gp2
Default: standard
Constraints:
Length: 1 - 255
java.lang.Boolean deleteOnTermination
Indicates whether the volume is deleted on instance termination.
Default: true
java.lang.Integer iops
The number of I/O operations per second (IOPS) to provision for the volume.
Constraint: Required when the volume type is io1
.
Constraints:
Range: 100 - 20000
java.lang.Boolean encrypted
Indicates whether the volume should be encrypted. Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or an unencrypted volume from an encrypted snapshot. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
java.lang.String metric
One of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String granularity
The granularity of the metric. The only valid value is
1Minute
.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
The name or ARN of the Auto Scaling group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> metrics
One or more of the following metrics. If you omit this parameter, all metrics are enabled.
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
Note that the GroupStandbyInstances
metric is not enabled by
default. You must explicitly request this metric.
java.lang.String granularity
The granularity to associate with the metrics to collect. The only valid
value is 1Minute
.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> instanceIds
One or more instances to move into Standby
mode. You must
specify at least one instance ID.
java.lang.String autoScalingGroupName
The name of the Auto Scaling group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean shouldDecrementDesiredCapacity
Specifies whether the instances moved to Standby
mode count
as part of the Auto Scaling group's desired capacity. If set, the desired
capacity for the Auto Scaling group decrements by the number of instances
moved to Standby
mode.
java.util.List<E> activities
The activities related to moving instances into Standby
mode.
java.lang.String autoScalingGroupName
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String policyName
The name or ARN of the policy.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean honorCooldown
If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy. Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to complete.
This parameter is not supported if the policy type is
StepScaling
.
For more information, see Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
java.lang.Double metricValue
The metric value to compare to BreachThreshold
. This enables
you to execute a policy of type StepScaling
and determine
which step adjustment to use. For example, if the breach threshold is 50
and you want to use a step adjustment with a lower bound of 0 and an
upper bound of 10, you can set the metric value to 59.
If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.
This parameter is required if the policy type is StepScaling
and not supported otherwise.
java.lang.Double breachThreshold
The breach threshold for the alarm.
This parameter is required if the policy type is StepScaling
and not supported otherwise.
java.util.List<E> instanceIds
One or more instance IDs. You must specify at least one instance ID.
java.lang.String autoScalingGroupName
The name of the Auto Scaling group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> activities
The activities related to moving instances out of Standby
mode.
java.lang.String name
The name of the filter. The valid values are:
"auto-scaling-group"
, "key"
,
"value"
, and "propagate-at-launch"
.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> values
The value of the filter.
java.lang.String instanceId
The ID of the instance.
Constraints:
Length: 1 - 19
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String availabilityZone
The Availability Zone in which the instance is running.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String lifecycleState
A description of the current lifecycle state. Note that the
Quarantined
state is not used.
Constraints:
Allowed Values: Pending, Pending:Wait, Pending:Proceed,
Quarantined, InService, Terminating, Terminating:Wait,
Terminating:Proceed, Terminated, Detaching, Detached, EnteringStandby,
Standby
java.lang.String healthStatus
The health status of the instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and Auto Scaling should terminate and replace it.
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String launchConfigurationName
The launch configuration associated with the instance.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean protectedFromScaleIn
Indicates whether the instance is protected from termination by Auto Scaling when scaling in.
java.lang.Boolean enabled
If True
, instance monitoring is enabled.
java.lang.String launchConfigurationName
The name of the launch configuration.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String launchConfigurationARN
The Amazon Resource Name (ARN) of the launch configuration.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String imageId
The ID of the Amazon Machine Image (AMI).
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String keyName
The name of the key pair.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> securityGroups
The security groups to associate with the instances.
java.lang.String classicLinkVPCId
The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter can only be used if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> classicLinkVPCSecurityGroups
The IDs of one or more security groups for the VPC specified in
ClassicLinkVPCId
. This parameter is required if you specify
a ClassicLink-enabled VPC, and cannot be used otherwise. For more
information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
java.lang.String userData
The user data available to the instances.
Constraints:
Length: - 21847
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String instanceType
The instance type for the instances.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String kernelId
The ID of the kernel associated with the AMI.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String ramdiskId
The ID of the RAM disk associated with the AMI.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> blockDeviceMappings
A block device mapping, which specifies the block devices for the instance.
InstanceMonitoring instanceMonitoring
Controls whether instances in this group are launched with detailed monitoring.
java.lang.String spotPrice
The price to bid when launching Spot Instances.
Constraints:
Length: 1 - 255
java.lang.String iamInstanceProfile
The name or Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.util.Date createdTime
The creation date and time for the launch configuration.
java.lang.Boolean ebsOptimized
Controls whether the instance is optimized for EBS I/O (true
) or not (false
).
java.lang.Boolean associatePublicIpAddress
[EC2-VPC] Indicates whether to assign a public IP address to each instance.
java.lang.String placementTenancy
The tenancy of the instance, either default
or
dedicated
. An instance with dedicated
tenancy
runs in an isolated, single-tenant hardware and can only be launched into
a VPC.
Constraints:
Length: 1 - 64
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String lifecycleHookName
The name of the lifecycle hook.
Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+
java.lang.String autoScalingGroupName
The name of the Auto Scaling group for the lifecycle hook.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String lifecycleTransition
The state of the EC2 instance to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.
java.lang.String notificationTargetARN
The ARN of the notification target that Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic. The notification message sent to the target includes the following:
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String roleARN
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String notificationMetadata
Additional information that you want to include any time Auto Scaling sends a message to the notification target.
Constraints:
Length: 1 - 1023
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer heartbeatTimeout
The maximum time, in seconds, that can elapse before the lifecycle hook times out. The default is 3600 seconds (1 hour). When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.
java.lang.Integer globalTimeout
The maximum time, in seconds, that an instance can remain in a
Pending:Wait
or Terminating:Wait
state. The
default is 172800 seconds (48 hours).
java.lang.String defaultResult
Defines the action the Auto Scaling group should take when the lifecycle
hook timeout elapses or if an unexpected failure occurs. The valid values
are CONTINUE
and ABANDON
. The default value is
CONTINUE
.
java.lang.String loadBalancerName
The name of the load balancer.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String state
One of the following load balancer states:
Adding
- The instances in the group are being registered
with the load balancer.
Added
- All instances in the group are registered with the
load balancer.
InService
- At least one instance in the group passed an ELB
health check.
Removing
- The instances are being deregistered from the
load balancer. If connection draining is enabled, Elastic Load Balancing
waits for in-flight requests to complete before deregistering the
instances.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String metric
One of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String granularity
The granularity. The only valid value is 1Minute
.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
The name of the group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String topicARN
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String notificationType
One of the following event notification types:
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String processName
One of the following processes:
Launch
Terminate
AddToLoadBalancer
AlarmNotification
AZRebalance
HealthCheck
ReplaceUnhealthy
ScheduledActions
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String lifecycleHookName
The name of the lifecycle hook.
Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+
java.lang.String autoScalingGroupName
The name of the Auto Scaling group to which you want to assign the lifecycle hook.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String lifecycleTransition
The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
java.lang.String roleARN
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String notificationTargetARN
The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN.
The notification messages sent to the target include the following information:
This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.
When you specify a notification target, Auto Scaling sends it a test
message. Test messages contains the following additional key/value pair:
"Event": "autoscaling:TEST_NOTIFICATION"
.
Constraints:
Length: 0 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String notificationMetadata
Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.
Constraints:
Length: 1 - 1023
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer heartbeatTimeout
The amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. The default is 3600 seconds (1 hour).
java.lang.String defaultResult
Defines the action the Auto Scaling group should take when the lifecycle
hook timeout elapses or if an unexpected failure occurs. This parameter
can be either CONTINUE
or ABANDON
. The default
value is ABANDON
.
java.lang.String autoScalingGroupName
The name of the Auto Scaling group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String topicARN
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> notificationTypes
The type of event that will cause the notification to be sent. For details about notification types supported by Auto Scaling, see DescribeAutoScalingNotificationTypes.
java.lang.String autoScalingGroupName
The name or ARN of the group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String policyName
The name of the policy.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String policyType
The policy type. Valid values are SimpleScaling
and
StepScaling
. If the policy type is null, the value is
treated as SimpleScaling
.
Constraints:
Length: 1 - 64
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String adjustmentType
The adjustment type. Valid values are ChangeInCapacity
,
ExactCapacity
, and PercentChangeInCapacity
.
For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer minAdjustmentStep
Available for backward compatibility. Use
MinAdjustmentMagnitude
instead.
java.lang.Integer minAdjustmentMagnitude
The minimum number of instances to scale. If the value of
AdjustmentType
is PercentChangeInCapacity
, the
scaling policy changes the DesiredCapacity
of the Auto
Scaling group by at least this many instances. Otherwise, the error is
ValidationError
.
java.lang.Integer scalingAdjustment
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
This parameter is required if the policy type is
SimpleScaling
and not supported otherwise.
java.lang.Integer cooldown
The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.
This parameter is not supported unless the policy type is
SimpleScaling
.
For more information, see Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
java.lang.String metricAggregationType
The aggregation type for the CloudWatch metrics. Valid values are
Minimum
, Maximum
, and Average
. If
the aggregation type is null, the value is treated as
Average
.
This parameter is not supported if the policy type is
SimpleScaling
.
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> stepAdjustments
A set of adjustments that enable you to scale based on the size of the alarm breach.
This parameter is required if the policy type is StepScaling
and not supported otherwise.
java.lang.Integer estimatedInstanceWarmup
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.
This parameter is not supported if the policy type is
SimpleScaling
.
java.lang.String policyARN
The Amazon Resource Name (ARN) of the policy.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String scheduledActionName
The name of this scaling action.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.util.Date time
This parameter is deprecated.
java.util.Date startTime
The time for this action to start, in "YYYY-MM-DDThh:mm:ssZ" format in
UTC/GMT only (for example, 2014-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 starts and stops.
java.util.Date endTime
The time for this action to end.
java.lang.String recurrence
The time when recurring future actions will start. Start time is specified by the user following the Unix cron syntax format. For more information, see Cron in Wikipedia.
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: [ --�𐀀-\r\n\t]*
java.lang.Integer minSize
The minimum size for the Auto Scaling group.
java.lang.Integer maxSize
The maximum size for the Auto Scaling group.
java.lang.Integer desiredCapacity
The number of EC2 instances that should be running in the group.
java.lang.String lifecycleHookName
The name of the lifecycle hook.
Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+
java.lang.String autoScalingGroupName
The name of the Auto Scaling group for the hook.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String lifecycleActionToken
A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.
Constraints:
Length: 36 - 36
java.lang.String instanceId
The ID of the instance.
Constraints:
Length: 1 - 19
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> scalingProcesses
One or more of the following processes:
Launch
Terminate
HealthCheck
ReplaceUnhealthy
AZRebalance
AlarmNotification
ScheduledActions
AddToLoadBalancer
java.lang.String autoScalingGroupName
The name of the Auto Scaling group associated with this scaling policy.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String policyName
The name of the scaling policy.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String policyARN
The Amazon Resource Name (ARN) of the policy.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String policyType
The policy type. Valid values are SimpleScaling
and
StepScaling
.
Constraints:
Length: 1 - 64
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String adjustmentType
The adjustment type, which specifies how ScalingAdjustment
is interpreted. Valid values are ChangeInCapacity
,
ExactCapacity
, and PercentChangeInCapacity
.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer minAdjustmentStep
Available for backward compatibility. Use
MinAdjustmentMagnitude
instead.
java.lang.Integer minAdjustmentMagnitude
The minimum number of instances to scale. If the value of
AdjustmentType
is PercentChangeInCapacity
, the
scaling policy changes the DesiredCapacity
of the Auto
Scaling group by at least this many instances. Otherwise, the error is
ValidationError
.
java.lang.Integer scalingAdjustment
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
java.lang.Integer cooldown
The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.
java.util.List<E> stepAdjustments
A set of adjustments that enable you to scale based on the size of the alarm breach.
java.lang.String metricAggregationType
The aggregation type for the CloudWatch metrics. Valid values are
Minimum
, Maximum
, and Average
.
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer estimatedInstanceWarmup
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
java.util.List<E> alarms
The CloudWatch alarms related to the policy.
java.lang.String autoScalingGroupName
The name of the group.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String scheduledActionName
The name of the scheduled action.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String scheduledActionARN
The Amazon Resource Name (ARN) of the scheduled action.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.util.Date time
This parameter is deprecated.
java.util.Date startTime
The date and time that the action is scheduled to begin. This date and time can be up to one month in the future.
When StartTime
and EndTime
are specified with
Recurrence
, they form the boundaries of when the recurring
action will start and stop.
java.util.Date endTime
The date and time that the action is scheduled to end. This date and time can be up to one month in the future.
java.lang.String recurrence
The recurring schedule for the action.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer minSize
The minimum size of the group.
java.lang.Integer maxSize
The maximum size of the group.
java.lang.Integer desiredCapacity
The number of instances you prefer to maintain in the group.
java.lang.String autoScalingGroupName
The name of the Auto Scaling group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer desiredCapacity
The number of EC2 instances that should be running in the Auto Scaling group.
java.lang.Boolean honorCooldown
By default, SetDesiredCapacity
overrides any cooldown period
associated with the Auto Scaling group. Specify True
to make
Auto Scaling to wait for the cool-down period associated with the Auto
Scaling group to complete before initiating a scaling activity to set
your Auto Scaling group to its new capacity.
java.lang.String instanceId
The ID of the instance.
Constraints:
Length: 1 - 19
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String healthStatus
The health status of the instance. Set to Healthy
if you
want the instance to remain in service. Set to Unhealthy
if
you want the instance to be out of service. Auto Scaling will terminate
and replace the unhealthy instance.
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean shouldRespectGracePeriod
If the Auto Scaling group of the specified instance has a
HealthCheckGracePeriod
specified for the group, by default,
this call will respect the grace period. Set this to False
,
if you do not want the call to respect the grace period associated with
the group.
For more information, see the description of the health check grace period for CreateAutoScalingGroup.
java.util.List<E> instanceIds
One or more instance IDs.
java.lang.String autoScalingGroupName
The name of the group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean protectedFromScaleIn
Indicates whether the instance is protected from termination by Auto Scaling when scaling in.
java.lang.Double metricIntervalLowerBound
The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
java.lang.Double metricIntervalUpperBound
The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.
The upper bound must be greater than the lower bound.
java.lang.Integer scalingAdjustment
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
java.lang.String processName
The name of the suspended process.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String suspensionReason
The reason that the process was suspended.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> scalingProcesses
One or more of the following processes:
Launch
Terminate
HealthCheck
ReplaceUnhealthy
AZRebalance
AlarmNotification
ScheduledActions
AddToLoadBalancer
java.lang.String resourceId
The name of the group.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String resourceType
The type of resource. The only supported value is
auto-scaling-group
.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String key
The tag key.
Constraints:
Length: 1 - 128
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String value
The tag value.
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean propagateAtLaunch
Determines whether the tag is added to new instances as they are launched in the group.
java.lang.String resourceId
The name of the group.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String resourceType
The type of resource. The only supported value is
auto-scaling-group
.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String key
The tag key.
Constraints:
Length: 1 - 128
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String value
The tag value.
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean propagateAtLaunch
Determines whether the tag is added to new instances as they are launched in the group.
java.lang.String instanceId
The ID of the instance.
Constraints:
Length: 1 - 19
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean shouldDecrementDesiredCapacity
If true
, terminating the instance also decrements the size
of the Auto Scaling group.
Activity activity
A scaling activity.
java.lang.String autoScalingGroupName
The name of the Auto Scaling group.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String launchConfigurationName
The name of the launch configuration.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer minSize
The minimum size of the Auto Scaling group.
java.lang.Integer maxSize
The maximum size of the Auto Scaling group.
java.lang.Integer desiredCapacity
The number of EC2 instances that should be running in the Auto Scaling group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.
java.lang.Integer defaultCooldown
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.
For more information, see Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
java.util.List<E> availabilityZones
One or more Availability Zones for the group.
java.lang.String healthCheckType
The service to use for the health checks. The valid values are
EC2
and ELB
.
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer healthCheckGracePeriod
The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default is 300.
For more information, see Health Checks in the Auto Scaling Developer Guide.
java.lang.String placementGroup
The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String vPCZoneIdentifier
The ID of the subnet, if you are launching into a VPC. You can specify several subnets in a comma-separated list.
When you specify VPCZoneIdentifier
with
AvailabilityZones
, ensure that the subnets' Availability
Zones match the values you specify for AvailabilityZones
.
For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.util.List<E> terminationPolicies
A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.
For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Auto Scaling Developer Guide.
java.lang.Boolean newInstancesProtectedFromScaleIn
Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
java.lang.String alarmName
The descriptive name for the alarm.
Constraints:
Length: 1 - 255
java.util.Date timestamp
The time stamp for the alarm history item.
java.lang.String historyItemType
The type of alarm history item.
Constraints:
Allowed Values: ConfigurationUpdate, StateUpdate, Action
java.lang.String historySummary
A human-readable summary of the alarm history.
Constraints:
Length: 1 - 255
java.lang.String historyData
Machine-readable data about the alarm in JSON format.
Constraints:
Length: 1 - 4095
java.util.Date timestamp
The time stamp used for the datapoint.
java.lang.Double sampleCount
The number of metric values that contributed to the aggregate value of this datapoint.
java.lang.Double average
The average of metric values that correspond to the datapoint.
java.lang.Double sum
The sum of metric values used for the datapoint.
java.lang.Double minimum
The minimum metric value used for the datapoint.
java.lang.Double maximum
The maximum of the metric value used for the datapoint.
java.lang.String unit
The standard unit used for the datapoint.
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.util.List<E> alarmNames
A list of alarms to be deleted.
java.lang.String alarmName
The name of the alarm.
Constraints:
Length: 1 - 255
java.lang.String historyItemType
The type of alarm histories to retrieve.
Constraints:
Allowed Values: ConfigurationUpdate, StateUpdate, Action
java.util.Date startDate
The starting date to retrieve alarm history.
java.util.Date endDate
The ending date to retrieve alarm history.
java.lang.Integer maxRecords
The maximum number of alarm history records to retrieve.
Constraints:
Range: 1 - 100
java.lang.String nextToken
The token returned by a previous call to indicate that there is more data available.
Constraints:
Length: 0 - 1024
java.util.List<E> alarmHistoryItems
A list of alarm histories in JSON format.
java.lang.String nextToken
A string that marks the start of the next batch of returned results.
Constraints:
Length: 0 - 1024
java.lang.String metricName
The name of the metric.
Constraints:
Length: 1 - 255
java.lang.String namespace
The namespace of the metric.
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String statistic
The statistic for the metric.
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
java.util.List<E> dimensions
The list of dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the DescribeAlarmsForMetric to succeed.
java.lang.Integer period
The period in seconds over which the statistic is applied.
Constraints:
Range: 60 -
java.lang.String unit
The unit for the metric.
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.util.List<E> metricAlarms
A list of information for each alarm with the specified metric.
java.util.List<E> alarmNames
A list of alarm names to retrieve information for.
java.lang.String alarmNamePrefix
The alarm name prefix. AlarmNames
cannot be specified if
this parameter is specified.
Constraints:
Length: 1 - 255
java.lang.String stateValue
The state value to be used in matching alarms.
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
java.lang.String actionPrefix
The action name prefix.
Constraints:
Length: 1 - 1024
java.lang.Integer maxRecords
The maximum number of alarm descriptions to retrieve.
Constraints:
Range: 1 - 100
java.lang.String nextToken
The token returned by a previous call to indicate that there is more data available.
Constraints:
Length: 0 - 1024
java.util.List<E> metricAlarms
A list of information for the specified alarms.
java.lang.String nextToken
A string that marks the start of the next batch of returned results.
Constraints:
Length: 0 - 1024
java.lang.String name
The name of the dimension.
Constraints:
Length: 1 - 255
java.lang.String value
The value representing the dimension measurement
Constraints:
Length: 1 - 255
java.lang.String name
The dimension name to be matched.
Constraints:
Length: 1 - 255
java.lang.String value
The value of the dimension to be matched.
Name
without specifying a
Value
returns all values associated with that
Name
.
Constraints:
Length: 1 - 255
java.util.List<E> alarmNames
The names of the alarms to disable actions for.
java.util.List<E> alarmNames
The names of the alarms to enable actions for.
java.lang.String namespace
The namespace of the metric, with or without spaces.
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String metricName
The name of the metric, with or without spaces.
Constraints:
Length: 1 - 255
java.util.List<E> dimensions
A list of dimensions describing qualities of the metric.
java.util.Date startTime
The time stamp to use for determining the first datapoint to return. The value specified is inclusive; results include datapoints with the time stamp specified. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).
Data that is timestamped 24 hours or more in the past may take in excess
of 48 hours to become available from submission time using
GetMetricStatistics
.
java.util.Date endTime
The time stamp to use for determining the last datapoint to return. The value specified is exclusive; results will include datapoints up to the time stamp specified. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).
java.lang.Integer period
The granularity, in seconds, of the returned datapoints.
Period
must be at least 60 seconds and must be a multiple of
60. The default value is 60.
Constraints:
Range: 60 -
java.util.List<E> statistics
The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.
java.lang.String unit
The unit for the metric.
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.String label
A label describing the specified metric.
java.util.List<E> datapoints
The datapoints for the specified metric.
java.lang.String namespace
The namespace to filter against.
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String metricName
The name of the metric to filter against.
Constraints:
Length: 1 - 255
java.util.List<E> dimensions
A list of dimensions to filter against.
java.lang.String nextToken
The token returned by a previous call to indicate that there is more data available.
Constraints:
Length: 0 - 1024
java.util.List<E> metrics
A list of metrics used to generate statistics for an AWS account.
java.lang.String nextToken
A string that marks the start of the next batch of returned results.
Constraints:
Length: 0 - 1024
java.lang.String namespace
The namespace of the metric.
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String metricName
The name of the metric.
Constraints:
Length: 1 - 255
java.util.List<E> dimensions
A list of dimensions associated with the metric.
java.lang.String alarmName
The name of the alarm.
Constraints:
Length: 1 - 255
java.lang.String alarmArn
The Amazon Resource Name (ARN) of the alarm.
Constraints:
Length: 1 - 1600
java.lang.String alarmDescription
The description for the alarm.
Constraints:
Length: 0 - 1024
java.util.Date alarmConfigurationUpdatedTimestamp
The time stamp of the last update to the alarm configuration.
java.lang.Boolean actionsEnabled
Indicates whether actions should be executed during any changes to the alarm's state.
java.util.List<E> oKActions
The list of actions to execute when this alarm transitions into an
OK
state from any other state. Each action is specified as
an Amazon Resource Name (ARN).
java.util.List<E> alarmActions
The list of actions to execute when this alarm transitions into an
ALARM
state from any other state. Each action is specified
as an Amazon Resource Name (ARN).
java.util.List<E> insufficientDataActions
The list of actions to execute when this alarm transitions into an
INSUFFICIENT_DATA
state from any other state. Each action is
specified as an Amazon Resource Name (ARN).
UnknownActions
.java.lang.String stateValue
The state value for the alarm.
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
java.lang.String stateReason
A human-readable explanation for the alarm's state.
Constraints:
Length: 0 - 1023
java.lang.String stateReasonData
An explanation for the alarm's state in machine-readable JSON format
Constraints:
Length: 0 - 4000
java.util.Date stateUpdatedTimestamp
The time stamp of the last update to the alarm's state.
java.lang.String metricName
The name of the alarm's metric.
Constraints:
Length: 1 - 255
java.lang.String namespace
The namespace of alarm's associated metric.
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String statistic
The statistic to apply to the alarm's associated metric.
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
java.util.List<E> dimensions
The list of dimensions associated with the alarm's associated metric.
java.lang.Integer period
The period in seconds over which the statistic is applied.
Constraints:
Range: 60 -
java.lang.String unit
The unit of the alarm's associated metric.
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
The number of periods over which data is compared to the specified threshold.
Constraints:
Range: 1 -
java.lang.Double threshold
The value against which the specified statistic is compared.
java.lang.String comparisonOperator
The arithmetic operation to use when comparing the specified
Statistic
and Threshold
. The specified
Statistic
value is used as the first operand.
Constraints:
Allowed Values: GreaterThanOrEqualToThreshold,
GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
java.lang.String metricName
The name of the metric.
Constraints:
Length: 1 - 255
java.util.List<E> dimensions
A list of dimensions associated with the metric. Note, when using the Dimensions value in a query, you need to append .member.N to it (e.g., Dimensions.member.N).
java.util.Date timestamp
The time stamp used for the metric in ISO 8601 Universal Coordinated Time (UTC) format. If not specified, the default value is set to the time the metric data was received.
java.lang.Double value
The value for the metric.
Value
parameter accepts numbers of
type Double
, Amazon CloudWatch rejects values that are
either too small or too large. Values must be in the range of
8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In
addition, special values (e.g., NaN, +Infinity, -Infinity) are not
supported. StatisticSet statisticValues
A set of statistical values describing the metric.
java.lang.String unit
The unit of the metric.
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.String alarmName
The descriptive name for the alarm. This name must be unique within the user's AWS account
Constraints:
Length: 1 - 255
java.lang.String alarmDescription
The description for the alarm.
Constraints:
Length: 0 - 1024
java.lang.Boolean actionsEnabled
Indicates whether or not actions should be executed during any changes to the alarm's state.
java.util.List<E> oKActions
The list of actions to execute when this alarm transitions into an
OK
state from any other state. Each action is specified as
an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer- account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east -1:{customer-account}:action/actions/AWS_EC2.InstanceId .Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions /AWS_EC2.InstanceId.Reboot/1.0
Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
java.util.List<E> alarmActions
The list of actions to execute when this alarm transitions into an
ALARM
state from any other state. Each action is specified
as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer- account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east -1:{customer-account}:action/actions/AWS_EC2.InstanceId .Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions /AWS_EC2.InstanceId.Reboot/1.0
Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
java.util.List<E> insufficientDataActions
The list of actions to execute when this alarm transitions into an
INSUFFICIENT_DATA
state from any other state. Each action is
specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer- account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east -1:{customer-account}:action/actions/AWS_EC2.InstanceId .Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions /AWS_EC2.InstanceId.Reboot/1.0
Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
java.lang.String metricName
The name for the alarm's associated metric.
Constraints:
Length: 1 - 255
java.lang.String namespace
The namespace for the alarm's associated metric.
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String statistic
The statistic to apply to the alarm's associated metric.
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
java.util.List<E> dimensions
The dimensions for the alarm's associated metric.
java.lang.Integer period
The period in seconds over which the specified statistic is applied.
Constraints:
Range: 60 -
java.lang.String unit
The statistic's unit of measure. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately.
Note: If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, this can cause an Amazon CloudWatch alarm to get stuck in the INSUFFICIENT DATA state.
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
The number of periods over which data is compared to the specified threshold.
Constraints:
Range: 1 -
java.lang.Double threshold
The value against which the specified statistic is compared.
java.lang.String comparisonOperator
The arithmetic operation to use when comparing the specified
Statistic
and Threshold
. The specified
Statistic
value is used as the first operand.
Constraints:
Allowed Values: GreaterThanOrEqualToThreshold,
GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
java.lang.String namespace
The namespace for the metric data.
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.util.List<E> metricData
A list of data describing the metric.
java.lang.String alarmName
The descriptive name for the alarm. This name must be unique within the user's AWS account. The maximum length is 255 characters.
Constraints:
Length: 1 - 255
java.lang.String stateValue
The value of the state.
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
java.lang.String stateReason
The reason that this alarm is set to this specific state (in human-readable text format)
Constraints:
Length: 0 - 1023
java.lang.String stateReasonData
The reason that this alarm is set to this specific state (in machine-readable JSON format)
Constraints:
Length: 0 - 4000
java.lang.Double sampleCount
The number of samples used for the statistic set.
java.lang.Double sum
The sum of values for the sample set.
java.lang.Double minimum
The minimum value of the sample set.
java.lang.Double maximum
The maximum value of the sample set.
java.lang.String attributeName
A name for the attribute.
Constraints:
Length: 1 - 255
java.lang.String attributeType
The data type for the attribute, where:
S
- the attribute is of type String
N
- the attribute is of type Number
B
- the attribute is of type Binary
Constraints:
Allowed Values: S, N, B
java.lang.String s
A String data type.
java.lang.String n
A Number data type.
java.nio.ByteBuffer b
A Binary data type.
java.util.List<E> sS
A String Set data type.
java.util.List<E> nS
A Number Set data type.
java.util.List<E> bS
A Binary Set data type.
java.util.Map<K,V> m
A Map of attribute values.
java.util.List<E> l
A List of attribute values.
java.lang.Boolean nULL
A Null data type.
java.lang.Boolean bOOL
A Boolean data type.
AttributeValue value
Represents the data for an attribute. You can set one, and only one, of the elements.
Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.
java.lang.String action
Specifies how to perform the update. Valid values are PUT
(default), DELETE
, and ADD
. The behavior
depends on whether the specified primary key already exists in the table.
If an item with the specified Key is found in the table:
PUT
- Adds the specified attribute to the item. If the
attribute already exists, it is replaced by the new value.
DELETE
- If no value is specified, the attribute and its
value are removed from the item. The data type of the specified value
must match the existing value's data type.
If a set of values is specified, then those values are subtracted
from the old set. For example, if the attribute value was the set
[a,b,c]
and the DELETE action specified
[a,c]
, then the final attribute value would be
[b]
. Specifying an empty set is an error.
ADD
- If the attribute does not already exist, then the
attribute and its values are added to the item. If the attribute does
exist, then the behavior of ADD
depends on the data type of
the attribute:
If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD
to increment or decrement a number value for
an item that doesn't exist before the update, DynamoDB uses 0 as the
initial value.
In addition, if you use ADD
to update an existing item, and
intend to increment or decrement an attribute value which does not yet
exist, DynamoDB uses 0
as the initial value. For example,
suppose that the item you want to update does not yet have an attribute
named itemcount, but you decide to ADD
the number
3
to this attribute anyway, even though it currently does
not exist. DynamoDB will create the itemcount attribute, set its
initial value to 0
, and finally add 3
to it.
The result will be a new itemcount attribute in the item, with a
value of 3
.
If the existing data type is a set, and if the Value is also a
set, then the Value is added to the existing set. (This is a
set operation, not mathematical addition.) For example, if the
attribute value was the set [1,2]
, and the ADD
action specified [3]
, then the final attribute value would
be [1,2,3]
. An error occurs if an Add action is specified
for a set attribute and the attribute type specified does not match the
existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid for an existing attribute whose data type is
number or is a set. Do not use ADD
for any other data types.
If no item with the specified Key is found:
PUT
- DynamoDB creates a new item with the specified primary
key, and then adds the attribute.
DELETE
- Nothing happens; there is no attribute to delete.
ADD
- DynamoDB creates an item with the supplied primary key
and number (or set of numbers) for the attribute value. The only data
types allowed are number and number set; no other data types can be
specified.
Constraints:
Allowed Values: ADD, PUT, DELETE
java.util.Map<K,V> requestItems
A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per BatchGetItem request.
Each element in the map of items to retrieve consists of the following:
ConsistentRead - If true
, a strongly consistent read
is used; if false
(the default), an eventually consistent
read is used.
ExpressionAttributeNames - One or more substitution tokens for attribute names in the ProjectionExpression parameter. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Keys - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide both the partition key value and the sort key value.
ProjectionExpression - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
AttributesToGet -
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
java.lang.String returnConsumedCapacity
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
java.util.Map<K,V> responses
A map of table name to a list of items. Each object in Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.
java.util.Map<K,V> unprocessedKeys
A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.
Each element consists of:
Keys - An array of primary key attribute values that define specific items in the table.
AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested 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.
java.util.List<E> consumedCapacity
The read capacity units consumed by the operation.
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
java.util.Map<K,V> requestItems
A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:
DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:
Key - A map of primary key attribute values that uniquely identify the ! item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
java.lang.String returnConsumedCapacity
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
java.lang.String returnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item
collections, if any, that were modified during the operation are returned
in the response. If set to NONE
(the default), no statistics
are returned.
Constraints:
Allowed Values: SIZE, NONE
java.util.Map<K,V> unprocessedItems
A map of tables and requests against those tables that were not processed. The UnprocessedItems value is in the same form as RequestItems, so you can provide this value directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.
Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to perform (DeleteRequest or PutRequest).
DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:
Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.
java.util.Map<K,V> itemCollectionMetrics
A list of tables that were processed by BatchWriteItem and, for each table, information about any item collections that were affected by individual DeleteItem or PutItem operations.
Each entry consists of the following subelements:
ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value 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.
java.util.List<E> consumedCapacity
The capacity units consumed by the operation.
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
java.lang.Double capacityUnits
The total number of capacity units consumed on a table or an index.
java.util.List<E> 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 a
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.
java.lang.String 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
The following are descriptions of each comparison operator.
EQ
: Equal. EQ
is supported for all datatypes,
including lists and maps.
AttributeValueList can contain only one AttributeValue
element of type String, Number, Binary, String Set, Number Set, or Binary
Set. If an item contains an AttributeValue element of a different
type than the one provided in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not equal
{"NS":["6", "2", "1"]}
.
NE
: Not equal. NE
is supported for all
datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of
type String, Number, Binary, String Set, Number Set, or Binary Set. If an
item contains an AttributeValue of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2", "1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one AttributeValue of
type String, Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one provided
in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GE
: Greater than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
NOT_NULL
: The attribute exists. NOT_NULL
is
supported for all datatypes, including lists and maps.
This operator tests for the existence of an attribute, not its data type.
If the data type of attribute "a
" is null, and you evaluate
it using NOT_NULL
, the result is a Boolean true. This
result is because the attribute "a
" exists; its data type is
not relevant to the NOT_NULL
comparison operator.
NULL
: The attribute does not exist. NULL
is
supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data
type. If the data type of attribute "a
" is null, and you
evaluate it using NULL
, the result is a Boolean
false. This is because the attribute "a
" exists; its
data type is not relevant to the NULL
comparison operator.
CONTAINS
: Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is of type String, then the operator checks
for a substring match. If the target attribute of the comparison is of
type Binary, then the operator looks for a subsequence of the target that
matches the input. If the target attribute of the comparison is a set ("
SS
", "NS
", or "BS
"), then the
operator evaluates to true if it finds an exact match with any member of
the set.
CONTAINS is supported for lists: When evaluating "
a CONTAINS b
", "a
" can be a list; however, "
b
" cannot be a set, a map, or a list.
NOT_CONTAINS
: Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is a String, then the operator checks for the
absence of a substring match. If the target attribute of the comparison
is Binary, then the operator checks for the absence of a subsequence of
the target that matches the input. If the target attribute of the
comparison is a set ("SS
", "NS
", or "
BS
"), then the operator evaluates to true if it does
not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating "
a NOT CONTAINS b
", "a
" can be a list; however, "b
" cannot be a set, a map, or a
list.
BEGINS_WITH
: Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN
: Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN
: Greater than or equal to the first value, and less
than or equal to the second value.
AttributeValueList must contain two AttributeValue elements
of the same type, either String, Number, or Binary (not a set type). A
target attribute matches if the target value is greater than, or equal
to, the first element and less than, or equal to, the second element. If
an item contains an AttributeValue element of a different type
than the one provided in the request, the value does not match. For
example, {"S":"6"}
does not compare to
{"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
Constraints:
Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL,
NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH
java.lang.String tableName
The name of the table that was affected by the operation.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.lang.Double capacityUnits
The total number of capacity units consumed by the operation.
Capacity table
The amount of throughput consumed on the table affected by the operation.
java.util.Map<K,V> localSecondaryIndexes
The amount of throughput consumed on each local index affected by the operation.
java.util.Map<K,V> globalSecondaryIndexes
The amount of throughput consumed on each global index affected by the operation.
java.lang.String indexName
The name of the global secondary index to be created.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.List<E> keySchema
The key schema for the global secondary index.
Projection projection
Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProvisionedThroughput provisionedThroughput
Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
java.util.List<E> attributeDefinitions
An array of attributes that describe the key schema for the table and indexes.
java.lang.String tableName
The name of the table to create.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.List<E> keySchema
Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.
Each KeySchemaElement in the array is composed of:
AttributeName - The name of this key attribute.
KeyType - The role that the key attribute will assume:
HASH
- partition key
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For a simple primary key (partition key), you must provide exactly one
element with a KeyType of HASH
.
For a composite primary key (partition key and sort key), you must
provide 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.
java.util.List<E> localSecondaryIndexes
One or more local secondary indexes (the maximum is five) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.
Each local secondary index in the array includes the following:
IndexName - The name of the local secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key 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 provided 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.
java.util.List<E> globalSecondaryIndexes
One or more global secondary indexes (the maximum is five) to be created on the table. Each global secondary index in the array includes the following:
IndexName - The name of the global secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the global secondary index.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY
- Only the index and primary keys are projected
into the index.
INCLUDE
- Only the specified table attributes are projected
into the index. The list of projected attributes are in
NonKeyAttributes.
ALL
- All of the table attributes are projected into the
index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided 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
Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
StreamSpecification streamSpecification
The settings for DynamoDB Streams on the table. These settings consist of:
StreamEnabled - Indicates whether Streams is to be enabled (true) or disabled (false).
StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values for StreamViewType are:
KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
TableDescription tableDescription
Represents the properties of a table.
java.lang.String indexName
The name of the global secondary index to be deleted.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.lang.String tableName
The name of the table from which to delete the item.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.Map<K,V> key
A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
java.util.Map<K,V> expected
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the DeleteItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based
on ASCII character code values. For example, a
is greater
than A
, and a
is greater than B
.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ
: Equal. EQ
is supported for all datatypes,
including lists and maps.
AttributeValueList can contain only one AttributeValue
element of type String, Number, Binary, String Set, Number Set, or Binary
Set. If an item contains an AttributeValue element of a different
type than the one provided in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not equal
{"NS":["6", "2", "1"]}
.
NE
: Not equal. NE
is supported for all
datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of
type String, Number, Binary, String Set, Number Set, or Binary Set. If an
item contains an AttributeValue of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2", "1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one AttributeValue of
type String, Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one provided
in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GE
: Greater than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
NOT_NULL
: The attribute exists. NOT_NULL
is
supported for all datatypes, including lists and maps.
This operator tests for the existence of an attribute, not its data type.
If the data type of attribute "a
" is null, and you evaluate
it using NOT_NULL
, the result is a Boolean true. This
result is because the attribute "a
" exists; its data type is
not relevant to the NOT_NULL
comparison operator.
NULL
: The attribute does not exist. NULL
is
supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data
type. If the data type of attribute "a
" is null, and you
evaluate it using NULL
, the result is a Boolean
false. This is because the attribute "a
" exists; its
data type is not relevant to the NULL
comparison operator.
CONTAINS
: Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is of type String, then the operator checks
for a substring match. If the target attribute of the comparison is of
type Binary, then the operator looks for a subsequence of the target that
matches the input. If the target attribute of the comparison is a set ("
SS
", "NS
", or "BS
"), then the
operator evaluates to true if it finds an exact match with any member of
the set.
CONTAINS is supported for lists: When evaluating "
a CONTAINS b
", "a
" can be a list; however, "
b
" cannot be a set, a map, or a list.
NOT_CONTAINS
: Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is a String, then the operator checks for the
absence of a substring match. If the target attribute of the comparison
is Binary, then the operator checks for the absence of a subsequence of
the target that matches the input. If the target attribute of the
comparison is a set ("SS
", "NS
", or "
BS
"), then the operator evaluates to true if it does
not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating "
a NOT CONTAINS b
", "a
" can be a list; however, "b
" cannot be a set, a map, or a
list.
BEGINS_WITH
: Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN
: Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN
: Greater than or equal to the first value, and less
than or equal to the second value.
AttributeValueList must contain two AttributeValue elements
of the same type, either String, Number, or Binary (not a set type). A
target attribute matches if the target value is greater than, or equal
to, the first element and less than, or equal to, the second element. If
an item contains an AttributeValue element of a different type
than the one provided in the request, the value does not match. For
example, {"S":"6"}
does not compare to
{"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true
, DynamoDB will check to see if that
attribute value already exists in the table. If it is found, then the
condition evaluates to true; otherwise the condition evaluate to false.
If Exists is false
, DynamoDB assumes that the
attribute value does not exist in the table. If in fact the value
does not exist, then the assumption is valid and the condition evaluates
to true. If the value is found, despite the assumption that it does not
exist, the condition evaluates to false.
Note that the default value for Exists is true
.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
java.lang.String conditionalOperator
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND
- If all of the conditions evaluate to true, then the
entire map evaluates to true.
OR
- If at least one of the conditions evaluate to true,
then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is the
default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
Constraints:
Allowed Values: AND, OR
java.lang.String returnValues
Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:
NONE
- If ReturnValues is not specified, or if its
value is NONE
, then nothing is returned. (This setting is
the default for ReturnValues.)
ALL_OLD
- The content of the old item is returned.
The ReturnValues parameter is used by several DynamoDB operations;
however, DeleteItem does not recognize any values other than
NONE
or ALL_OLD
.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
java.lang.String returnConsumedCapacity
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
java.lang.String returnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item
collections, if any, that were modified during the operation are returned
in the response. If set to NONE
(the default), no statistics
are returned.
Constraints:
Allowed Values: SIZE, NONE
java.lang.String conditionExpression
A condition that must be satisfied in order for a conditional DeleteItem to succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
java.util.Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
java.util.Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
java.util.Map<K,V> attributes
A map of attribute names to AttributeValue objects, representing
the item as it appeared before the DeleteItem operation. This map
appears in the response only if ReturnValues was specified as
ALL_OLD
in the request.
ConsumedCapacity consumedCapacity
The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
ItemCollectionMetrics itemCollectionMetrics
Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.
Each ItemCollectionMetrics element consists of:
ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.
SizeEstimateRange - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
java.util.Map<K,V> key
A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.
java.lang.String tableName
The name of the table to delete.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
TableDescription tableDescription
Represents the properties of a table.
java.lang.Long accountMaxReadCapacityUnits
The maximum total read capacity units that your account allows you to provision across all of your tables in this region.
Constraints:
Range: 1 -
java.lang.Long accountMaxWriteCapacityUnits
The maximum total write capacity units that your account allows you to provision across all of your tables in this region.
Constraints:
Range: 1 -
java.lang.Long tableMaxReadCapacityUnits
The maximum read capacity units that your account allows you to provision for a new table that you are creating in this region, including the read capacity units provisioned for its global secondary indexes (GSIs).
Constraints:
Range: 1 -
java.lang.Long tableMaxWriteCapacityUnits
The maximum write capacity units that your account allows you to provision for a new table that you are creating in this region, including the write capacity units provisioned for its global secondary indexes (GSIs).
Constraints:
Range: 1 -
java.lang.String tableName
The name of the table to describe.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
TableDescription table
Represents the properties of a table.
AttributeValue value
Represents the data for an attribute. You can set one, and only one, of the elements.
Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.
java.lang.Boolean exists
Causes DynamoDB to evaluate the value before attempting a conditional operation:
If Exists is true
, DynamoDB will check to see if that
attribute value already exists in the table. If it is found, then the
operation succeeds. If it is not found, the operation fails with a
ConditionalCheckFailedException.
If Exists is false
, DynamoDB assumes that the
attribute value does not exist in the table. If in fact the value does
not exist, then the assumption is valid and the operation succeeds. If
the value is found, despite the assumption that it does not exist, the
operation fails with a ConditionalCheckFailedException.
The default setting for Exists is true
. If you supply
a Value all by itself, DynamoDB assumes the attribute exists: You
don't have to set Exists to true
, because it is
implied.
DynamoDB returns a ValidationException if:
Exists is true
but there is no Value to check.
(You expect a value to exist, but don't specify what that value is.)
Exists is false
but you also provide a Value.
(You cannot expect an attribute to have a value, while also expecting it
not to exist.)
java.lang.String comparisonOperator
A comparator for evaluating attributes in the AttributeValueList. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ
: Equal. EQ
is supported for all datatypes,
including lists and maps.
AttributeValueList can contain only one AttributeValue
element of type String, Number, Binary, String Set, Number Set, or Binary
Set. If an item contains an AttributeValue element of a different
type than the one provided in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not equal
{"NS":["6", "2", "1"]}
.
NE
: Not equal. NE
is supported for all
datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of
type String, Number, Binary, String Set, Number Set, or Binary Set. If an
item contains an AttributeValue of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2", "1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one AttributeValue of
type String, Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one provided
in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GE
: Greater than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
NOT_NULL
: The attribute exists. NOT_NULL
is
supported for all datatypes, including lists and maps.
This operator tests for the existence of an attribute, not its data type.
If the data type of attribute "a
" is null, and you evaluate
it using NOT_NULL
, the result is a Boolean true. This
result is because the attribute "a
" exists; its data type is
not relevant to the NOT_NULL
comparison operator.
NULL
: The attribute does not exist. NULL
is
supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data
type. If the data type of attribute "a
" is null, and you
evaluate it using NULL
, the result is a Boolean
false. This is because the attribute "a
" exists; its
data type is not relevant to the NULL
comparison operator.
CONTAINS
: Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is of type String, then the operator checks
for a substring match. If the target attribute of the comparison is of
type Binary, then the operator looks for a subsequence of the target that
matches the input. If the target attribute of the comparison is a set ("
SS
", "NS
", or "BS
"), then the
operator evaluates to true if it finds an exact match with any member of
the set.
CONTAINS is supported for lists: When evaluating "
a CONTAINS b
", "a
" can be a list; however, "
b
" cannot be a set, a map, or a list.
NOT_CONTAINS
: Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is a String, then the operator checks for the
absence of a substring match. If the target attribute of the comparison
is Binary, then the operator checks for the absence of a subsequence of
the target that matches the input. If the target attribute of the
comparison is a set ("SS
", "NS
", or "
BS
"), then the operator evaluates to true if it does
not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating "
a NOT CONTAINS b
", "a
" can be a list; however, "b
" cannot be a set, a map, or a
list.
BEGINS_WITH
: Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN
: Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN
: Greater than or equal to the first value, and less
than or equal to the second value.
AttributeValueList must contain two AttributeValue elements
of the same type, either String, Number, or Binary (not a set type). A
target attribute matches if the target value is greater than, or equal
to, the first element and less than, or equal to, the second element. If
an item contains an AttributeValue element of a different type
than the one provided 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
java.util.List<E> 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 a
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 information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
java.lang.String tableName
The name of the table containing the requested item.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.Map<K,V> key
A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
java.util.List<E> attributesToGet
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
java.lang.Boolean consistentRead
Determines the read consistency model: If set to true
, then
the operation uses strongly consistent reads; otherwise, the operation
uses eventually consistent reads.
java.lang.String returnConsumedCapacity
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
java.lang.String projectionExpression
A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
java.util.Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
java.util.Map<K,V> item
A map of attribute names to AttributeValue objects, as specified by AttributesToGet.
ConsumedCapacity consumedCapacity
The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
java.lang.String indexName
The name of the global secondary index. The name must be unique among all other indexes on this table.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.List<E> keySchema
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH
- partition key
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
Projection projection
Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProvisionedThroughput provisionedThroughput
Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
java.lang.String indexName
The name of the global secondary index.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.List<E> keySchema
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH
- partition key
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
Projection projection
Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
java.lang.String indexStatus
The current state 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.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
java.lang.Boolean backfilling
Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.
For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
ProvisionedThroughputDescription provisionedThroughput
Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
java.lang.Long indexSizeBytes
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
java.lang.Long itemCount
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
java.lang.String indexArn
The Amazon Resource Name (ARN) that uniquely identifies the index.
UpdateGlobalSecondaryIndexAction update
The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.
CreateGlobalSecondaryIndexAction create
The parameters required for creating a global secondary index on an existing table:
IndexName
KeySchema
AttributeDefinitions
Projection
ProvisionedThroughput
DeleteGlobalSecondaryIndexAction delete
The name of an existing global secondary index to be removed.
java.util.Map<K,V> itemCollectionKey
The partition key value of the item collection. This value is the same as the partition key value of the item.
java.util.List<E> sizeEstimateRangeGB
An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
java.util.List<E> keys
The primary key attribute values that define the items and the attributes associated with the items.
java.util.List<E> attributesToGet
One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.
java.lang.Boolean 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.
java.lang.String projectionExpression
A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
java.util.Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
java.lang.String attributeName
The name of a key attribute.
Constraints:
Length: 1 - 255
java.lang.String keyType
The role that this key attribute will assume:
HASH
- partition key
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
Constraints:
Allowed Values: HASH, RANGE
java.lang.String exclusiveStartTableName
The first table name that this operation will evaluate. Use the value that was returned for LastEvaluatedTableName in a previous operation, so that you can obtain the next page of results.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.lang.Integer limit
A maximum number of table names to return. If this parameter is not specified, the limit is 100.
Constraints:
Range: 1 - 100
java.util.List<E> tableNames
The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100.
If LastEvaluatedTableName also appears in the output, you can use this value as the ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the next page of results.
java.lang.String lastEvaluatedTableName
The name of the last table in the current page of results. Use this value as the ExclusiveStartTableName in a new request to obtain the next page of results, until all the table names are returned.
If you do not receive a LastEvaluatedTableName value in the response, this means that there are no more table names to be retrieved.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.lang.String indexName
The name of the local secondary index. The name must be unique among all other indexes on this table.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.List<E> keySchema
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
HASH
- partition key
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
Projection projection
Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
java.lang.String indexName
Represents the name of the local secondary index.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.List<E> keySchema
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
HASH
- partition key
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
Projection projection
Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
java.lang.Long indexSizeBytes
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
java.lang.Long itemCount
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
java.lang.String indexArn
The Amazon Resource Name (ARN) that uniquely identifies the index.
java.lang.String projectionType
The set of attributes that are projected into the index:
KEYS_ONLY
- Only the index and primary keys are projected
into the index.
INCLUDE
- Only the specified table attributes are projected
into the index. The list of projected attributes are in
NonKeyAttributes.
ALL
- All of the table attributes are projected into the
index.
Constraints:
Allowed Values: ALL, KEYS_ONLY, INCLUDE
java.util.List<E> nonKeyAttributes
Represents the non-key attribute names which will be projected into the index.
For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
java.lang.Long readCapacityUnits
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
Constraints:
Range: 1 -
java.lang.Long writeCapacityUnits
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
Constraints:
Range: 1 -
java.util.Date lastIncreaseDateTime
The date and time of the last provisioned throughput increase for this table.
java.util.Date lastDecreaseDateTime
The date and time of the last provisioned throughput decrease for this table.
java.lang.Long numberOfDecreasesToday
The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.
Constraints:
Range: 1 -
java.lang.Long readCapacityUnits
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
Constraints:
Range: 1 -
java.lang.Long writeCapacityUnits
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
Constraints:
Range: 1 -
java.lang.String tableName
The name of the table to contain the item.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.Map<K,V> item
A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.
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
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the PutItem operation.
This parameter does not support attributes of type List or Map.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based
on ASCII character code values. For example, a
is greater
than A
, and a
is greater than B
.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ
: Equal. EQ
is supported for all datatypes,
including lists and maps.
AttributeValueList can contain only one AttributeValue
element of type String, Number, Binary, String Set, Number Set, or Binary
Set. If an item contains an AttributeValue element of a different
type than the one provided in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not equal
{"NS":["6", "2", "1"]}
.
NE
: Not equal. NE
is supported for all
datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of
type String, Number, Binary, String Set, Number Set, or Binary Set. If an
item contains an AttributeValue of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2", "1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one AttributeValue of
type String, Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one provided
in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GE
: Greater than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
NOT_NULL
: The attribute exists. NOT_NULL
is
supported for all datatypes, including lists and maps.
This operator tests for the existence of an attribute, not its data type.
If the data type of attribute "a
" is null, and you evaluate
it using NOT_NULL
, the result is a Boolean true. This
result is because the attribute "a
" exists; its data type is
not relevant to the NOT_NULL
comparison operator.
NULL
: The attribute does not exist. NULL
is
supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data
type. If the data type of attribute "a
" is null, and you
evaluate it using NULL
, the result is a Boolean
false. This is because the attribute "a
" exists; its
data type is not relevant to the NULL
comparison operator.
CONTAINS
: Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is of type String, then the operator checks
for a substring match. If the target attribute of the comparison is of
type Binary, then the operator looks for a subsequence of the target that
matches the input. If the target attribute of the comparison is a set ("
SS
", "NS
", or "BS
"), then the
operator evaluates to true if it finds an exact match with any member of
the set.
CONTAINS is supported for lists: When evaluating "
a CONTAINS b
", "a
" can be a list; however, "
b
" cannot be a set, a map, or a list.
NOT_CONTAINS
: Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is a String, then the operator checks for the
absence of a substring match. If the target attribute of the comparison
is Binary, then the operator checks for the absence of a subsequence of
the target that matches the input. If the target attribute of the
comparison is a set ("SS
", "NS
", or "
BS
"), then the operator evaluates to true if it does
not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating "
a NOT CONTAINS b
", "a
" can be a list; however, "b
" cannot be a set, a map, or a
list.
BEGINS_WITH
: Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN
: Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN
: Greater than or equal to the first value, and less
than or equal to the second value.
AttributeValueList must contain two AttributeValue elements
of the same type, either String, Number, or Binary (not a set type). A
target attribute matches if the target value is greater than, or equal
to, the first element and less than, or equal to, the second element. If
an item contains an AttributeValue element of a different type
than the one provided in the request, the value does not match. For
example, {"S":"6"}
does not compare to
{"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true
, DynamoDB will check to see if that
attribute value already exists in the table. If it is found, then the
condition evaluates to true; otherwise the condition evaluate to false.
If Exists is false
, DynamoDB assumes that the
attribute value does not exist in the table. If in fact the value
does not exist, then the assumption is valid and the condition evaluates
to true. If the value is found, despite the assumption that it does not
exist, the condition evaluates to false.
Note that the default value for Exists is true
.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
java.lang.String returnValues
Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are:
NONE
- If ReturnValues is not specified, or if its
value is NONE
, then nothing is returned. (This setting is
the default for ReturnValues.)
ALL_OLD
- If PutItem overwrote an attribute
name-value pair, then the content of the old item is returned.
The ReturnValues parameter is used by several DynamoDB operations;
however, PutItem does not recognize any values other than
NONE
or ALL_OLD
.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
java.lang.String returnConsumedCapacity
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
java.lang.String returnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item
collections, if any, that were modified during the operation are returned
in the response. If set to NONE
(the default), no statistics
are returned.
Constraints:
Allowed Values: SIZE, NONE
java.lang.String conditionalOperator
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND
- If all of the conditions evaluate to true, then the
entire map evaluates to true.
OR
- If at least one of the conditions evaluate to true,
then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is the
default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
Constraints:
Allowed Values: AND, OR
java.lang.String conditionExpression
A condition that must be satisfied in order for a conditional PutItem operation to succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
java.util.Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
java.util.Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
java.util.Map<K,V> attributes
The attribute values as they appeared before the PutItem
operation, but only if ReturnValues is specified as
ALL_OLD
in the request. Each element consists of an
attribute name and an attribute value.
ConsumedCapacity consumedCapacity
The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
ItemCollectionMetrics itemCollectionMetrics
Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.
Each ItemCollectionMetrics element consists of:
ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.
SizeEstimateRange - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
java.util.Map<K,V> item
A map of attribute name to attribute values, representing the primary key of an item to be processed by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item which are part of an index key schema for the table, their types must match the index key schema.
java.lang.String tableName
The name of the table containing the requested items.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.lang.String indexName
The name of an index to query. This index can be any local secondary index or global secondary index on the table. Note that if you use the IndexName parameter, you must also provide TableName.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.lang.String select
The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
ALL_ATTRIBUTES
- Returns all of the item attributes from the
specified table or index. If you query a local secondary index, then for
each matching item in the index DynamoDB will fetch the entire item from
the parent table. If the index is configured to project all item
attributes, then all of the data can be obtained from the local secondary
index, and no fetching is required.
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an
index. Retrieves all attributes that have been projected into the index.
If the index is configured to project all attributes, this return value
is equivalent to specifying ALL_ATTRIBUTES
.
COUNT
- Returns the number of matching items, rather than
the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in
AttributesToGet. This return value is equivalent to specifying
AttributesToGet without specifying any value for Select.
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither Select nor AttributesToGet are specified,
DynamoDB defaults to ALL_ATTRIBUTES
when accessing a table,
and ALL_PROJECTED_ATTRIBUTES
when accessing an index. You
cannot use both Select and AttributesToGet together in a
single request, unless the value for Select is
SPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying
AttributesToGet without any value for Select.)
If you use the ProjectionExpression parameter, then the value for
Select can only be SPECIFIC_ATTRIBUTES
. Any other
value for Select will return an error.
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES,
SPECIFIC_ATTRIBUTES, COUNT
java.util.List<E> attributesToGet
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both AttributesToGet and Select together in
a Query request, unless the value for Select is
SPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying
AttributesToGet without any value for Select.)
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
java.lang.Integer limit
The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.
Constraints:
Range: 1 -
java.lang.Boolean consistentRead
Determines the read consistency model: If set to true
, then
the operation uses strongly consistent reads; otherwise, the operation
uses eventually consistent reads.
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 a ValidationException.
java.util.Map<K,V> keyConditions
This is a legacy parameter, for backward compatibility. New applications should use KeyConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
The selection criteria for the query. For a query on a table, you can
have conditions only on the table primary key attributes. You must
provide the partition key name and value as an EQ
condition.
You can optionally provide a second condition, referring to the sort key.
If you don't provide a sort key condition, all of the items that match the partition key will be retrieved. If a FilterExpression or QueryFilter is present, it will be applied after the items are retrieved.
For a query on an index, you can have conditions only on the index key
attributes. You must provide the index partition key name and value as an
EQ
condition. You can optionally provide a second condition,
referring to the index sort key.
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 a
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.
ComparisonOperator - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on.
For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
The following are descriptions of these comparison operators.
EQ
: Equal.
AttributeValueList can contain only one AttributeValue of
type String, Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one specified
in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2", "1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one AttributeValue of
type String, Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one provided
in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GE
: Greater than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
BEGINS_WITH
: Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
BETWEEN
: Greater than or equal to the first value, and less
than or equal to the second value.
AttributeValueList must contain two AttributeValue elements
of the same type, either String, Number, or Binary (not a set type). A
target attribute matches if the target value is greater than, or equal
to, the first element and less than, or equal to, the second element. If
an item contains an AttributeValue element of a different type
than the one provided in the request, the value does not match. For
example, {"S":"6"}
does not compare to
{"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
java.util.Map<K,V> queryFilter
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A condition that evaluates the query results after the items are read and returns only the desired values.
This parameter does not support attributes of type List or Map.
A QueryFilter is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
If you provide 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.)
Note that QueryFilter does not allow key attributes. You cannot define a filter condition on a partition key or a sort key.
Each QueryFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based
on ASCII character code values. For example, a
is greater
than A
, and a
is greater than B
.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For 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 the Condition data type.
java.lang.String conditionalOperator
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a QueryFilter map:
AND
- If all of the conditions evaluate to true, then the
entire map evaluates to true.
OR
- If at least one of the conditions evaluate to true,
then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is the
default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
Constraints:
Allowed Values: AND, OR
java.lang.Boolean scanIndexForward
Specifies the order for index traversal: If true
(default),
the traversal is performed in ascending order; if false
, the
traversal is performed in descending order.
Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of ASCII character code values. For type Binary, DynamoDB treats each byte of the binary data as unsigned.
If ScanIndexForward is true
, DynamoDB returns the
results in the order in which they are stored (by sort key value). This
is the default behavior. If ScanIndexForward is false
, DynamoDB reads the results in reverse order by sort key value, and then
returns the results to the client.
java.util.Map<K,V> exclusiveStartKey
The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
java.lang.String returnConsumedCapacity
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
java.lang.String projectionExpression
A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
java.lang.String filterExpression
A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.
A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
FilterExpression replaces the legacy QueryFilter and ConditionalOperator parameters.
java.lang.String keyConditionExpression
The condition that specifies the key value(s) for items to be retrieved by the Query action.
The condition must perform an equality test on a single partition key value. The condition can also perform one of several comparison tests on a single sort key value. Query can use KeyConditionExpression to retrieve one item with a given partition key value and sort key value, or several items that have the same partition key value but different sort key values.
The partition key equality test is required, and must be specified in the following format:
partitionKeyName
= :partitionkeyval
If you also want to provide a condition for the sort key, it must be combined using AND with the condition for the sort key. Following is an example, using the = comparison operator for the sort key:
partitionKeyName
= :partitionkeyval
AND sortKeyName
= :sortkeyval
Valid comparisons for the sort key condition are as follows:
sortKeyName
= :sortkeyval
- true if the
sort key value is equal to :sortkeyval
.
sortKeyName
< :sortkeyval
- true if
the sort key value is less than :sortkeyval
.
sortKeyName
<= :sortkeyval
- true if
the sort key value is less than or equal to :sortkeyval
.
sortKeyName
> :sortkeyval
- true if
the sort key value is greater than :sortkeyval
.
sortKeyName
>= :sortkeyval
- true if
the sort key value is greater than or equal to :sortkeyval
.
sortKeyName
BETWEEN :sortkeyval1
AND :sortkeyval2
- true if the sort key value is
greater than or equal to :sortkeyval1
, and less than or
equal to :sortkeyval2
.
begins_with ( sortKeyName
, :sortkeyval
) - true if the sort key value begins with a particular operand.
(You cannot use this function with a sort key that is of type Number.)
Note that the function name begins_with
is case-sensitive.
Use the ExpressionAttributeValues parameter to replace tokens such
as :partitionval
and :sortval
with actual
values at runtime.
You can optionally use the ExpressionAttributeNames parameter to replace the names of the partition key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following KeyConditionExpression parameter causes an error because Size is a reserved word:
Size = :myval
To work around this, define a placeholder (such a #S
) to
represent the attribute name Size. KeyConditionExpression
then is as follows:
#S = :myval
For a list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.
For more information on ExpressionAttributeNames and ExpressionAttributeValues, see Using Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.
KeyConditionExpression replaces the legacy KeyConditions parameter.
java.util.Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
java.util.Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
java.util.List<E> items
An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.
java.lang.Integer count
The number of items in the response.
If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.
If you did not use a filter in the request, then Count and ScannedCount are the same.
java.lang.Integer scannedCount
The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount is the same as Count.
java.util.Map<K,V> lastEvaluatedKey
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.
If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.
ConsumedCapacity consumedCapacity
The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
java.lang.String tableName
The name of the table containing the requested items; or, if you provide
IndexName
, the name of the table to which that index
belongs.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.lang.String indexName
The name of a secondary index to scan. This index can be any local
secondary index or global secondary index. Note that if you use the
IndexName
parameter, you must also provide
TableName
.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.List<E> attributesToGet
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
java.lang.Integer limit
The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.
Constraints:
Range: 1 -
java.lang.String select
The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, or the count of matching items.
ALL_ATTRIBUTES
- Returns all of the item attributes.
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an
index. Retrieves all attributes that have been projected into the index.
If the index is configured to project all attributes, this return value
is equivalent to specifying ALL_ATTRIBUTES
.
COUNT
- Returns the number of matching items, rather than
the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in
AttributesToGet. This return value is equivalent to specifying
AttributesToGet without specifying any value for Select.
If neither Select nor AttributesToGet are specified,
DynamoDB defaults to ALL_ATTRIBUTES
. You cannot use both
AttributesToGet and Select together in a single request,
unless the value for Select is SPECIFIC_ATTRIBUTES
.
(This usage is equivalent to specifying AttributesToGet without
any value for Select.)
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES,
SPECIFIC_ATTRIBUTES, COUNT
java.util.Map<K,V> scanFilter
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A condition that evaluates the scan results and returns only the desired values.
This parameter does not support attributes of type List or Map.
If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each ScanFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator .
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based
on ASCII character code values. For example, a
is greater
than A
, and a
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 information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For complete descriptions of all comparison operators, see Condition.
java.lang.String conditionalOperator
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a ScanFilter map:
AND
- If all of the conditions evaluate to true, then the
entire map evaluates to true.
OR
- If at least one of the conditions evaluate to true,
then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is the
default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
Constraints:
Allowed Values: AND, OR
java.util.Map<K,V> exclusiveStartKey
The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
java.lang.String returnConsumedCapacity
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
java.lang.Integer totalSegments
For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4.
The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
Constraints:
Range: 1 - 1000000
java.lang.Integer segment
For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.
Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
If you provide Segment, you must also provide TotalSegments.
Constraints:
Range: 0 - 999999
java.lang.String projectionExpression
A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
java.lang.String filterExpression
A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.
A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
FilterExpression replaces the legacy ScanFilter and ConditionalOperator parameters.
java.util.Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
java.util.Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
java.lang.Boolean consistentRead
A Boolean value that determines the read consistency model during the scan:
If ConsistentRead is false
, then the data returned
from Scan might not contain the results from other recently
completed write operations (PutItem, UpdateItem or DeleteItem).
If ConsistentRead is true
, then all of the write
operations that completed before the Scan began are guaranteed to
be contained in the Scan response.
The default setting for ConsistentRead is false
.
The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.
java.util.List<E> items
An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.
java.lang.Integer count
The number of items in the response.
If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.
If you did not use a filter in the request, then Count is the same as ScannedCount.
java.lang.Integer scannedCount
The number of items evaluated, before any ScanFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount is the same as Count.
java.util.Map<K,V> lastEvaluatedKey
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.
If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.
ConsumedCapacity consumedCapacity
The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
java.lang.Boolean streamEnabled
Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
java.lang.String streamViewType
The DynamoDB Streams settings for the table. These settings consist of:
StreamEnabled - Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:
KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
Constraints:
Allowed Values: NEW_IMAGE, OLD_IMAGE, NEW_AND_OLD_IMAGES,
KEYS_ONLY
java.util.List<E> attributeDefinitions
An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.
Each AttributeDefinition object in this array is composed of:
AttributeName - The name of the attribute.
AttributeType - The data type for the attribute.
java.lang.String tableName
The name of the table.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.List<E> keySchema
The primary key structure for the table. Each KeySchemaElement consists of:
AttributeName - The name of the attribute.
KeyType - The role of the attribute:
HASH
- partition key
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
java.lang.String tableStatus
The current state of the table:
CREATING - The table is being created.
UPDATING - The table is being updated.
DELETING - The table is being deleted.
ACTIVE - The table is ready for use.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
java.util.Date creationDateTime
The date and time when the table was created, in UNIX epoch time format.
ProvisionedThroughputDescription provisionedThroughput
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
java.lang.Long tableSizeBytes
The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
java.lang.Long itemCount
The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
java.lang.String tableArn
The Amazon Resource Name (ARN) that uniquely identifies the table.
java.util.List<E> localSecondaryIndexes
Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
IndexName - The name of the local secondary index.
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key 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 provided 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.
java.util.List<E> globalSecondaryIndexes
The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:
Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)
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 partition key 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 provided 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.
StreamSpecification streamSpecification
The current DynamoDB Streams configuration for the table.
java.lang.String latestStreamLabel
A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:
the AWS customer ID.
the table name.
the StreamLabel.
java.lang.String latestStreamArn
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
Constraints:
Length: 37 - 1024
java.lang.String indexName
The name of the global secondary index to be updated.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
ProvisionedThroughput provisionedThroughput
Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
java.lang.String tableName
The name of the table containing the item to update.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.Map<K,V> key
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
java.util.Map<K,V> attributeUpdates
This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements.
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.
Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.
Each AttributeUpdates element consists of an attribute name to modify, along with the following:
Value - The new value, if applicable, for this attribute.
Action - A value that specifies how to perform the update. This
action is only valid for an existing attribute whose data type is Number
or is a set; do not use ADD
for other data types.
If an item with the specified primary key is found in the table, the following values perform the following actions:
PUT
- Adds the specified attribute to the item. If the
attribute already exists, it is replaced by the new value.
DELETE
- Removes the attribute and its value, if no value is
specified for DELETE
. The data type of the specified value
must match the existing value's data type.
If a set of values is specified, then those values are subtracted from
the old set. For example, if the attribute value was the set
[a,b,c]
and the DELETE
action specifies
[a,c]
, then the final attribute value is [b]
.
Specifying an empty set is an error.
ADD
- Adds the specified value to the item, if the attribute
does not already exist. If the attribute does exist, then the behavior of
ADD
depends on the data type of the attribute:
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD
to increment or decrement a number value for
an item that doesn't exist before the update, DynamoDB uses 0 as the
initial value.
Similarly, if you use ADD
for an existing item to increment
or decrement an attribute value that doesn't exist before the update,
DynamoDB uses 0
as the initial value. For example, suppose
that the item you want to update doesn't have an attribute named
itemcount, but you decide to ADD
the number
3
to this attribute anyway. DynamoDB will create the
itemcount attribute, set its initial value to 0
, and
finally add 3
to it. The result will be a new
itemcount attribute, with a value of 3
.
If the existing data type is a set, and if Value is also a set,
then Value is appended to the existing set. For example, if the
attribute value is the set [1,2]
, and the ADD
action specified [3]
, then the final attribute value is
[1,2,3]
. An error occurs if an ADD
action is
specified for a set attribute and the attribute type specified does not
match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, Value must also be a set of strings.
If no item with the specified key is found in the table, the following values perform the following actions:
PUT
- Causes DynamoDB to create a new item with the
specified primary key, and then adds the attribute.
DELETE
- Nothing happens, because attributes cannot be
deleted from a nonexistent item. The operation succeeds, but DynamoDB
does not create a new item.
ADD
- Causes DynamoDB to create an item with the supplied
primary key and number (or set of numbers) for the attribute value. The
only data types allowed are Number and Number Set.
If you provide 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
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based
on ASCII character code values. For example, a
is greater
than A
, and a
is greater than B
.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ
: Equal. EQ
is supported for all datatypes,
including lists and maps.
AttributeValueList can contain only one AttributeValue
element of type String, Number, Binary, String Set, Number Set, or Binary
Set. If an item contains an AttributeValue element of a different
type than the one provided in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not equal
{"NS":["6", "2", "1"]}
.
NE
: Not equal. NE
is supported for all
datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of
type String, Number, Binary, String Set, Number Set, or Binary Set. If an
item contains an AttributeValue of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2", "1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one AttributeValue of
type String, Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one provided
in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GE
: Greater than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
NOT_NULL
: The attribute exists. NOT_NULL
is
supported for all datatypes, including lists and maps.
This operator tests for the existence of an attribute, not its data type.
If the data type of attribute "a
" is null, and you evaluate
it using NOT_NULL
, the result is a Boolean true. This
result is because the attribute "a
" exists; its data type is
not relevant to the NOT_NULL
comparison operator.
NULL
: The attribute does not exist. NULL
is
supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data
type. If the data type of attribute "a
" is null, and you
evaluate it using NULL
, the result is a Boolean
false. This is because the attribute "a
" exists; its
data type is not relevant to the NULL
comparison operator.
CONTAINS
: Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is of type String, then the operator checks
for a substring match. If the target attribute of the comparison is of
type Binary, then the operator looks for a subsequence of the target that
matches the input. If the target attribute of the comparison is a set ("
SS
", "NS
", or "BS
"), then the
operator evaluates to true if it finds an exact match with any member of
the set.
CONTAINS is supported for lists: When evaluating "
a CONTAINS b
", "a
" can be a list; however, "
b
" cannot be a set, a map, or a list.
NOT_CONTAINS
: Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is a String, then the operator checks for the
absence of a substring match. If the target attribute of the comparison
is Binary, then the operator checks for the absence of a subsequence of
the target that matches the input. If the target attribute of the
comparison is a set ("SS
", "NS
", or "
BS
"), then the operator evaluates to true if it does
not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating "
a NOT CONTAINS b
", "a
" can be a list; however, "b
" cannot be a set, a map, or a
list.
BEGINS_WITH
: Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN
: Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN
: Greater than or equal to the first value, and less
than or equal to the second value.
AttributeValueList must contain two AttributeValue elements
of the same type, either String, Number, or Binary (not a set type). A
target attribute matches if the target value is greater than, or equal
to, the first element and less than, or equal to, the second element. If
an item contains an AttributeValue element of a different type
than the one provided in the request, the value does not match. For
example, {"S":"6"}
does not compare to
{"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true
, DynamoDB will check to see if that
attribute value already exists in the table. If it is found, then the
condition evaluates to true; otherwise the condition evaluate to false.
If Exists is false
, DynamoDB assumes that the
attribute value does not exist in the table. If in fact the value
does not exist, then the assumption is valid and the condition evaluates
to true. If the value is found, despite the assumption that it does not
exist, the condition evaluates to false.
Note that the default value for Exists is true
.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
java.lang.String conditionalOperator
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND
- If all of the conditions evaluate to true, then the
entire map evaluates to true.
OR
- If at least one of the conditions evaluate to true,
then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is the
default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
Constraints:
Allowed Values: AND, OR
java.lang.String returnValues
Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:
NONE
- If ReturnValues is not specified, or if its
value is NONE
, then nothing is returned. (This setting is
the default for ReturnValues.)
ALL_OLD
- If UpdateItem overwrote an attribute
name-value pair, then the content of the old item is returned.
UPDATED_OLD
- The old versions of only the updated
attributes are returned.
ALL_NEW
- All of the attributes of the new version of the
item are returned.
UPDATED_NEW
- The new versions of only the updated
attributes are returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
java.lang.String returnConsumedCapacity
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
java.lang.String returnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item
collections, if any, that were modified during the operation are returned
in the response. If set to NONE
(the default), no statistics
are returned.
Constraints:
Allowed Values: SIZE, NONE
java.lang.String updateExpression
An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.
The following action values are available for UpdateExpression.
SET
- Adds one or more attributes and values to an item. If
any of these attribute already exist, they are replaced by the new
values. You can also use SET
to add or subtract from an
attribute that is of type Number. For example:
SET myNum = myNum + :val
SET
supports the following functions:
if_not_exists (path, operand)
- if the item does not contain
an attribute at the specified path, then if_not_exists
evaluates to operand; otherwise, it evaluates to path. You can use this
function to avoid overwriting an attribute that may already be present in
the item.
list_append (operand, operand)
- evaluates to a list with a
new element added to it. You can append the new element to the start or
the end of the list by reversing the order of the operands.
These function names are case-sensitive.
REMOVE
- Removes one or more attributes from an item.
ADD
- Adds the specified value to the item, if the attribute
does not already exist. If the attribute does exist, then the behavior of
ADD
depends on the data type of the attribute:
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD
to increment or decrement a number value for
an item that doesn't exist before the update, DynamoDB uses
0
as the initial value.
Similarly, if you use ADD
for an existing item to increment
or decrement an attribute value that doesn't exist before the update,
DynamoDB uses 0
as the initial value. For example, suppose
that the item you want to update doesn't have an attribute named
itemcount, but you decide to ADD
the number
3
to this attribute anyway. DynamoDB will create the
itemcount attribute, set its initial value to 0
, and
finally add 3
to it. The result will be a new
itemcount attribute in the item, with a value of 3
.
If the existing data type is a set and if Value is also a set,
then Value is added to the existing set. For example, if the
attribute value is the set [1,2]
, and the ADD
action specified [3]
, then the final attribute value is
[1,2,3]
. An error occurs if an ADD
action is
specified for a set attribute and the attribute type specified does not
match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
The ADD
action only supports Number and set data types. In
addition, ADD
can only be used on top-level attributes, not
nested attributes.
DELETE
- Deletes an element from a set.
If a set of values is specified, then those values are subtracted from
the old set. For example, if the attribute value was the set
[a,b,c]
and the DELETE
action specifies
[a,c]
, then the final attribute value is [b]
.
Specifying an empty set is an error.
The DELETE
action only supports set data types. In addition,
DELETE
can only be used on top-level attributes, not nested
attributes.
You can have many actions in a single expression, such as the following:
SET a=:value1, b=:value2 DELETE :value3, :value4, :value5
For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
UpdateExpression replaces the legacy AttributeUpdates parameter.
java.lang.String conditionExpression
A condition that must be satisfied in order for a conditional update to succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
java.util.Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
java.util.Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
java.util.Map<K,V> attributes
A map of attribute values as they appeared before the UpdateItem
operation. This map only appears if ReturnValues was specified as
something other than NONE
in the request. Each element
represents one attribute.
ConsumedCapacity consumedCapacity
The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
ItemCollectionMetrics itemCollectionMetrics
Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.
java.util.List<E> attributeDefinitions
An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.
java.lang.String tableName
The name of the table to be updated.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
ProvisionedThroughput provisionedThroughput
Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
java.util.List<E> globalSecondaryIndexUpdates
An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:
Create - add a new global secondary index to the table.
Update - modify the provisioned throughput settings of an existing global secondary index.
Delete - remove a global secondary index from the table.
For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
StreamSpecification streamSpecification
Represents the DynamoDB Streams configuration for the table.
You will receive a ResourceInUseException if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream.
TableDescription tableDescription
Represents the properties of a table.
PutRequest putRequest
A request to perform a PutItem operation.
DeleteRequest deleteRequest
A request to perform a DeleteItem operation.
java.lang.String vpcPeeringConnectionId
VpcPeeringConnection vpcPeeringConnection
java.lang.String attributeName
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeValues
java.lang.String attributeValue
java.lang.String instanceType
java.lang.String instanceId
java.lang.String spotInstanceRequestId
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
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
java.lang.String publicIp
java.lang.String domain
standard
) or instances in a VPC
(vpc
).
Constraints:
Allowed Values: vpc, standard
java.lang.String allocationId
java.lang.String autoPlacement
Default: Enabled
Constraints:
Allowed Values: on, off
java.lang.String clientToken
java.lang.String instanceType
java.lang.Integer quantity
java.lang.String availabilityZone
com.amazonaws.internal.ListWithAutoConstructFlag<T> hostIds
java.lang.String networkInterfaceId
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
java.lang.Integer secondaryPrivateIpAddressCount
java.lang.Boolean allowReassignment
java.lang.String instanceId
java.lang.String publicIp
java.lang.String allocationId
java.lang.String networkInterfaceId
java.lang.String privateIpAddress
java.lang.Boolean allowReassociation
java.lang.String associationId
java.lang.String dhcpOptionsId
default
to associate
no DHCP options with the VPC.java.lang.String vpcId
java.lang.String subnetId
java.lang.String routeTableId
java.lang.String associationId
java.lang.String instanceId
java.lang.String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
java.lang.Boolean returnValue
true
if the request succeeds; otherwise, it
returns an error.java.lang.String internetGatewayId
java.lang.String vpcId
java.lang.String networkInterfaceId
java.lang.String instanceId
java.lang.Integer deviceIndex
java.lang.String attachmentId
java.lang.String volumeId
java.lang.String instanceId
java.lang.String device
/dev/sdh
or xvdh
).VolumeAttachment attachment
java.lang.String vpnGatewayId
java.lang.String vpcId
VpcAttachment vpcAttachment
java.lang.String groupId
java.lang.String sourceSecurityGroupName
java.lang.String sourceSecurityGroupOwnerId
java.lang.String ipProtocol
java.lang.Integer fromPort
java.lang.Integer toPort
java.lang.String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
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). (VPC only) 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
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
java.lang.String zoneName
java.lang.String state
Constraints:
Allowed Values: available, information, impaired, unavailable
java.lang.String regionName
com.amazonaws.internal.ListWithAutoConstructFlag<T> messages
java.lang.String message
com.amazonaws.internal.ListWithAutoConstructFlag<T> availableInstanceCapacity
java.lang.Integer availableVCpus
java.lang.String virtualName
ephemeral
N). Instance store
volumes are numbered starting from 0. An instance type with 2
available instance store volumes can specify mappings for
ephemeral0
and ephemeral1
.The number of
available instance store volumes depends on the instance type. After
you connect to the instance, you must mount the volume.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
java.lang.String deviceName
/dev/sdh
or xvdh
).EbsBlockDevice ebs
java.lang.String noDevice
java.lang.String instanceId
Type: String
Default: None
Required: Yes
Storage storage
BundleTask bundleTask
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
java.lang.String code
java.lang.String message
java.lang.String bundleId
BundleTask bundleTask
java.lang.String conversionTaskId
java.lang.String reasonMessage
java.lang.String exportTaskId
CreateInstanceExportTask
.java.lang.String importTaskId
java.lang.String cancelReason
java.lang.String importTaskId
java.lang.String state
java.lang.String previousState
java.lang.String spotInstanceRequestId
java.lang.String state
Constraints:
Allowed Values: active, open, closed, cancelled, completed
java.lang.String reservedInstancesListingId
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesListings
java.lang.String code
Constraints:
Allowed Values: fleetRequestIdDoesNotExist, fleetRequestIdMalformed, fleetRequestNotInCancellableState, unexpectedError
java.lang.String message
java.lang.String spotFleetRequestId
CancelSpotFleetRequestsError error
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotFleetRequestIds
java.lang.Boolean terminateInstances
com.amazonaws.internal.ListWithAutoConstructFlag<T> unsuccessfulFleetRequests
com.amazonaws.internal.ListWithAutoConstructFlag<T> successfulFleetRequests
java.lang.String spotFleetRequestId
java.lang.String currentSpotFleetRequestState
Constraints:
Allowed Values: submitted, active, cancelled, failed, cancelled_running, cancelled_terminating, modifying
java.lang.String previousSpotFleetRequestState
Constraints:
Allowed Values: submitted, active, cancelled, failed, cancelled_running, cancelled_terminating, modifying
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotInstanceRequestIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> cancelledSpotInstanceRequests
java.lang.String vpcId
java.lang.Boolean classicLinkDnsSupported
java.lang.String instanceId
java.lang.String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.util.Date uploadStart
java.util.Date uploadEnd
java.lang.Double uploadSize
java.lang.String comment
java.lang.String productCode
java.lang.String instanceId
java.lang.String ownerId
java.lang.Boolean returnValue
true
if the
specified product code is owned by the requester and associated with
the specified instance.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
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String sourceRegion
java.lang.String sourceImageId
java.lang.String name
java.lang.String description
java.lang.String clientToken
java.lang.Boolean encrypted
KmsKeyId
. For more information, see Amazon
EBS Encryption in the Amazon Elastic Compute Cloud User
Guide.java.lang.String kmsKeyId
arn:aws:kms
namespace, followed by
the region of the CMK, the AWS account ID of the CMK owner, the
key
namespace, and then the CMK ID. For example,
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
The specified CMK must exist in the region that the snapshot is being
copied to. If a KmsKeyId
is specified, the
Encrypted
flag must also be set.java.lang.String imageId
java.lang.String sourceRegion
java.lang.String sourceSnapshotId
java.lang.String description
java.lang.String destinationRegion
PresignedUrl
parameter of a snapshot copy operation. This parameter is only valid
for specifying the destination region in a PresignedUrl
parameter, where it is required. CopySnapshot
sends the snapshot copy to the regional endpoint that you send the
HTTP request to, such as ec2.us-east-1.amazonaws.com
(in
the AWS CLI, this is specified with the --region
parameter or the default region in your AWS configuration file).
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 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.java.lang.Boolean encrypted
KmsKeyId
. For more information, see Amazon
EBS Encryption in the Amazon Elastic Compute Cloud User
Guide.java.lang.String kmsKeyId
arn:aws:kms
namespace, followed by the region of the CMK,
the AWS account ID of the CMK owner, the key
namespace,
and then the CMK ID. For example,
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
The specified CMK must exist in the region that the snapshot is being
copied to. If a KmsKeyId
is specified, the
Encrypted
flag must also be set.java.lang.String snapshotId
java.lang.String type
ipsec.1
).
Constraints:
Allowed Values: ipsec.1
java.lang.String publicIp
java.lang.Integer bgpAsn
Default: 65000
CustomerGateway customerGateway
com.amazonaws.internal.ListWithAutoConstructFlag<T> dhcpConfigurations
DhcpOptions dhcpOptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceIds
Constraints: Maximum of 1000 resources
java.lang.String resourceType
Constraints:
Allowed Values: VPC, Subnet, NetworkInterface
java.lang.String trafficType
Constraints:
Allowed Values: ACCEPT, REJECT, ALL
java.lang.String logGroupName
java.lang.String deliverLogsPermissionArn
java.lang.String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> flowLogIds
java.lang.String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> unsuccessful
java.lang.String instanceId
java.lang.String name
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
java.lang.String description
java.lang.Boolean noReboot
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
java.lang.String imageId
java.lang.String description
java.lang.String instanceId
java.lang.String targetEnvironment
Constraints:
Allowed Values: citrix, vmware, microsoft
ExportToS3TaskSpecification exportToS3Task
ExportTask exportTask
InternetGateway internetGateway
java.lang.String keyName
Constraints: Up to 255 ASCII characters
KeyPair keyPair
java.lang.String subnetId
java.lang.String allocationId
java.lang.String clientToken
Constraint: Maximum 64 ASCII characters.
NatGateway natGateway
java.lang.String clientToken
java.lang.String networkAclId
java.lang.Integer ruleNumber
Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
java.lang.String protocol
java.lang.String ruleAction
Constraints:
Allowed Values: allow, deny
java.lang.Boolean egress
java.lang.String cidrBlock
172.16.0.0/24
).IcmpTypeCode icmpTypeCode
PortRange portRange
java.lang.String vpcId
NetworkAcl networkAcl
java.lang.String subnetId
java.lang.String description
java.lang.String privateIpAddress
privateIpAddresses
as primary
(only one IP address can be designated as primary).com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
java.lang.Integer secondaryPrivateIpAddressCount
privateIpAddresses
. The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide.
NetworkInterface networkInterface
java.lang.String groupName
Constraints: Up to 255 ASCII characters
java.lang.String strategy
Constraints:
Allowed Values: cluster
java.lang.String reservedInstancesId
java.lang.Integer instanceCount
com.amazonaws.internal.ListWithAutoConstructFlag<T> priceSchedules
java.lang.String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesListings
java.lang.String routeTableId
java.lang.String destinationCidrBlock
java.lang.String gatewayId
java.lang.String instanceId
java.lang.String networkInterfaceId
java.lang.String vpcPeeringConnectionId
java.lang.String natGatewayId
java.lang.Boolean returnValue
true
if the request succeeds; otherwise, it
returns an error.java.lang.String vpcId
RouteTable routeTable
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
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 vpcId
java.lang.String groupId
java.lang.String volumeId
java.lang.String description
Snapshot snapshot
java.lang.String bucket
java.lang.String prefix
SpotDatafeedSubscription spotDatafeedSubscription
java.lang.String vpcId
java.lang.String cidrBlock
10.0.0.0/24
.java.lang.String availabilityZone
Default: AWS selects one for you. If you create more than one subnet in your VPC, we may not necessarily select a different zone for each subnet.
Subnet subnet
com.amazonaws.internal.ListWithAutoConstructFlag<T> resources
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
value
parameter is required, but if
you don't want the tag to have a value, specify the parameter with no
value, and we set the value to an empty string.java.lang.String userId
java.lang.String group
Constraints:
Allowed Values: all
com.amazonaws.internal.ListWithAutoConstructFlag<T> add
com.amazonaws.internal.ListWithAutoConstructFlag<T> remove
java.lang.Integer size
Constraints: 1-16384 for
gp2
, 4-16384 for io1
, 500-16384 for
st1
, 500-16384 for sc1
, and 1-1024 for
standard
. If you specify a snapshot, the volume size must
be equal to or larger than the snapshot size.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
java.lang.String snapshotId
java.lang.String availabilityZone
java.lang.String volumeType
gp2
for General Purpose SSD,
io1
for Provisioned IOPS SSD, st1
for
Throughput Optimized HDD, sc1
for Cold HDD, or
standard
for Magnetic volumes. Default:
standard
Constraints:
Allowed Values: standard, io1, gp2, sc1, st1
java.lang.Integer iops
Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes
java.lang.Boolean encrypted
java.lang.String kmsKeyId
arn:aws:kms
namespace, followed by the
region of the CMK, the AWS account ID of the CMK owner, the
key
namespace, and then the CMK ID. For example,
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
If a KmsKeyId
is specified, the Encrypted
flag must also be set.Volume volume
java.lang.String vpcId
java.lang.String serviceName
com.amazonaws.region.service
. To get a list
of available services, use the DescribeVpcEndpointServices
request.java.lang.String policyDocument
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeTableIds
java.lang.String clientToken
VpcEndpoint vpcEndpoint
java.lang.String clientToken
java.lang.String vpcId
java.lang.String peerVpcId
java.lang.String peerOwnerId
Default: Your AWS account ID
VpcPeeringConnection vpcPeeringConnection
java.lang.String cidrBlock
10.0.0.0/16
.java.lang.String instanceTenancy
default
, instances are launched with shared tenancy by
default. You can launch instances with any tenancy into a shared
tenancy VPC. For dedicated
, instances are launched as
dedicated tenancy instances by default. You can only launch instances
with a tenancy of dedicated
or host
into a
dedicated tenancy VPC. Important: The host
value cannot be used with this parameter. Use the default
or dedicated
values only.
Default:
default
Constraints:
Allowed Values: default, dedicated, host
Vpc vpc
java.lang.String type
ipsec.1
).java.lang.String customerGatewayId
java.lang.String vpnGatewayId
VpnConnectionOptionsSpecification options
true
. Default: false
VpnConnection vpnConnection
java.lang.String vpnConnectionId
java.lang.String destinationCidrBlock
java.lang.String type
Constraints:
Allowed Values: ipsec.1
java.lang.String availabilityZone
VpnGateway vpnGateway
java.lang.String customerGatewayId
java.lang.String state
pending | available |
deleting | deleted
).java.lang.String type
ipsec.1
).java.lang.String ipAddress
java.lang.String bgpAsn
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String customerGatewayId
java.lang.String dhcpOptionsId
com.amazonaws.internal.ListWithAutoConstructFlag<T> flowLogIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> unsuccessful
java.lang.String internetGatewayId
java.lang.String keyName
java.lang.String natGatewayId
java.lang.String natGatewayId
java.lang.String networkAclId
java.lang.Integer ruleNumber
java.lang.Boolean egress
java.lang.String networkAclId
java.lang.String networkInterfaceId
java.lang.String groupName
java.lang.String routeTableId
java.lang.String destinationCidrBlock
java.lang.String routeTableId
java.lang.String groupName
java.lang.String groupId
java.lang.String snapshotId
java.lang.String subnetId
com.amazonaws.internal.ListWithAutoConstructFlag<T> resources
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
value
parameter, we delete the tag regardless of its value. If you specify
this parameter with an empty string as the value, we delete the key
only if its value is an empty string.java.lang.String volumeId
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcEndpointIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> unsuccessful
java.lang.String vpcPeeringConnectionId
java.lang.Boolean returnValue
true
if the request succeeds; otherwise, it
returns an error.java.lang.String vpcId
java.lang.String vpnConnectionId
java.lang.String vpnConnectionId
java.lang.String destinationCidrBlock
java.lang.String vpnGatewayId
java.lang.String imageId
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> accountAttributes
com.amazonaws.internal.ListWithAutoConstructFlag<T> publicIps
Default: Describes all your Elastic IP addresses.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
allocation-id
- [EC2-VPC] The allocation ID for
the address.
association-id
- [EC2-VPC] The
association ID for the address.
domain
-
Indicates whether the address is for use in EC2-Classic
(standard
) or in a VPC (vpc
).
instance-id
- The ID of the instance the address is
associated with, if any.
network-interface-id
- [EC2-VPC] The ID of the network
interface that the address is associated with, if any.
network-interface-owner-id
- The AWS account ID of the
owner.
private-ip-address
- [EC2-VPC] The
private IP address associated with the Elastic IP address.
public-ip
- The Elastic IP address.
com.amazonaws.internal.ListWithAutoConstructFlag<T> allocationIds
Default: Describes all your Elastic IP addresses.
com.amazonaws.internal.ListWithAutoConstructFlag<T> addresses
com.amazonaws.internal.ListWithAutoConstructFlag<T> zoneNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
message
- Information
about the Availability Zone.
region-name
-
The name of the region for the Availability Zone (for example,
us-east-1
).
state
- The state
of the Availability Zone (available
|
information
| impaired
|
unavailable
).
zone-name
- The
name of the Availability Zone (for example, us-east-1a
).
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> bundleIds
Default: Describes all your bundle tasks.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
bundle-id
- The ID of
the bundle task.
error-code
- If the task
failed, the error code returned.
error-message
- If the task failed, the error message
returned.
instance-id
- The ID of the
instance.
progress
- The level of task
completion, as a percentage (for example, 20%).
s3-bucket
- The Amazon S3 bucket to store the AMI.
s3-prefix
- The beginning of the AMI name.
start-time
- The time the task started (for
example, 2013-09-15T17:15:20.000Z).
state
-
The state of the task (pending
|
waiting-for-shutdown
| bundling
|
storing
| cancelling
| complete
| failed
).
update-time
- The
time of the most recent update for the task.
com.amazonaws.internal.ListWithAutoConstructFlag<T> bundleTasks
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
group-id
- The ID of a
VPC security group that's associated with the instance.
instance-id
- The ID of the instance.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id
- The ID of the VPC that the
instance is linked to.
java.lang.String nextToken
java.lang.Integer maxResults
NextToken
value. This value can be between 5 and 1000; if
MaxResults
is given a value larger than 1000, only 1000
results are returned. You cannot specify this parameter and the
instance IDs parameter in the same request. Constraint: If the value is greater than 1000, we return only 1000 items.
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
java.lang.String nextToken
null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> conversionTaskIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> conversionTasks
com.amazonaws.internal.ListWithAutoConstructFlag<T> customerGatewayIds
Default: Describes all your customer gateways.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
bgp-asn
- The customer
gateway's Border Gateway Protocol (BGP) Autonomous System Number
(ASN).
customer-gateway-id
- The ID of the
customer gateway.
ip-address
- The IP
address of the customer gateway's Internet-routable external
interface.
state
- The state of the
customer gateway (pending
| available
|
deleting
| deleted
).
type
- The type of customer gateway. Currently, the
only supported type is ipsec.1
.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
com.amazonaws.internal.ListWithAutoConstructFlag<T> customerGateways
com.amazonaws.internal.ListWithAutoConstructFlag<T> dhcpOptionsIds
Default: Describes all your DHCP options sets.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
dhcp-options-id
- The
ID of a set of DHCP options.
key
- The key
for one of the options (for example, domain-name
).
value
- The value for one of the options.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
com.amazonaws.internal.ListWithAutoConstructFlag<T> dhcpOptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> exportTaskIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> exportTasks
com.amazonaws.internal.ListWithAutoConstructFlag<T> flowLogIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filter
deliver-log-status
- The
status of the logs delivery (SUCCESS
|
FAILED
).
flow-log-id
- The ID of
the flow log.
log-group-name
- The name of
the log group.
resource-id
- The ID of the
VPC, subnet, or network interface.
traffic-type
- The type of traffic
(ACCEPT
| REJECT
| ALL
)
java.lang.String nextToken
java.lang.Integer maxResults
NextToken
value. This value can be
between 5 and 1000; if MaxResults
is given a value larger
than 1000, only 1000 results are returned. You cannot specify this
parameter and the flow log IDs parameter in the same request.com.amazonaws.internal.ListWithAutoConstructFlag<T> flowLogs
java.lang.String nextToken
null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> hostIds
java.lang.String nextToken
java.lang.Integer maxResults
nextToken
value. This value can be
between 5 and 500; if maxResults
is given a larger value
than 500, you will receive an error. You cannot specify this parameter
and the host IDs parameter in the same request.com.amazonaws.internal.ListWithAutoConstructFlag<T> filter
instance-type
- The
instance type size that the Dedicated host is configured to
support.
auto-placement
- Whether
auto-placement is enabled or disabled (on
|
off
).
host-reservation-id
- The
ID of the reservation associated with this host.
client-token
- The idempotency token you provided
when you launched the instance
state
- The
allocation state of the Dedicated host (available
|
under-assessment
| permanent-failure
|
released
| released-permanent-failure
).
availability-zone
- The Availability Zone of the
host.
com.amazonaws.internal.ListWithAutoConstructFlag<T> hosts
java.lang.String nextToken
null
when there are no more results to return.java.lang.String resource
com.amazonaws.internal.ListWithAutoConstructFlag<T> statuses
java.lang.String imageId
java.lang.String attribute
Note: Depending on your account
privileges, the blockDeviceMapping
attribute may return a
Client.AuthFailure
error. If this happens, use
DescribeImages to get information about the block device
mapping for the AMI.
Constraints:
Allowed Values: description, kernel, ramdisk, launchPermission, productCodes, blockDeviceMapping, sriovNetSupport
ImageAttribute imageAttribute
com.amazonaws.internal.ListWithAutoConstructFlag<T> imageIds
Default: Describes all images available to you.
com.amazonaws.internal.ListWithAutoConstructFlag<T> owners
amazon
(owner is Amazon), aws-marketplace
(owner is AWS Marketplace), self
(owner is the sender of
the request). Omitting this option returns all images for which you
have launch permissions, regardless of ownership.com.amazonaws.internal.ListWithAutoConstructFlag<T> executableUsers
self
(the sender of the request), or
all
(public AMIs).com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
architecture
- The
image architecture (i386
| x86_64
).
block-device-mapping.delete-on-termination
- A
Boolean value that indicates whether the Amazon EBS volume is deleted
on instance termination.
block-device-mapping.device-name
- The device name for
the EBS volume (for example, /dev/sdh
).
block-device-mapping.snapshot-id
- The ID of the
snapshot used for the EBS volume.
block-device-mapping.volume-size
- The volume size of
the EBS volume, in GiB.
block-device-mapping.volume-type
- The volume type of
the EBS volume (gp2
| io1
| st1
| sc1
| standard
).
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
).
com.amazonaws.internal.ListWithAutoConstructFlag<T> images
com.amazonaws.internal.ListWithAutoConstructFlag<T> importTaskIds
java.lang.String nextToken
java.lang.Integer maxResults
NextToken
value.com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
task-state
filter and one of the
following values: active, completed, deleting, deleted.com.amazonaws.internal.ListWithAutoConstructFlag<T> importImageTasks
java.lang.String nextToken
null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> importTaskIds
java.lang.String nextToken
java.lang.Integer maxResults
NextToken
value.com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> importSnapshotTasks
java.lang.String nextToken
null
when there are no more results to return.java.lang.String instanceId
java.lang.String attribute
Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport
InstanceAttribute instanceAttribute
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
Default: Describes all your instances.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
affinity
- The affinity
setting for an instance running on a Dedicated host
(default
| host
).
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 EBS volume mapped to the instance, for
example, 2010-09-15T17:15:20.000Z
.
block-device-mapping.delete-on-termination
- A Boolean
that indicates whether the EBS volume is deleted on instance
termination.
block-device-mapping.device-name
- The device name for
the EBS volume (for example, /dev/sdh
or
xvdh
).
block-device-mapping.status
- The status for the EBS
volume (attaching
| attached
|
detaching
| detached
).
block-device-mapping.volume-id
- The volume ID of the
EBS volume.
client-token
- The idempotency
token you provided when you launched the instance.
dns-name
- The public DNS name of the instance.
group-id
- The ID of the security group for the
instance. EC2-Classic only.
group-name
-
The name of the security group for the instance. EC2-Classic only.
host-Id
- The ID of the Dedicated host on
which the instance is running, if applicable.
hypervisor
- The hypervisor type of the instance
(ovm
| xen
).
iam-instance-profile.arn
- The instance profile
associated with the instance. Specified as an ARN.
image-id
- The ID of the image used to launch the
instance.
instance-id
- The ID of the
instance.
instance-lifecycle
- Indicates
whether this is a Spot Instance or a Scheduled Instance
(spot
| scheduled
).
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,
t2.micro
).
instance.group-id
-
The ID of the security group for the instance.
instance.group-name
- The name of the security group
for the instance.
ip-address
- The public
IP address of the instance.
kernel-id
- The
kernel ID.
key-name
- The name of the key
pair used when the instance was launched.
launch-index
- When launching multiple instances, this
is the index for the instance in the launch group (for example, 0, 1,
2, and so on).
launch-time
- The time when
the instance was launched.
monitoring-state
- Indicates whether monitoring is enabled for the instance
(disabled
| enabled
).
owner-id
- The AWS account ID of the instance owner.
placement-group-name
- The name of the
placement group for the instance.
platform
- The platform. Use windows
if you have Windows
instances; otherwise, leave blank.
private-dns-name
- The private DNS name of the
instance.
private-ip-address
- The private
IP address of the instance.
product-code
-
The product code associated with the AMI used to launch the instance.
product-code.type
- The type of product
code (devpay
| marketplace
).
ramdisk-id
- The RAM disk ID.
reason
- The reason for the current state of the
instance (for example, shows "User Initiated [date]" when you stop or
terminate the instance). Similar to the state-reason-code filter.
requester-id
- The ID of the entity that
launched the instance on your behalf (for example, AWS Management
Console, Auto Scaling, and so on).
reservation-id
- The ID of the instance's reservation.
A reservation ID is created any time you launch an instance. A
reservation ID has a one-to-one relationship with an instance launch
request, but can be associated with more than one instance if you
launch multiple instances using the same launch request. For example,
if you launch one instance, you'll get one reservation ID. If you
launch ten instances using the same launch request, you'll also get
one reservation ID.
root-device-name
- The
name of the root device for the instance (for example,
/dev/sda1
or /dev/xvda
).
root-device-type
- The type of root device that the
instance uses (ebs
| instance-store
).
source-dest-check
- Indicates whether the
instance performs source/destination checking. A value of
true
means that checking is enabled, and
false
means checking is disabled. The value must be
false
for the instance to perform network address
translation (NAT) in your VPC.
spot-instance-request-id
- The ID of the Spot instance
request.
state-reason-code
- The reason
code for the state change.
state-reason-message
- A message that describes the
state change.
subnet-id
- The ID of the
subnet for the instance.
tag
:key=value - The key/value
combination of a tag assigned to the resource, where
tag
:key is the tag's key.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
tenancy
- The tenancy of an
instance (dedicated
| default
|
host
).
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-dest-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
NextToken
value. This value can be between 5 and 1000.
You cannot specify this parameter and the instance IDs parameter or
tag filters in the same call.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservations
java.lang.String nextToken
null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone
- The
Availability Zone of the instance.
event.code
- The code for the scheduled event
(instance-reboot
| system-reboot
|
system-maintenance
| instance-retirement
|
instance-stop
).
event.description
- A description of the event.
event.not-after
- The latest end time for the
scheduled event (for example, 2014-09-15T17:15:20.000Z
).
event.not-before
- The earliest start time
for the scheduled event (for example,
2014-09-15T17:15:20.000Z
).
instance-state-code
- The code for the instance state,
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
NextToken
value. This value can be between 5 and 1000.
You cannot specify this parameter and the instance IDs parameter in
the same call.java.lang.Boolean includeAllInstances
true
, includes the health status for all instances.
When false
, includes the health status for running
instances only. Default: false
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceStatuses
java.lang.String nextToken
null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> internetGatewayIds
Default: Describes all your Internet gateways.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
attachment.state
- The
current state of the attachment between the gateway and the VPC
(available
). Present only if a VPC is attached.
attachment.vpc-id
- The ID of an attached VPC.
internet-gateway-id
- The ID of the
Internet gateway.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
com.amazonaws.internal.ListWithAutoConstructFlag<T> internetGateways
com.amazonaws.internal.ListWithAutoConstructFlag<T> keyNames
Default: Describes all your key pairs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
fingerprint
- The
fingerprint of the key pair.
key-name
- The
name of the key pair.
com.amazonaws.internal.ListWithAutoConstructFlag<T> keyPairs
com.amazonaws.internal.ListWithAutoConstructFlag<T> publicIps
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
moving-status
- The
status of the Elastic IP address (MovingToVpc
|
RestoringToClassic
).
java.lang.Integer maxResults
NextToken
value. This value can be between 5 and 1000; if
MaxResults
is given a value outside of this range, an
error is returned. Default: If no value is provided, the default is 1000.
com.amazonaws.internal.ListWithAutoConstructFlag<T> movingAddressStatuses
java.lang.String nextToken
null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> natGatewayIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filter
nat-gateway-id
- The ID
of the NAT gateway.
state
- The state of
the NAT gateway (pending
| failed
|
available
| deleting
|
deleted
).
subnet-id
- The ID
of the subnet in which the NAT gateway resides.
vpc-id
- The ID of the VPC in which the NAT gateway
resides.
java.lang.Integer maxResults
Constraint: If the value specified is greater than 1000, we return only 1000 items.
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> natGateways
java.lang.String nextToken
null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> networkAclIds
Default: Describes all your network ACLs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
association.association-id
- The ID of an association
ID for the ACL.
association.network-acl-id
- The ID of the network ACL involved in the association.
association.subnet-id
- The ID of the subnet involved
in the association.
default
- Indicates
whether the ACL is the default network ACL for the VPC.
entry.cidr
- The CIDR range specified in the entry.
entry.egress
- Indicates whether the entry
applies to egress traffic.
entry.icmp.code
- The ICMP code specified in the entry, if any.
entry.icmp.type
- The ICMP type specified in the
entry, if any.
entry.port-range.from
- The
start of the port range specified in the entry.
entry.port-range.to
- The end of the port range
specified in the entry.
entry.protocol
-
The protocol specified in the entry (tcp
|
udp
| icmp
or a protocol number).
entry.rule-action
- Allows or denies the matching
traffic (allow
| deny
).
entry.rule-number
- The number of an entry (in other
words, rule) in the ACL's set of entries.
network-acl-id
- The ID of the network ACL.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id
- The ID of the VPC for the
network ACL.
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkAcls
java.lang.String networkInterfaceId
java.lang.String attribute
Constraints:
Allowed Values: description, groupSet, sourceDestCheck, attachment
java.lang.String networkInterfaceId
java.lang.String description
java.lang.Boolean sourceDestCheck
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
NetworkInterfaceAttachment attachment
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaceIds
Default: Describes all your network interfaces.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
addresses.private-ip-address
- The private IP
addresses associated with the network interface.
addresses.primary
- Whether the private IP address is
the primary IP address associated with the network interface.
addresses.association.public-ip
- The association
ID returned when the network interface was associated with the Elastic
IP address.
addresses.association.owner-id
- The owner ID of the addresses associated with the network interface.
association.association-id
- The
association ID returned when the network interface was associated with
an IP address.
association.allocation-id
-
The allocation ID returned when you allocated the Elastic IP address
for your network interface.
association.ip-owner-id
- The owner of the Elastic IP
address associated with the network interface.
association.public-ip
- The address of the Elastic IP
address bound to the network interface.
association.public-dns-name
- The public DNS name for
the network interface.
attachment.attachment-id
- The ID of the interface
attachment.
attachment.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.
attachment.device-index
- The device index
to which the network interface is attached.
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.nat-gateway-id
- The ID of the NAT gateway
to which the network interface is attached.
attachment.status
- The status of the attachment
(attaching
| attached
|
detaching
| detached
).
availability-zone
- The Availability Zone of the
network interface.
description
- The
description of the network interface.
group-id
- The ID of a security group associated with
the network interface.
group-name
- The
name of a security group associated with the network interface.
mac-address
- The MAC address of the network
interface.
network-interface-id
- The ID of
the network interface.
owner-id
- The AWS
account ID of the network interface owner.
private-ip-address
- The private IP address or
addresses of the network interface.
private-dns-name
- The private DNS name of the network
interface.
requester-id
- The ID of the
entity that launched the instance on your behalf (for example, AWS
Management Console, Auto Scaling, and so on).
requester-managed
- Indicates whether the network
interface is being managed by an AWS service (for example, AWS
Management Console, Auto Scaling, and so on).
source-desk-check
- Indicates whether the network
interface performs source/destination checking. A value of
true
means checking is enabled, and false
means checking is disabled. The value must be false
for
the network interface to perform network address translation (NAT) in
your VPC.
status
- The status of the
network interface. If the network interface is not attached to an
instance, the status is available
; if a network interface
is attached to an instance the status is in-use
.
subnet-id
- The ID of the subnet for the network
interface.
tag
:key=value -
The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the
resource. This filter is independent of the tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and
the filter "tag-value=X", you get any resources assigned both the tag
key Purpose (regardless of what the tag's value is), and the tag value
X (regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id
- The ID of the VPC for the
network interface.
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
Default: Describes all your placement groups, or only those otherwise specified.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
group-name
- The name
of the placement group.
state
- The state
of the placement group (pending
| available
| deleting
| deleted
).
strategy
- The strategy of the placement group
(cluster
).
com.amazonaws.internal.ListWithAutoConstructFlag<T> placementGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> prefixListIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
prefix-list-id
: The ID
of a prefix list.
prefix-list-name
: The
name of a prefix list.
java.lang.Integer maxResults
Constraint: If the value specified is greater than 1000, we return only 1000 items.
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> prefixLists
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> regionNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
endpoint
- The endpoint
of the region (for example, ec2.us-east-1.amazonaws.com
).
region-name
- The name of the region (for
example, us-east-1
).
com.amazonaws.internal.ListWithAutoConstructFlag<T> regions
java.lang.String reservedInstancesId
java.lang.String reservedInstancesListingId
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
reserved-instances-id
-
The ID of the Reserved Instances.
reserved-instances-listing-id
- The ID of the Reserved
Instances listing.
status
- The status of
the Reserved Instance listing (pending
|
active
| cancelled
| closed
).
status-message
- The reason for the status.
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesListings
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesModificationIds
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
client-token
- The
idempotency token for the modification request.
create-date
- The time when the modification request
was created.
effective-date
- The time when
the modification becomes effective.
modification-result.reserved-instances-id
- The ID for
the Reserved Instances created as part of the modification request.
This ID is only available when the status of the modification is
fulfilled
.
modification-result.target-configuration.availability-zone
- The Availability Zone for the new Reserved Instances.
modification-result.target-configuration.instance-count
- The number of new Reserved Instances.
modification-result.target-configuration.instance-type
- The instance type of the new Reserved Instances.
modification-result.target-configuration.platform
-
The network platform of the new Reserved Instances
(EC2-Classic
| EC2-VPC
).
reserved-instances-id
- The ID of the Reserved
Instances modified.
reserved-instances-modification-id
- The ID of the
modification request.
status
- The status
of the Reserved Instances modification request
(processing
| fulfilled
|
failed
).
status-message
- The
reason for the status.
update-date
- The
time when the modification request was last updated.
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesModifications
java.lang.String nextToken
null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesOfferingIds
java.lang.String instanceType
m1.small
). For more information, see Instance
Types in the Amazon Elastic Compute Cloud User Guide.
Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.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)
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone
- The
Availability Zone where the Reserved Instance can be used.
duration
- The duration of the Reserved Instance (for
example, one year or three years), in seconds (31536000
|
94608000
).
fixed-price
- The
purchase price of the Reserved Instance (for example, 9800.0).
instance-type
- The instance type that is covered
by the reservation.
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 both AWS and the Reserved Instance
Marketplace are listed.
product-description
- The Reserved Instance product platform description. Instances that
include (Amazon VPC)
in the product platform description
will only be displayed to EC2-Classic account holders and are for use
with Amazon VPC. (Linux/UNIX
| Linux/UNIX (Amazon
VPC)
| SUSE Linux
| SUSE Linux (Amazon
VPC)
| Red Hat Enterprise Linux
| Red Hat
Enterprise Linux (Amazon VPC)
| Windows
|
Windows (Amazon VPC)
| Windows with SQL Server
Standard
| Windows with SQL Server Standard (Amazon
VPC)
| Windows with SQL Server Web
|
Windows with SQL Server Web (Amazon VPC)
| Windows with
SQL Server Enterprise
| Windows with SQL Server
Enterprise (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
is applied to
instances that run in a VPC on single-tenant hardware (i.e., Dedicated
Instances). Default: default
Constraints:
Allowed Values: default, dedicated, host
java.lang.String offeringType
Medium Utilization
Reserved Instance offering type.
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront
java.lang.String nextToken
java.lang.Integer maxResults
NextToken
value. The maximum is 100. Default: 100
java.lang.Boolean includeMarketplace
java.lang.Long minDuration
Default: 2592000 (1 month)
java.lang.Long maxDuration
Default: 94608000 (3 years)
java.lang.Integer maxInstanceCount
Default: 20
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesOfferings
java.lang.String nextToken
null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesIds
Default: Describes all your Reserved Instances, or only those otherwise specified.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone
- The
Availability Zone where the Reserved Instance can be used.
duration
- The duration of the Reserved Instance (one
year or three years), in seconds (31536000
|
94608000
).
end
- The time when
the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
fixed-price
- The purchase price of the
Reserved Instance (for example, 9800.0).
instance-type
- The instance type that is covered by
the reservation.
product-description
- The
Reserved Instance product platform description. Instances that include
(Amazon VPC)
in the product platform description will
only be displayed to EC2-Classic account holders and are for use with
Amazon VPC (Linux/UNIX
| Linux/UNIX (Amazon
VPC)
| SUSE Linux
| SUSE Linux (Amazon
VPC)
| Red Hat Enterprise Linux
| Red Hat
Enterprise Linux (Amazon VPC)
| Windows
|
Windows (Amazon VPC)
| Windows with SQL Server
Standard
| Windows with SQL Server Standard (Amazon
VPC)
| Windows with SQL Server Web
| Windows
with SQL Server Web (Amazon VPC)
| Windows with SQL
Server Enterprise
| Windows with SQL Server Enterprise
(Amazon VPC)
).
reserved-instances-id
- The ID of the Reserved Instance.
start
-
The time at which the Reserved Instance purchase request was placed
(for example, 2014-08-07T11:54:42.000Z).
state
- The state of the Reserved Instance
(payment-pending
| 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
Medium Utilization
Reserved Instance offering type.
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstances
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeTableIds
Default: Describes all your route tables.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
association.route-table-association-id
- The ID of an
association ID for the route table.
association.route-table-id
- The ID of the route table
involved in the association.
association.subnet-id
- The ID of the subnet involved
in the association.
association.main
-
Indicates whether the route table is the main route table for the VPC
(true
| false
).
route-table-id
- The ID of the route table.
route.destination-cidr-block
- The CIDR range
specified in a route in the table.
route.destination-prefix-list-id
- The ID (prefix) of
the AWS service 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.nat-gateway-id
- The ID of a NAT gateway.
route.origin
- Describes how the route was
created. CreateRouteTable
indicates that the route was
automatically created when the route table was created;
CreateRoute
indicates that the route was manually added
to the route table; EnableVgwRoutePropagation
indicates
that the route was propagated by route propagation.
route.state
- The state of a route in the route table
(active
| blackhole
). The blackhole state
indicates that the route's target isn't available (for example, the
specified gateway isn't attached to the VPC, the specified NAT
instance has been terminated, and so on).
route.vpc-peering-connection-id
- The ID of a VPC
peering connection specified in a route in the table.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id
- The ID of the VPC for the
route table.
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeTables
ScheduledInstanceRecurrenceRequest recurrence
SlotDateTimeRangeRequest firstSlotStartTimeRange
java.lang.Integer minSlotDurationInHours
java.lang.Integer maxSlotDurationInHours
MinSlotDurationInHours
and less than 1,720.java.lang.String nextToken
java.lang.Integer maxResults
NextToken
value.com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone
- The
Availability Zone (for example, us-west-2a
).
instance-type
- The instance type (for example,
c4.large
).
network-platform
-
The network platform (EC2-Classic
or
EC2-VPC
).
platform
- The
platform (Linux/UNIX
or Windows
).
java.lang.String nextToken
null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> scheduledInstanceAvailabilitySet
com.amazonaws.internal.ListWithAutoConstructFlag<T> scheduledInstanceIds
SlotStartTimeRangeRequest slotStartTimeRange
java.lang.String nextToken
java.lang.Integer maxResults
NextToken
value.com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone
- The
Availability Zone (for example, us-west-2a
).
instance-type
- The instance type (for example,
c4.large
).
network-platform
-
The network platform (EC2-Classic
or
EC2-VPC
).
platform
- The
platform (Linux/UNIX
or Windows
).
java.lang.String nextToken
null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> scheduledInstanceSet
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupId
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupReferenceSet
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
group-name
filter to describe security groups by name.
Default: Describes all your security groups.
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupIds
Default: Describes all your security groups.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
description
- The description of the security group.
egress.ip-permission.prefix-list-id
- The
ID (prefix) of the AWS service to which the security group allows
access.
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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
java.lang.String snapshotId
java.lang.String attribute
Constraints:
Allowed Values: productCodes, createVolumePermission
java.lang.String snapshotId
com.amazonaws.internal.ListWithAutoConstructFlag<T> createVolumePermissions
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotIds
Default: Describes snapshots for which you have launch permissions.
com.amazonaws.internal.ListWithAutoConstructFlag<T> ownerIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> restorableByUserIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
description
- A
description of the snapshot.
owner-alias
-
The AWS account alias (for example, amazon
) that owns the
snapshot.
owner-id
- The ID of the AWS
account that owns the snapshot.
progress
-
The progress of the snapshot, as a percentage (for example, 80%).
snapshot-id
- The snapshot ID.
start-time
- The time stamp when the snapshot was
initiated.
status
- The status of the
snapshot (pending
| completed
|
error
).
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
volume-id
- The ID of the volume
the snapshot is for.
volume-size
- The size
of the volume, in GiB.
java.lang.String nextToken
NextToken
value returned from a previous paginated
DescribeSnapshots
request where MaxResults
was used and the results exceeded the value of that parameter.
Pagination continues from the end of the previous results that
returned the NextToken
value. This value is
null
when there are no more results to return.java.lang.Integer maxResults
DescribeSnapshots
in paginated output. When this
parameter is used, DescribeSnapshots
only returns
MaxResults
results in a single page along with a
NextToken
response element. The remaining results of the
initial request can be seen by sending another
DescribeSnapshots
request with the returned
NextToken
value. This value can be between 5 and 1000; if
MaxResults
is given a value larger than 1000, only 1000
results are returned. If this parameter is not used, then
DescribeSnapshots
returns all results. You cannot specify
this parameter and the snapshot IDs parameter in the same request.com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshots
java.lang.String nextToken
NextToken
value to include in a future
DescribeSnapshots
request. When the results of a
DescribeSnapshots
request exceed MaxResults
,
this value can be used to retrieve the next page of results. This
value is null
when there are no more results to return.SpotDatafeedSubscription spotDatafeedSubscription
java.lang.String spotFleetRequestId
java.lang.String nextToken
java.lang.Integer maxResults
NextToken
value.java.lang.String spotFleetRequestId
com.amazonaws.internal.ListWithAutoConstructFlag<T> activeInstances
java.lang.String nextToken
null
when there are no more results to return.java.lang.String spotFleetRequestId
java.lang.String eventType
Constraints:
Allowed Values: instanceChange, fleetRequestChange, error
java.util.Date startTime
java.lang.String nextToken
java.lang.Integer maxResults
NextToken
value.java.lang.String spotFleetRequestId
java.util.Date startTime
java.util.Date lastEvaluatedTime
If nextToken
indicates that there are more results, this value is not present.
com.amazonaws.internal.ListWithAutoConstructFlag<T> historyRecords
java.lang.String nextToken
null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> spotFleetRequestIds
java.lang.String nextToken
java.lang.Integer maxResults
NextToken
value.com.amazonaws.internal.ListWithAutoConstructFlag<T> spotFleetRequestConfigs
java.lang.String nextToken
null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> spotInstanceRequestIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone-group
- The Availability Zone group.
create-time
- The time stamp when the Spot instance request was created.
fault-code
- The fault code related to the
request.
fault-message
- The fault message
related to the request.
instance-id
- The
ID of the instance that fulfilled the request.
launch-group
- The Spot instance launch group.
launch.block-device-mapping.delete-on-termination
- Indicates whether the Amazon EBS volume is deleted on instance
termination.
launch.block-device-mapping.device-name
- The device
name for the Amazon EBS volume (for example, /dev/sdh
).
launch.block-device-mapping.snapshot-id
-
The ID of the snapshot used for the Amazon EBS volume.
launch.block-device-mapping.volume-size
- The size of
the Amazon EBS volume, in GiB.
launch.block-device-mapping.volume-type
- The type of
the Amazon EBS volume: gp2
for General Purpose SSD,
io1
for Provisioned IOPS SSD, st1
for
Throughput Optimized HDD, sc1
for Cold HDD, or
standard
for Magnetic.
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, m3.medium
).
launch.kernel-id
- The kernel ID.
launch.key-name
- The name of the key pair the
instance launched with.
launch.monitoring-enabled
- Whether monitoring is
enabled for the Spot instance.
launch.ramdisk-id
- The RAM disk ID.
network-interface.network-interface-id
- The ID of the
network interface.
network-interface.device-index
- The index of the
device for the network interface attachment on the instance.
network-interface.subnet-id
- The ID of the
subnet for the instance.
network-interface.description
- A description of the
network interface.
network-interface.private-ip-address
- The primary
private IP address of the network interface.
network-interface.delete-on-termination
- Indicates
whether the network interface is deleted when the instance is
terminated.
network-interface.group-id
-
The ID of the security group associated with the network interface.
network-interface.group-name
- The name of
the security group associated with the network interface.
network-interface.addresses.primary
- Indicates
whether the IP address is the primary private IP address.
product-description
- The product description
associated with the instance (Linux/UNIX
|
Windows
).
spot-instance-request-id
- The Spot instance request
ID.
spot-price
- The maximum hourly price
for any Spot instance launched to fulfill the request.
state
- The state of the Spot instance request
(open
| active
| closed
|
cancelled
| failed
). Spot bid status
information can help you track your Amazon EC2 Spot instance requests.
For more information, see Spot
Bid Status in the Amazon Elastic Compute Cloud User Guide.
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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotInstanceRequests
java.util.Date startTime
java.util.Date endTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceTypes
com.amazonaws.internal.ListWithAutoConstructFlag<T> productDescriptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone
- The
Availability Zone for which prices should be returned.
instance-type
- The type of instance (for example,
m3.medium
).
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,
in UTC format (for example,
YYYY-MM-DDTHH:MM:SSZ). You
can use wildcards (* and ?). Greater than or less than comparison is
not supported.
java.lang.String availabilityZone
java.lang.Integer maxResults
NextToken
value.java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotPriceHistory
java.lang.String nextToken
null
when there are no more results to return.java.lang.String vpcId
java.lang.Integer maxResults
Constraints:
Range: 5 - 255
java.lang.String nextToken
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> staleSecurityGroupSet
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
Default: Describes all your subnets.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availabilityZone
- The
Availability Zone for the subnet. You can also use
availability-zone
as the filter name.
available-ip-address-count
- The number of IP
addresses in the subnet that are available.
cidrBlock
- The CIDR block of the subnet. The CIDR
block you specify must exactly match the subnet's CIDR block for
information to be returned for the subnet. You can also use
cidr
or cidr-block
as the filter names.
defaultForAz
- Indicates whether this is
the default subnet for the Availability Zone. You can also use
default-for-az
as the filter name.
state
- The state of the subnet (pending
| available
).
subnet-id
- The
ID of the subnet.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id
- The ID of the VPC for the
subnet.
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
key
- The tag key.
resource-id
- The resource ID.
resource-type
- The resource type
(customer-gateway
| dhcp-options
|
image
| instance
|
internet-gateway
| network-acl
|
network-interface
| reserved-instances
|
route-table
| security-group
|
snapshot
| spot-instances-request
|
subnet
| volume
| vpc
|
vpn-connection
| vpn-gateway
).
value
- The tag value.
java.lang.Integer maxResults
NextToken
value.java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String nextToken
null
when there are no more results to return..java.lang.String volumeId
java.lang.String attribute
Constraints:
Allowed Values: autoEnableIO, productCodes
java.lang.String volumeId
java.lang.Boolean autoEnableIO
autoEnableIO
attribute.com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
attachment.attach-time
- The time stamp when the attachment initiated.
attachment.delete-on-termination
- Whether the volume
is deleted on instance termination.
attachment.device
- The device name that is exposed to
the instance (for example, /dev/sda1
).
attachment.instance-id
- The ID of the instance the
volume is attached to.
attachment.status
-
The attachment state (attaching
| attached
|
detaching
| detached
).
availability-zone
- The Availability Zone in which the
volume was created.
create-time
- The time
stamp when the volume was created.
encrypted
- The encryption status of the volume.
size
- The size of the volume, in GiB.
snapshot-id
- The snapshot from which the volume was
created.
status
- The status of the volume
(creating
| available
| in-use
| deleting
| deleted
| error
).
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
volume-id
- The volume ID.
volume-type
- The Amazon EBS volume type. This
can be gp2
for General Purpose SSD, io1
for
Provisioned IOPS SSD, st1
for Throughput Optimized HDD,
sc1
for Cold HDD, or standard
for Magnetic
volumes.
java.lang.String nextToken
NextToken
value returned from a previous paginated
DescribeVolumes
request where MaxResults
was
used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the
NextToken
value. This value is null
when
there are no more results to return.java.lang.Integer maxResults
DescribeVolumes
in paginated output. When this parameter
is used, DescribeVolumes
only returns
MaxResults
results in a single page along with a
NextToken
response element. The remaining results of the
initial request can be seen by sending another
DescribeVolumes
request with the returned
NextToken
value. This value can be between 5 and 1000; if
MaxResults
is given a value larger than 1000, only 1000
results are returned. If this parameter is not used, then
DescribeVolumes
returns all results. You cannot specify
this parameter and the volume IDs parameter in the same request.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumes
java.lang.String nextToken
NextToken
value to include in a future
DescribeVolumes
request. When the results of a
DescribeVolumes
request exceed MaxResults
,
this value can be used to retrieve the next page of results. This
value is null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeIds
Default: Describes all your volumes.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
action.code
- The
action code for the event (for example,
enable-volume-io
).
action.description
- A description of the action.
action.event-id
- The event ID associated
with the action.
availability-zone
- The
Availability Zone of the instance.
event.description
- A description of the event.
event.event-id
- The event ID.
event.event-type
- The event type (for
io-enabled
: passed
| failed
;
for io-performance
: io-performance:degraded
| io-performance:severely-degraded
|
io-performance:stalled
).
event.not-after
- The latest end time for the event.
event.not-before
- The earliest start time
for the event.
volume-status.details-name
-
The cause for volume-status.status
(io-enabled
| io-performance
).
volume-status.details-status
- The status of
volume-status.details-name
(for io-enabled
:
passed
| failed
; for
io-performance
: normal
|
degraded
| severely-degraded
|
stalled
).
volume-status.status
- The status of the volume (ok
| impaired
|
warning
| insufficient-data
).
java.lang.String nextToken
NextToken
value to include in a future
DescribeVolumeStatus
request. When the results of the
request exceed MaxResults
, this value can be used to
retrieve the next page of results. This value is null
when there are no more results to return.java.lang.Integer maxResults
DescribeVolumeStatus
in paginated output. When this
parameter is used, the request only returns MaxResults
results in a single page along with a NextToken
response
element. The remaining results of the initial request can be seen by
sending another request with the returned NextToken
value. This value can be between 5 and 1000; if
MaxResults
is given a value larger than 1000, only 1000
results are returned. If this parameter is not used, then
DescribeVolumeStatus
returns all results. You cannot
specify this parameter and the volume IDs parameter in the same
request.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeStatuses
java.lang.String nextToken
null
when there are no more results to return.java.lang.String vpcId
java.lang.String attribute
Constraints:
Allowed Values: enableDnsSupport, enableDnsHostnames
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.com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcIds
java.lang.Integer maxResults
Constraints:
Range: 5 - 255
java.lang.String nextToken
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcs
java.lang.String nextToken
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
is-classic-link-enabled
- Whether the VPC is enabled for ClassicLink (true
|
false
).
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcs
java.lang.Integer maxResults
Constraint: If the value is greater than 1000, we return only 1000 items.
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> serviceNames
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcEndpointIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
service-name
: The name
of the AWS service.
vpc-id
: The ID of the
VPC in which the endpoint resides.
vpc-endpoint-id
: The ID of the endpoint.
vpc-endpoint-state
: The state of the endpoint.
(pending
| available
| deleting
| deleted
)
java.lang.Integer maxResults
Constraint: If the value is greater than 1000, we return only 1000 items.
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcEndpoints
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcPeeringConnectionIds
Default: Describes all your VPC peering connections.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
accepter-vpc-info.cidr-block
- The CIDR block of the
peer VPC.
accepter-vpc-info.owner-id
- The
AWS account ID of the owner of the peer VPC.
accepter-vpc-info.vpc-id
- The ID of the peer VPC.
expiration-time
- The expiration date and
time for the VPC peering connection.
requester-vpc-info.cidr-block
- The CIDR block of the
requester's VPC.
requester-vpc-info.owner-id
- The AWS account ID of
the owner of the requester VPC.
requester-vpc-info.vpc-id
- The ID of the requester
VPC.
status-code
- The status of the VPC
peering connection (pending-acceptance
|
failed
| expired
| provisioning
| active
| deleted
| rejected
).
status-message
- A message that provides
more information about the status of the VPC peering connection, if
applicable.
tag
:key=value -
The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the
resource. This filter is independent of the tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and
the filter "tag-value=X", you get any resources assigned both the tag
key Purpose (regardless of what the tag's value is), and the tag value
X (regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-peering-connection-id
- The ID
of the VPC peering connection.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcPeeringConnections
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcIds
Default: Describes all your VPCs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
cidr
- The CIDR block
of the VPC. The CIDR block you specify must exactly match the VPC's
CIDR block for information to be returned for the VPC. Must contain
the slash followed by one or two digits (for example,
/28
).
dhcp-options-id
- The ID
of a set of DHCP options.
isDefault
-
Indicates whether the VPC is the default VPC.
state
- The state of the VPC (pending
|
available
).
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id
- The ID of the VPC.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcs
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpnConnectionIds
Default: Describes your VPN connections.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
customer-gateway-configuration
- The configuration
information for the customer gateway.
customer-gateway-id
- The ID of a customer gateway
associated with the VPN connection.
state
-
The state of the VPN connection (pending
|
available
| deleting
|
deleted
).
option.static-routes-only
- Indicates whether the
connection has static routes only. Used for devices that do not
support Border Gateway Protocol (BGP).
route.destination-cidr-block
- The destination CIDR
block. This corresponds to the subnet used in a customer data center.
bgp-asn
- The BGP Autonomous System Number
(ASN) associated with a BGP device.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
type
- The type of VPN connection.
Currently the only supported type is ipsec.1
.
vpn-connection-id
- The ID of the VPN connection.
vpn-gateway-id
- The ID of a virtual
private gateway associated with the VPN connection.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpnConnections
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpnGatewayIds
Default: Describes all your virtual private gateways.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
attachment.state
- The
current state of the attachment between the gateway and the VPC
(attaching
| attached
|
detaching
| detached
).
attachment.vpc-id
- The ID of an attached VPC.
availability-zone
- The Availability Zone for the
virtual private gateway (if applicable).
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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpnGateways
java.lang.String instanceId
java.lang.String vpcId
java.lang.Boolean returnValue
true
if the request succeeds; otherwise, it
returns an error.java.lang.String internetGatewayId
java.lang.String vpcId
java.lang.String attachmentId
java.lang.Boolean force
java.lang.String volumeId
java.lang.String instanceId
java.lang.String device
java.lang.Boolean force
VolumeAttachment attachment
java.lang.String vpnGatewayId
java.lang.String vpcId
java.lang.String key
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
java.lang.String dhcpOptionsId
com.amazonaws.internal.ListWithAutoConstructFlag<T> dhcpConfigurations
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String routeTableId
java.lang.String gatewayId
java.lang.String vpcId
java.lang.Boolean returnValue
true
if the request succeeds; otherwise, it
returns an error.java.lang.String vpcId
java.lang.Boolean returnValue
true
if the request succeeds; otherwise, it
returns an error.java.lang.String publicIp
java.lang.String associationId
java.lang.String associationId
DiskImageDetail image
java.lang.String description
VolumeDetail volume
java.lang.String format
Constraints:
Allowed Values: VMDK, RAW, VHD
java.lang.Long size
java.lang.String importManifestUrl
For information about the import manifest referenced by this API action, see VM Import Manifest.
java.lang.String checksum
java.lang.String format
Constraints:
Allowed Values: VMDK, RAW, VHD
java.lang.Long bytes
java.lang.String importManifestUrl
For information about the import manifest referenced by this API action, see VM Import Manifest.
java.lang.Long size
java.lang.String id
java.lang.String snapshotId
java.lang.Integer volumeSize
Constraints: 1-16384 for General
Purpose SSD (gp2
), 4-16384 for Provisioned IOPS SSD
(io1
), 500-16384 for Throughput Optimized HDD
(st1
), 500-16384 for Cold HDD (sc1
), and
1-1024 for Magnetic (standard
) volumes. If you specify a
snapshot, the volume size must be equal to or larger than the snapshot
size.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
java.lang.Boolean deleteOnTermination
java.lang.String volumeType
gp2
, io1
, st1
,
sc1
, or standard
. Default:
standard
Constraints:
Allowed Values: standard, io1, gp2, sc1, st1
java.lang.Integer iops
gp2
, this represents the
baseline performance of the volume and the rate at which the volume
accumulates I/O credits for bursting. For more information on General
Purpose SSD baseline performance, I/O credits, and bursting, see Amazon
EBS Volume Types in the Amazon Elastic Compute Cloud User
Guide. Constraint: Range is 100-20000 IOPS for io1 volumes and
100-10000 IOPS for gp2
volumes.
Condition: This
parameter is required for requests to create
volumes; it is not used in requests to
create io1
gp2
, st1
, sc1
, or
standard
volumes.
java.lang.Boolean encrypted
java.lang.String volumeId
java.lang.String status
Constraints:
Allowed Values: attaching, attached, detaching, detached
java.util.Date attachTime
java.lang.Boolean deleteOnTermination
java.lang.String volumeId
java.lang.Boolean deleteOnTermination
java.lang.String routeTableId
java.lang.String gatewayId
java.lang.String volumeId
java.lang.String vpcId
java.lang.Boolean returnValue
true
if the request succeeds; otherwise, it
returns an error.java.lang.String vpcId
java.lang.Boolean returnValue
true
if the request succeeds; otherwise, it
returns an error.java.lang.String instanceId
instanceChange
events.java.lang.String eventSubType
The following are the error
events.
iamFleetRoleInvalid
- The Spot fleet did not have
the required permissions either to launch or terminate an instance.
launchSpecTemporarilyBlacklisted
- The
configuration is not valid and several attempts to launch instances
have failed. For more information, see the description of the event.
spotFleetRequestConfigurationInvalid
- The
configuration is not valid. For more information, see the description
of the event.
spotInstanceCountLimitExceeded
- You've reached the
limit on the number of Spot instances that you can launch.
The following are the fleetRequestChange
events.
active
- The Spot fleet has been validated and
Amazon EC2 is attempting to maintain the target number of running Spot
instances.
cancelled
- The Spot fleet is
canceled and has no running Spot instances. The Spot fleet will be
deleted two days after its instances were terminated.
cancelled_running
- The Spot fleet is canceled and
will not launch additional Spot instances, but its existing Spot
instances continue to run until they are interrupted or terminated.
cancelled_terminating
- The Spot fleet is
canceled and its Spot instances are terminating.
expired
- The Spot fleet request has expired. A
subsequent event indicates that the instances were terminated, if the
request was created with TerminateInstancesWithExpiration
set.
modify_in_progress
- A request to
modify the Spot fleet request was accepted and is in progress.
modify_successful
- The Spot fleet request was
modified.
price_update
- The bid price for
a launch configuration was adjusted because it was too high. This
change is permanent.
submitted
- The Spot
fleet request is being evaluated and Amazon EC2 is preparing to launch
the target number of Spot instances.
The following are
the instanceChange
events.
launched
- A bid was fulfilled and a new instance was
launched.
terminated
- An instance was
terminated by the user.
java.lang.String eventDescription
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
java.lang.String diskImageFormat
Constraints:
Allowed Values: VMDK, RAW, VHD
java.lang.String containerFormat
Constraints:
Allowed Values: ova
java.lang.String s3Bucket
vm-import-export@amazon.com
.java.lang.String s3Key
java.lang.String diskImageFormat
Constraints:
Allowed Values: VMDK, RAW, VHD
java.lang.String containerFormat
Constraints:
Allowed Values: ova
java.lang.String s3Bucket
vm-import-export@amazon.com
.java.lang.String s3Prefix
java.lang.String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
java.util.Date creationTime
java.lang.String flowLogId
java.lang.String flowLogStatus
ACTIVE
).java.lang.String resourceId
java.lang.String trafficType
Constraints:
Allowed Values: ACCEPT, REJECT, ALL
java.lang.String logGroupName
java.lang.String deliverLogsStatus
SUCCESS
|
FAILED
).java.lang.String deliverLogsErrorMessage
Rate limited
indicates that CloudWatch logs throttling has been applied for one or
more network interfaces, or that you've reached the limit on the
number of CloudWatch Logs log groups that you can create. Access
error
indicates that the IAM role associated with the flow log
does not have sufficient permissions to publish to CloudWatch Logs.
Unknown error
indicates an internal error.java.lang.String deliverLogsPermissionArn
java.lang.String instanceId
java.lang.String instanceId
java.util.Date timestamp
java.lang.String output
java.lang.String instanceId
java.lang.Boolean wakeUp
true
, acts as keystroke input and wakes up an
instance that's in standby or "sleep" mode.java.lang.String instanceId
java.lang.String imageData
java.lang.String instanceId
java.lang.String instanceId
java.util.Date timestamp
java.lang.String passwordData
java.lang.String groupName
java.lang.String groupId
java.util.Date timestamp
java.lang.String eventType
error
- Indicates an error
with the Spot fleet request.
fleetRequestChange
- Indicates a change in the status
or configuration of the Spot fleet request.
instanceChange
- Indicates that an instance was
launched or terminated.
Constraints:
Allowed Values: instanceChange, fleetRequestChange, error
EventInformation eventInformation
java.lang.String hostId
java.lang.String autoPlacement
Constraints:
Allowed Values: on, off
java.lang.String hostReservationId
null
response if the Dedicated host doesn't have an
associated reservation.java.lang.String clientToken
HostProperties hostProperties
java.lang.String state
Constraints:
Allowed Values: available, under-assessment, permanent-failure, released, released-permanent-failure
java.lang.String availabilityZone
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
AvailableCapacity availableCapacity
java.lang.String instanceId
java.lang.String instanceType
java.lang.Integer sockets
java.lang.Integer cores
java.lang.Integer totalVCpus
java.lang.String instanceType
java.lang.String arn
java.lang.String id
java.lang.String arn
java.lang.String name
java.lang.Integer type
java.lang.Integer code
java.lang.String resource
java.lang.Boolean useLongIds
java.util.Date deadline
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: pending, available, invalid, deregistered, transient, failed, error
java.lang.String ownerId
java.lang.String creationDate
java.lang.Boolean publicValue
true
if this image has public launch permissions or
false
if it has only implicit and explicit launch
permissions.com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
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
/dev/sda1
or /dev/xvda
).com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
java.lang.String virtualizationType
Constraints:
Allowed Values: hvm, paravirtual
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String hypervisor
Constraints:
Allowed Values: ovm, xen
java.lang.String imageId
com.amazonaws.internal.ListWithAutoConstructFlag<T> launchPermissions
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
java.lang.String kernelId
java.lang.String ramdiskId
java.lang.String description
java.lang.String sriovNetSupport
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
java.lang.String description
java.lang.String format
Valid values:
RAW
| VHD
| VMDK
|
OVA
java.lang.String url
UserBucket userBucket
java.lang.String deviceName
java.lang.String snapshotId
java.lang.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskContainers
java.lang.String licenseType
Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see VM Import/Export Prerequisites in the Amazon Elastic Compute Cloud User Guide.
Valid values: AWS
| BYOL
java.lang.String hypervisor
Valid values: xen
java.lang.String architecture
Valid values:
i386
| x86_64
java.lang.String platform
Valid values:
Windows
| Linux
ClientData clientData
java.lang.String clientToken
java.lang.String roleName
java.lang.String importTaskId
java.lang.String architecture
java.lang.String licenseType
java.lang.String platform
java.lang.String hypervisor
java.lang.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotDetails
java.lang.String imageId
java.lang.String progress
java.lang.String statusMessage
java.lang.String status
java.lang.String importTaskId
java.lang.String architecture
Valid values:
i386
| x86_64
java.lang.String licenseType
java.lang.String platform
java.lang.String hypervisor
Valid values:
xen
java.lang.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotDetails
java.lang.String imageId
java.lang.String progress
java.lang.String statusMessage
java.lang.String status
java.lang.String architecture
Constraints:
Allowed Values: i386, x86_64
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupIds
java.lang.String additionalInfo
UserData userData
java.lang.String instanceType
Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge
Placement placement
java.lang.Boolean monitoring
java.lang.String subnetId
java.lang.String instanceInitiatedShutdownBehavior
Constraints:
Allowed Values: stop, terminate
java.lang.String privateIpAddress
java.lang.String description
ImportInstanceLaunchSpecification launchSpecification
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskImages
java.lang.String platform
Constraints:
Allowed Values: Windows
ConversionTask conversionTask
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumes
java.lang.String instanceId
java.lang.String platform
Constraints:
Allowed Values: Windows
java.lang.String description
java.lang.Long bytesConverted
java.lang.String availabilityZone
DiskImageDescription image
DiskImageVolumeDescription volume
java.lang.String status
java.lang.String statusMessage
java.lang.String description
java.lang.String keyName
java.lang.String publicKeyMaterial
java.lang.String keyName
java.lang.String keyFingerprint
java.lang.String description
SnapshotDiskContainer diskContainer
ClientData clientData
java.lang.String clientToken
java.lang.String roleName
java.lang.String importTaskId
SnapshotTaskDetail snapshotTaskDetail
java.lang.String description
java.lang.String importTaskId
SnapshotTaskDetail snapshotTaskDetail
java.lang.String description
java.lang.String availabilityZone
DiskImageDetail image
java.lang.String description
VolumeDetail volume
ConversionTask conversionTask
java.lang.Long bytesConverted
java.lang.String availabilityZone
java.lang.String description
DiskImageDescription image
DiskImageVolumeDescription volume
java.lang.String instanceId
java.lang.String imageId
InstanceState state
java.lang.String privateDnsName
running
state. For EC2-VPC,
this name is only available if you've enabled DNS hostnames for your
VPC.java.lang.String publicDnsName
running
state.
For EC2-VPC, this name is only available if you've enabled DNS
hostnames for your VPC.java.lang.String stateTransitionReason
java.lang.String keyName
java.lang.Integer amiLaunchIndex
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
java.lang.String instanceType
Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.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
or
/dev/xvda
).com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
java.lang.String virtualizationType
Constraints:
Allowed Values: hvm, paravirtual
java.lang.String instanceLifecycle
Constraints:
Allowed Values: spot, scheduled
java.lang.String spotInstanceRequestId
java.lang.String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfile iamInstanceProfile
java.lang.Boolean ebsOptimized
java.lang.String sriovNetSupport
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
or
/dev/xvda
).com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
java.lang.Boolean ebsOptimized
java.lang.String sriovNetSupport
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.com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
java.lang.String deviceName
/dev/sdh
or xvdh
).EbsInstanceBlockDevice ebs
java.lang.String deviceName
/dev/sdh
or xvdh
).EbsInstanceBlockDeviceSpecification ebs
java.lang.String virtualName
java.lang.String noDevice
java.lang.String instanceType
java.lang.Integer availableCapacity
java.lang.Integer totalCapacity
java.lang.String state
Constraints:
Allowed Values: available, sold, cancelled, pending
java.lang.Integer instanceCount
state
.java.lang.String instanceId
java.lang.String targetEnvironment
Constraints:
Allowed Values: citrix, vmware, microsoft
java.lang.String instanceId
Monitoring monitoring
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 macAddress
java.lang.String privateIpAddress
java.lang.String privateDnsName
java.lang.Boolean sourceDestCheck
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
InstanceNetworkInterfaceAttachment attachment
InstanceNetworkInterfaceAssociation association
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
java.lang.String publicIp
java.lang.String publicDnsName
java.lang.String ipOwnerId
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
java.lang.String networkInterfaceId
java.lang.Integer deviceIndex
java.lang.String subnetId
java.lang.String description
java.lang.String privateIpAddress
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
java.lang.Boolean deleteOnTermination
true
, the interface is deleted when the
instance is terminated. You can specify true
only if
creating a new network interface when launching an instance.com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
java.lang.Integer secondaryPrivateIpAddressCount
java.lang.Boolean associatePublicIpAddress
true
.java.lang.String privateIpAddress
java.lang.String privateDnsName
java.lang.Boolean primary
InstanceNetworkInterfaceAssociation association
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
java.lang.String instanceId
InstanceState currentState
InstanceState previousState
java.lang.String instanceId
java.lang.String availabilityZone
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
InstanceState instanceState
running
state.InstanceStatusSummary systemStatus
InstanceStatusSummary instanceStatus
java.lang.String name
Constraints:
Allowed Values: reachability
java.lang.String status
Constraints:
Allowed Values: passed, failed, insufficient-data, initializing
java.util.Date impairedSince
java.lang.String code
Constraints:
Allowed Values: instance-reboot, system-reboot, system-maintenance, instance-retirement, instance-stop
java.lang.String description
After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].
java.util.Date notBefore
java.util.Date notAfter
java.lang.String status
Constraints:
Allowed Values: ok, impaired, insufficient-data, not-applicable, initializing
com.amazonaws.internal.ListWithAutoConstructFlag<T> details
java.lang.String internetGatewayId
com.amazonaws.internal.ListWithAutoConstructFlag<T> attachments
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String vpcId
java.lang.String state
Constraints:
Allowed Values: attaching, attached, detaching, detached
java.lang.String ipProtocol
tcp
, udp
, and
icmp
) or number (see Protocol
Numbers). [EC2-VPC only] When you authorize or revoke security
group rules, you can use -1
to specify all.
java.lang.Integer fromPort
-1
indicates all ICMP types.java.lang.Integer toPort
-1
indicates all ICMP codes for the specified
ICMP type.com.amazonaws.internal.ListWithAutoConstructFlag<T> userIdGroupPairs
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipRanges
com.amazonaws.internal.ListWithAutoConstructFlag<T> prefixListIds
java.lang.String keyName
java.lang.String keyFingerprint
java.lang.String keyMaterial
java.lang.String keyName
java.lang.String keyFingerprint
java.lang.String userId
java.lang.String group
Constraints:
Allowed Values: all
com.amazonaws.internal.ListWithAutoConstructFlag<T> add
com.amazonaws.internal.ListWithAutoConstructFlag<T> remove
java.lang.String imageId
java.lang.String keyName
com.amazonaws.internal.ListWithAutoConstructFlag<T> allSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
java.lang.String userData
java.lang.String addressingType
java.lang.String instanceType
Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge
SpotPlacement placement
java.lang.String kernelId
java.lang.String ramdiskId
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
Although you can specify encrypted EBS volumes in this block device mapping for your Spot Instances, these volumes are not encrypted.
java.lang.Boolean monitoringEnabled
Default: Disabled
java.lang.String subnetId
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfileSpecification iamInstanceProfile
java.lang.Boolean ebsOptimized
Default:
false
com.amazonaws.internal.ListWithAutoConstructFlag<T> hostIds
java.lang.String autoPlacement
Constraints:
Allowed Values: on, off
com.amazonaws.internal.ListWithAutoConstructFlag<T> successful
com.amazonaws.internal.ListWithAutoConstructFlag<T> unsuccessful
java.lang.String resource
java.lang.Boolean useLongIds
java.lang.String imageId
java.lang.String attribute
java.lang.String operationType
Constraints:
Allowed Values: add, remove
com.amazonaws.internal.ListWithAutoConstructFlag<T> userIds
launchPermission
attribute.com.amazonaws.internal.ListWithAutoConstructFlag<T> userGroups
launchPermission
attribute.com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
productCodes
attribute.java.lang.String value
description
attribute.LaunchPermissionModifications launchPermission
java.lang.String description
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
instanceInitiatedShutdownBehavior
attribute.com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
DeleteOnTermination
attribute for volumes
that are currently attached. The volume must be owned by the caller.
If no value is specified for DeleteOnTermination
, the
default is true
and the volume is deleted when the
instance is terminated. To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.
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
true
, you can't terminate the instance
using the Amazon EC2 console, CLI, or API; otherwise, you can. You
cannot use this paramater for Spot Instances.java.lang.String instanceType
InvalidInstanceAttributeValue
.java.lang.String kernel
java.lang.String ramdisk
java.lang.String userData
java.lang.String instanceInitiatedShutdownBehavior
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
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.
java.lang.String instanceId
java.lang.String tenancy
Constraints:
Allowed Values: dedicated, host
java.lang.String affinity
Constraints:
Allowed Values: default, host
java.lang.String hostId
java.lang.Boolean returnValue
true
if the request succeeds, and an error otherwise.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.com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
NetworkInterfaceAttachmentChanges attachment
java.lang.String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> targetConfigurations
java.lang.String reservedInstancesModificationId
java.lang.String snapshotId
java.lang.String attribute
Only volume creation permissions may be modified at the customer level.
Constraints:
Allowed Values: productCodes, createVolumePermission
java.lang.String operationType
Constraints:
Allowed Values: add, remove
com.amazonaws.internal.ListWithAutoConstructFlag<T> userIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
CreateVolumePermissionModifications createVolumePermission
java.lang.String spotFleetRequestId
java.lang.Integer targetCapacity
java.lang.String excessCapacityTerminationPolicy
Constraints:
Allowed Values: noTermination, default
java.lang.Boolean returnValue
true
if the request succeeds, and an error otherwise.java.lang.String subnetId
java.lang.Boolean mapPublicIpOnLaunch
true
to indicate that instances launched into the
specified subnet should be assigned public IP address.java.lang.String volumeId
java.lang.Boolean autoEnableIO
java.lang.String vpcId
java.lang.Boolean enableDnsSupport
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.
java.lang.Boolean enableDnsHostnames
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.
java.lang.String vpcEndpointId
java.lang.Boolean resetPolicy
true
to reset the policy document to the default
policy. The default policy allows access to the service.java.lang.String policyDocument
com.amazonaws.internal.ListWithAutoConstructFlag<T> addRouteTableIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> removeRouteTableIds
java.lang.Boolean returnValue
true
if the request succeeds; otherwise, it
returns an error.java.lang.String vpcPeeringConnectionId
PeeringConnectionOptionsRequest requesterPeeringConnectionOptions
PeeringConnectionOptionsRequest accepterPeeringConnectionOptions
PeeringConnectionOptions requesterPeeringConnectionOptions
PeeringConnectionOptions accepterPeeringConnectionOptions
java.lang.String state
Constraints:
Allowed Values: disabled, disabling, enabled, pending
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceMonitorings
java.lang.String publicIp
java.lang.String allocationId
java.lang.String status
Constraints:
Allowed Values: MoveInProgress, InVpc, InClassic
java.lang.String publicIp
java.lang.String moveStatus
Constraints:
Allowed Values: movingToVpc, restoringToClassic
java.lang.String vpcId
java.lang.String subnetId
java.lang.String natGatewayId
java.util.Date createTime
java.util.Date deleteTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> natGatewayAddresses
java.lang.String state
pending
: The
NAT gateway is being created and is not ready to process traffic.
failed
: The NAT gateway could not be
created. Check the failureCode
and
failureMessage
fields for the reason.
available
: The NAT gateway is able to process traffic.
This status remains until you delete the NAT gateway, and does not
indicate the health of the NAT gateway.
deleting
: The NAT gateway is in the process of being
terminated and may still be processing traffic.
deleted
: The NAT gateway has been terminated and is no
longer processing traffic.
Constraints:
Allowed Values: pending, failed, available, deleting, deleted
java.lang.String failureCode
InsufficientFreeAddressesInSubnet
|
Gateway.NotAttached
|
InvalidAllocationID.NotFound
|
Resource.AlreadyAssociated
| InternalError
|
InvalidSubnetID.NotFound
)java.lang.String failureMessage
For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"
For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"
For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"
For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"
For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."
For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."
ProvisionedBandwidth provisionedBandwidth
java.lang.String publicIp
java.lang.String allocationId
java.lang.String privateIp
java.lang.String networkInterfaceId
java.lang.String networkAclId
java.lang.String vpcId
java.lang.Boolean isDefault
com.amazonaws.internal.ListWithAutoConstructFlag<T> entries
com.amazonaws.internal.ListWithAutoConstructFlag<T> associations
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String networkAclAssociationId
java.lang.String networkAclId
java.lang.String subnetId
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
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
NetworkInterfaceAttachment attachment
NetworkInterfaceAssociation association
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagSet
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
java.lang.String interfaceType
Constraints:
Allowed Values: interface, natGateway
java.lang.String publicIp
java.lang.String publicDnsName
java.lang.String ipOwnerId
java.lang.String allocationId
java.lang.String associationId
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
java.lang.String attachmentId
java.lang.Boolean deleteOnTermination
java.lang.String privateIpAddress
java.lang.String privateDnsName
java.lang.Boolean primary
NetworkInterfaceAssociation association
java.lang.Boolean allowEgressFromLocalClassicLinkToRemoteVpc
java.lang.Boolean allowEgressFromLocalVpcToRemoteClassicLink
java.lang.Boolean allowEgressFromLocalClassicLinkToRemoteVpc
java.lang.Boolean allowEgressFromLocalVpcToRemoteClassicLink
java.lang.String availabilityZone
java.lang.String groupName
java.lang.String tenancy
dedicated
runs on
single-tenant hardware. The host
tenancy is not supported
for the ImportInstance command.
Constraints:
Allowed Values: default, dedicated, host
java.lang.String hostId
java.lang.String affinity
java.lang.String groupName
java.lang.String strategy
Constraints:
Allowed Values: cluster
java.lang.String state
Constraints:
Allowed Values: pending, available, deleting, deleted
java.lang.Integer from
java.lang.Integer to
java.lang.String prefixListId
java.lang.String prefixListName
com.amazonaws.internal.ListWithAutoConstructFlag<T> cidrs
java.lang.String prefixListId
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.
java.lang.Long term
java.lang.Double price
java.lang.String currencyCode
USD
.
Constraints:
Allowed Values: USD
java.lang.Double price
java.lang.Integer count
java.lang.String privateIpAddress
java.lang.Boolean primary
java.lang.String productCodeId
java.lang.String productCodeType
Constraints:
Allowed Values: devpay, marketplace
java.lang.String gatewayId
java.lang.String provisioned
java.lang.String requested
java.util.Date requestTime
java.util.Date provisionTime
java.lang.String status
java.lang.String purchaseToken
java.lang.Integer instanceCount
java.lang.String reservedInstancesOfferingId
java.lang.Integer instanceCount
ReservedInstanceLimitPrice limitPrice
java.lang.String reservedInstancesId
java.lang.String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> purchaseRequests
Constraints:
Length: 1 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> scheduledInstanceSet
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
java.lang.String frequency
Constraints:
Allowed Values: Hourly
java.lang.Double amount
java.lang.String regionName
java.lang.String endpoint
java.lang.String imageLocation
java.lang.String name
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), 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
/dev/xvda
).com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
java.lang.String imageId
java.lang.String vpcPeeringConnectionId
java.lang.Boolean returnValue
true
if the request succeeds; otherwise, it
returns an error.java.lang.String publicIp
java.lang.String allocationId
com.amazonaws.internal.ListWithAutoConstructFlag<T> hostIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> successful
com.amazonaws.internal.ListWithAutoConstructFlag<T> unsuccessful
java.lang.String associationId
java.lang.String networkAclId
java.lang.String newAssociationId
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
java.lang.String routeTableId
java.lang.String destinationCidrBlock
java.lang.String gatewayId
java.lang.String instanceId
java.lang.String networkInterfaceId
java.lang.String vpcPeeringConnectionId
java.lang.String natGatewayId
java.lang.String associationId
java.lang.String routeTableId
java.lang.String newAssociationId
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
java.lang.String status
Constraints:
Allowed Values: ok, impaired
java.util.Date startTime
java.util.Date endTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> reasonCodes
instance-stuck-in-state
: My
instance is stuck in a state.
unresponsive
:
My instance is unresponsive.
not-accepting-credentials
: My instance is not
accepting my credentials.
password-not-available
: A password is not available
for my instance.
performance-network
: My
instance is experiencing performance problems which I believe are
network related.
performance-instance-store
: My instance is
experiencing performance problems which I believe are related to the
instance stores.
performance-ebs-volume
: My
instance is experiencing performance problems which I believe are
related to an EBS volume.
performance-other
: My instance is experiencing
performance problems.
other
: [explain using
the description parameter]
java.lang.String description
SpotFleetRequestConfigData spotFleetRequestConfig
java.lang.String spotFleetRequestId
java.lang.String spotPrice
java.lang.String clientToken
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.
java.lang.Integer blockDurationMinutes
The duration period starts as soon as your Spot instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.
Note that you can't specify an Availability Zone group or a launch group if you specify a duration.
LaunchSpecification launchSpecification
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotInstanceRequests
java.lang.String reservationId
java.lang.String ownerId
java.lang.String requesterId
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
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
java.lang.String reservedInstancesId
java.lang.String instanceType
Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.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
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String instanceTenancy
Constraints:
Allowed Values: default, dedicated, host
java.lang.String currencyCode
USD
.
Constraints:
Allowed Values: USD
java.lang.String offeringType
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
java.lang.String availabilityZone
java.lang.String platform
java.lang.Integer instanceCount
java.lang.String instanceType
Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge
java.lang.String reservedInstancesId
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceCounts
com.amazonaws.internal.ListWithAutoConstructFlag<T> priceSchedules
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String clientToken
java.lang.String reservedInstancesModificationId
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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
java.lang.String reservedInstancesId
ReservedInstancesConfiguration targetConfiguration
java.lang.String reservedInstancesOfferingId
java.lang.String instanceType
Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.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, host
java.lang.String currencyCode
USD
.
Constraints:
Allowed Values: USD
java.lang.String offeringType
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
java.lang.Boolean marketplace
true
.com.amazonaws.internal.ListWithAutoConstructFlag<T> pricingDetails
java.lang.String imageId
java.lang.String attribute
Constraints:
Allowed Values: launchPermission
java.lang.String instanceId
java.lang.String attribute
You can only reset the following
attributes: kernel
| ramdisk
|
sourceDestCheck
. To change an instance attribute, use
ModifyInstanceAttribute.
Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport
java.lang.String networkInterfaceId
java.lang.String sourceDestCheck
true
.java.lang.String snapshotId
java.lang.String attribute
Constraints:
Allowed Values: productCodes, createVolumePermission
java.lang.String publicIp
java.lang.String status
Constraints:
Allowed Values: MoveInProgress, InVpc, InClassic
java.lang.String publicIp
java.lang.String groupId
java.lang.String sourceSecurityGroupName
java.lang.String sourceSecurityGroupOwnerId
java.lang.String ipProtocol
java.lang.Integer fromPort
java.lang.Integer toPort
java.lang.String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
java.lang.String groupName
java.lang.String groupId
java.lang.String sourceSecurityGroupName
java.lang.String sourceSecurityGroupOwnerId
java.lang.String ipProtocol
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
java.lang.String destinationCidrBlock
java.lang.String destinationPrefixListId
java.lang.String gatewayId
java.lang.String instanceId
java.lang.String instanceOwnerId
java.lang.String networkInterfaceId
java.lang.String vpcPeeringConnectionId
java.lang.String natGatewayId
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
- The route was automatically
created when the route table was created.
CreateRoute
- The route was manually added to the
route table.
EnableVgwRoutePropagation
- The
route was propagated by route propagation.
Constraints:
Allowed Values: CreateRouteTable, CreateRoute, EnableVgwRoutePropagation
java.lang.String routeTableId
java.lang.String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> routes
com.amazonaws.internal.ListWithAutoConstructFlag<T> associations
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> propagatingVgws
java.lang.String routeTableAssociationId
java.lang.String routeTableId
java.lang.String subnetId
java.lang.Boolean main
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 FAQ.
java.lang.String keyName
If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
Default: Amazon EC2 uses the default security group.
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
Default: Amazon EC2 uses the default security group.
java.lang.String userData
java.lang.String instanceType
Default: m1.small
Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.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 in the Amazon Elastic Compute Cloud User Guide.
java.lang.String ramdiskId
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfileSpecification iamInstanceProfile
java.lang.Boolean ebsOptimized
Default:
false
Reservation reservation
java.lang.String clientToken
java.lang.Integer instanceCount
Default: 1
java.lang.String scheduledInstanceId
ScheduledInstancesLaunchSpecification launchSpecification
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIdSet
java.lang.String bucket
java.lang.String prefix
java.lang.String aWSAccessKeyId
java.lang.String uploadPolicy
java.lang.String uploadPolicySignature
java.lang.String scheduledInstanceId
java.lang.String instanceType
java.lang.String platform
Linux/UNIX
or Windows
).java.lang.String networkPlatform
EC2-Classic
or
EC2-VPC
).java.lang.String availabilityZone
java.lang.Integer slotDurationInHours
ScheduledInstanceRecurrence recurrence
java.util.Date previousSlotEndTime
java.util.Date nextSlotStartTime
java.lang.String hourlyPrice
java.lang.Integer totalScheduledInstanceHours
java.lang.Integer instanceCount
java.util.Date termStartDate
java.util.Date termEndDate
java.util.Date createDate
java.lang.String instanceType
java.lang.String platform
Linux/UNIX
or Windows
).java.lang.String networkPlatform
EC2-Classic
or
EC2-VPC
).java.lang.String availabilityZone
java.lang.String purchaseToken
java.lang.Integer slotDurationInHours
ScheduledInstanceRecurrence recurrence
java.util.Date firstSlotStartTime
java.lang.String hourlyPrice
java.lang.Integer totalScheduledInstanceHours
java.lang.Integer availableInstanceCount
java.lang.Integer minTermDurationInDays
java.lang.Integer maxTermDurationInDays
java.lang.String frequency
Daily
, Weekly
, or
Monthly
).java.lang.Integer interval
frequency
. For example, every 2 weeks or every 2 months.com.amazonaws.internal.ListWithAutoConstructFlag<T> occurrenceDaySet
java.lang.Boolean occurrenceRelativeToEnd
java.lang.String occurrenceUnit
occurrenceDaySet
(DayOfWeek
or
DayOfMonth
).java.lang.String frequency
Daily
, Weekly
, or
Monthly
).java.lang.Integer interval
Frequency
. For example, every 2 weeks or every 2 months.com.amazonaws.internal.ListWithAutoConstructFlag<T> occurrenceDays
java.lang.Boolean occurrenceRelativeToEnd
java.lang.String occurrenceUnit
OccurrenceDays
(DayOfWeek
or
DayOfMonth
). This value is required for a monthly
schedule. You can't specify DayOfWeek
with a weekly
schedule. You can't specify this value with a daily schedule.java.lang.String deviceName
/dev/sdh
or xvdh
).java.lang.String noDevice
java.lang.String virtualName
ephemeral
N). Instance store
volumes are numbered starting from 0. An instance type with two
available instance store volumes can specify mappings for
ephemeral0
and ephemeral1
.The number of
available instance store volumes depends on the instance type. After
you connect to the instance, you must mount the volume.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
ScheduledInstancesEbs ebs
java.lang.String snapshotId
java.lang.Integer volumeSize
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
gp2
for General Purpose SSD,
io1
for Provisioned IOPS SSD, Throughput Optimized HDD
for st1
, Cold HDD for sc1
, or
standard
for Magnetic. Default: standard
java.lang.Integer iops
gp2
volumes, this
represents the baseline performance of the volume and the rate at
which the volume accumulates I/O credits for bursting. For more
information about gp2
baseline performance, I/O credits,
and bursting, see Amazon
EBS Volume Types in the Amazon Elastic Compute Cloud User
Guide. Constraint: Range is 100-20000 IOPS for io1
volumes and 100-10000 IOPS for gp2
volumes.
Condition:
This parameter is required for requests to create
io1
volumes; it is not used in requests to create
gp2
, st1
, sc1
, or
standard
volumes.
java.lang.Boolean encrypted
java.lang.String arn
java.lang.String name
java.lang.String imageId
java.lang.String keyName
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
java.lang.String userData
ScheduledInstancesPlacement placement
java.lang.String kernelId
java.lang.String instanceType
java.lang.String ramdiskId
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
ScheduledInstancesMonitoring monitoring
java.lang.String subnetId
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
ScheduledInstancesIamInstanceProfile iamInstanceProfile
java.lang.Boolean ebsOptimized
Default:
false
java.lang.Boolean enabled
java.lang.String networkInterfaceId
java.lang.Integer deviceIndex
java.lang.String subnetId
java.lang.String description
java.lang.String privateIpAddress
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddressConfigs
java.lang.Integer secondaryPrivateIpAddressCount
java.lang.Boolean associatePublicIpAddress
true
.com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
java.lang.Boolean deleteOnTermination
java.lang.String availabilityZone
java.lang.String groupName
java.lang.String privateIpAddress
java.lang.Boolean primary
java.lang.String ownerId
java.lang.String groupName
java.lang.String groupId
java.lang.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissionsEgress
java.lang.String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String groupId
java.lang.String referencingVpcId
java.lang.String vpcPeeringConnectionId
java.util.Date earliestTime
java.util.Date latestTime
java.util.Date earliestTime
java.util.Date latestTime
java.lang.String snapshotId
java.lang.String volumeId
java.lang.String state
Constraints:
Allowed Values: pending, completed, error
java.lang.String stateMessage
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.com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.Boolean encrypted
java.lang.String kmsKeyId
java.lang.String dataEncryptionKeyId
java.lang.Double diskImageSize
java.lang.String description
java.lang.String format
java.lang.String url
UserBucketDetails userBucket
java.lang.String deviceName
java.lang.String snapshotId
java.lang.String progress
java.lang.String statusMessage
java.lang.String status
java.lang.String description
java.lang.String format
Valid values:
RAW
| VHD
| VMDK
|
OVA
java.lang.String url
UserBucket userBucket
java.lang.Double diskImageSize
java.lang.String description
java.lang.String format
java.lang.String url
UserBucketDetails userBucket
java.lang.String snapshotId
java.lang.String progress
java.lang.String statusMessage
java.lang.String status
java.lang.String ownerId
java.lang.String bucket
java.lang.String prefix
java.lang.String state
Constraints:
Allowed Values: Active, Inactive
SpotInstanceStateFault fault
java.lang.String imageId
java.lang.String keyName
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
java.lang.String userData
java.lang.String addressingType
java.lang.String instanceType
Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge
SpotPlacement placement
java.lang.String kernelId
java.lang.String ramdiskId
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
SpotFleetMonitoring monitoring
java.lang.String subnetId
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfileSpecification iamInstanceProfile
java.lang.Boolean ebsOptimized
Default:
false
java.lang.Double weightedCapacity
If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1.
java.lang.String spotPrice
WeightedCapacity
.java.lang.Boolean enabled
Default: false
java.lang.String spotFleetRequestId
java.lang.String spotFleetRequestState
Constraints:
Allowed Values: submitted, active, cancelled, failed, cancelled_running, cancelled_terminating, modifying
SpotFleetRequestConfigData spotFleetRequestConfig
java.util.Date createTime
java.lang.String clientToken
java.lang.String spotPrice
java.lang.Integer targetCapacity
java.util.Date validFrom
java.util.Date validUntil
java.lang.Boolean terminateInstancesWithExpiration
java.lang.String iamFleetRole
terminateInstancesWithExpiration
.com.amazonaws.internal.ListWithAutoConstructFlag<T> launchSpecifications
Constraints:
Length: 1 -
java.lang.String excessCapacityTerminationPolicy
Constraints:
Allowed Values: noTermination, default
java.lang.String allocationStrategy
lowestPrice
.
Constraints:
Allowed Values: lowestPrice, diversified
java.lang.Double fulfilledCapacity
java.lang.String type
request
the target capacity or also attempt to
maintain
it. When you request
a certain
target capacity, the fleet will only place the required bids. It will
not attempt to replenish Spot instances if capacity is diminished, nor
will it submit bids in alternative Spot pools if capacity is not
available. When you want to maintain
a certain target
capacity, fleet will place the required bids to meet this target
capacity. It will also automatically replenish any interrupted
instances. Default: maintain
.
Constraints:
Allowed Values: request, maintain
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)
java.lang.Integer blockDurationMinutes
java.lang.String actualBlockHourlyPrice
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String launchedAvailabilityZone
java.lang.String code
java.lang.String message
java.lang.String code
java.util.Date updateTime
java.lang.String message
java.lang.String availabilityZone
[Spot fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
java.lang.String groupName
java.lang.String instanceType
Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.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
java.lang.Integer fromPort
-1
indicates all ICMP types.java.lang.String ipProtocol
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipRanges
com.amazonaws.internal.ListWithAutoConstructFlag<T> prefixListIds
java.lang.Integer toPort
-1
indicates all ICMP types.com.amazonaws.internal.ListWithAutoConstructFlag<T> userIdGroupPairs
java.lang.String groupId
java.lang.String groupName
java.lang.String description
java.lang.String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> staleIpPermissions
com.amazonaws.internal.ListWithAutoConstructFlag<T> staleIpPermissionsEgress
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
java.lang.String additionalInfo
com.amazonaws.internal.ListWithAutoConstructFlag<T> startingInstances
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 limit on the
number of EBS volumes or total storage was exceeded. Decrease usage or
request an increase in your limits.
Client.InvalidSnapshot.NotFound
: The specified
snapshot was not found.
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
java.lang.Boolean force
Default:
false
com.amazonaws.internal.ListWithAutoConstructFlag<T> stoppingInstances
S3Storage s3
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
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.
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> terminatingInstances
java.lang.String networkInterfaceId
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceMonitorings
java.lang.String resourceId
UnsuccessfulItemError error
java.lang.String code
java.lang.String message
java.lang.String s3Bucket
java.lang.String s3Key
java.lang.String s3Bucket
java.lang.String s3Key
java.lang.String data
java.lang.String userId
[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS account.
java.lang.String groupName
java.lang.String groupId
java.lang.String vpcId
java.lang.String vpcPeeringConnectionId
java.lang.String peeringStatus
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
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> attachments
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String volumeType
gp2
for General Purpose SSD,
io1
for Provisioned IOPS SSD, st1
for
Throughput Optimized HDD, sc1
for Cold HDD, or
standard
for Magnetic volumes.
Constraints:
Allowed Values: standard, io1, gp2, sc1, st1
java.lang.Integer iops
Constraint: Range is 100-20000 IOPS for io1 volumes and
100-10000 IOPS for gp2
volumes.
Condition: This
parameter is required for requests to create io1
volumes;
it is not used in requests to create gp2
,
st1
, sc1
, or standard
volumes.
java.lang.Boolean encrypted
java.lang.String kmsKeyId
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
java.lang.Long size
java.lang.String code
enable-volume-io
.java.lang.String description
java.lang.String eventType
java.lang.String eventId
java.lang.String name
Constraints:
Allowed Values: io-enabled, io-performance
java.lang.String status
java.lang.String eventType
java.lang.String description
java.util.Date notBefore
java.util.Date notAfter
java.lang.String eventId
java.lang.String status
Constraints:
Allowed Values: ok, impaired, insufficient-data
com.amazonaws.internal.ListWithAutoConstructFlag<T> details
java.lang.String volumeId
java.lang.String availabilityZone
VolumeStatusInfo volumeStatus
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
com.amazonaws.internal.ListWithAutoConstructFlag<T> actions
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).com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String instanceTenancy
Constraints:
Allowed Values: default, dedicated, host
java.lang.Boolean isDefault
java.lang.String vpcId
java.lang.String state
Constraints:
Allowed Values: attaching, attached, detaching, detached
java.lang.String vpcId
java.lang.Boolean classicLinkEnabled
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String vpcEndpointId
java.lang.String vpcId
java.lang.String serviceName
java.lang.String state
Constraints:
Allowed Values: Pending, Available, Deleting, Deleted
java.lang.String policyDocument
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeTableIds
java.util.Date creationTimestamp
VpcPeeringConnectionVpcInfo accepterVpcInfo
initiating-request
or pending-acceptance
state.java.util.Date expirationTime
VpcPeeringConnectionVpcInfo requesterVpcInfo
VpcPeeringConnectionStateReason status
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String vpcPeeringConnectionId
java.lang.Boolean allowEgressFromLocalClassicLinkToRemoteVpc
java.lang.Boolean allowEgressFromLocalVpcToRemoteClassicLink
java.lang.String code
Constraints:
Allowed Values: initiating-request, pending-acceptance, active, deleted, rejected, failed, expired, provisioning, deleting
java.lang.String message
java.lang.String cidrBlock
java.lang.String ownerId
java.lang.String vpcId
VpcPeeringConnectionOptionsDescription peeringOptions
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> vgwTelemetry
VpnConnectionOptions options
com.amazonaws.internal.ListWithAutoConstructFlag<T> routes
java.lang.Boolean staticRoutesOnly
java.lang.Boolean staticRoutesOnly
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcAttachments
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String destinationCidrBlock
java.lang.String source
Constraints:
Allowed Values: Static
java.lang.String state
Constraints:
Allowed Values: pending, available, deleting, deleted
java.lang.Boolean enabled
Specifies whether access log is enabled for the load balancer.
java.lang.String s3BucketName
The name of the Amazon S3 bucket where the access logs are stored.
java.lang.Integer emitInterval
The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.
Default: 60 minutes
java.lang.String s3BucketPrefix
The logical hierarchy you created for your Amazon S3 bucket, for example
my-bucket-prefix/prod
. If the prefix is not provided, the
log is placed at the root level of the bucket.
java.lang.String key
This parameter is reserved.
java.lang.String value
This parameter is reserved.
java.util.List<E> loadBalancerNames
The name of the load balancer. You can specify one load balancer only.
java.util.List<E> tags
The tags.
java.lang.String policyName
The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.
java.lang.String cookieName
The name of the application cookie used for stickiness.
java.lang.String loadBalancerName
The name of the load balancer.
java.util.List<E> securityGroups
The IDs of the security groups to associate with the load balancer. Note that you cannot specify the name of the security group.
java.util.List<E> securityGroups
The IDs of the security groups associated with the load balancer.
java.lang.String loadBalancerName
The name of the load balancer.
java.util.List<E> subnets
The IDs of the subnets to add for the load balancer. You can add only one subnet per Availability Zone.
java.util.List<E> subnets
The IDs of the subnets attached to the load balancer.
java.lang.Integer instancePort
The port on which the back-end server is listening.
Constraints:
Range: 1 - 65535
java.util.List<E> policyNames
The names of the policies enabled for the back-end server.
java.lang.String loadBalancerName
The name of the load balancer.
HealthCheck healthCheck
The configuration information for the new health check.
HealthCheck healthCheck
The updated health check.
java.lang.Boolean enabled
Specifies whether connection draining is enabled for the load balancer.
java.lang.Integer timeout
The maximum time, in seconds, to keep the existing connections open before deregistering the instances.
java.lang.Integer idleTimeout
The time, in seconds, that the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.
Constraints:
Range: 1 - 3600
java.lang.String loadBalancerName
The name of the load balancer.
java.lang.String policyName
The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer.
java.lang.String cookieName
The name of the application cookie used for stickiness.
java.lang.String loadBalancerName
The name of the load balancer.
java.lang.String policyName
The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer.
java.lang.Long cookieExpirationPeriod
The time period, in seconds, after which the cookie should be considered stale. If you do not specify this parameter, the sticky session lasts for the duration of the browser session.
java.lang.String loadBalancerName
The name of the load balancer.
java.util.List<E> listeners
The listeners.
java.lang.String loadBalancerName
The name of the load balancer.
java.lang.String policyName
The name of the load balancer policy to be created. This name must be unique within the set of policies for this load balancer.
java.lang.String policyTypeName
The name of the base policy type. To get the list of policy types, use DescribeLoadBalancerPolicyTypes.
java.util.List<E> policyAttributes
The attributes for the policy.
java.lang.String loadBalancerName
The name of the load balancer.
This name must be unique within your set of load balancers for the region, must have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and cannot begin or end with a hyphen.
java.util.List<E> listeners
The listeners.
For more information, see Listeners for Your Load Balancer in the Elastic Load Balancing Developer Guide.
java.util.List<E> availabilityZones
One or more Availability Zones from the same region as the load balancer. Traffic is equally distributed across all specified Availability Zones.
You must specify at least one Availability Zone.
You can add more Availability Zones after you create the load balancer using EnableAvailabilityZonesForLoadBalancer.
java.util.List<E> subnets
The IDs of the subnets in your VPC to attach to the load balancer.
Specify one subnet per Availability Zone specified in
AvailabilityZones
.
java.util.List<E> securityGroups
The IDs of the security groups to assign to the load balancer.
java.lang.String scheme
The type of a load balancer. Valid only for load balancers in a VPC.
By default, Elastic Load Balancing creates an Internet-facing load balancer with a publicly resolvable DNS name, which resolves to public IP addresses. For more information about Internet-facing and Internal load balancers, see Internet-facing and Internal Load Balancers in the Elastic Load Balancing Developer Guide.
Specify internal
to create an internal load balancer with a
DNS name that resolves to private IP addresses.
java.util.List<E> tags
A list of tags to assign to the load balancer.
For more information about tagging your load balancer, see Tagging in the Elastic Load Balancing Developer Guide.
java.lang.String dNSName
The DNS name of the load balancer.
java.lang.Boolean enabled
Specifies whether cross-zone load balancing is enabled for the load balancer.
java.lang.String loadBalancerName
The name of the load balancer.
java.util.List<E> loadBalancerPorts
The client port numbers of the listeners.
java.lang.String loadBalancerName
The name of the load balancer.
java.lang.String policyName
The name of the policy.
java.lang.String loadBalancerName
The name of the load balancer.
java.lang.String loadBalancerName
The name of the load balancer.
java.util.List<E> instances
The IDs of the instances.
java.util.List<E> instances
The remaining instances registered with the load balancer.
java.lang.String loadBalancerName
The name of the load balancer.
java.util.List<E> instances
The IDs of the instances.
java.util.List<E> instanceStates
Information about the health of the instances.
java.lang.String loadBalancerName
The name of the load balancer.
LoadBalancerAttributes loadBalancerAttributes
Information about the load balancer attributes.
java.lang.String loadBalancerName
The name of the load balancer.
java.util.List<E> policyNames
The names of the policies.
java.util.List<E> policyDescriptions
Information about the policies.
java.util.List<E> policyTypeNames
The names of the policy types. If no names are specified, describes all policy types defined by Elastic Load Balancing.
java.util.List<E> policyTypeDescriptions
Information about the policy types.
java.util.List<E> loadBalancerNames
The names of the load balancers.
java.lang.String marker
The marker for the next set of results. (You received this marker from a previous call.)
java.lang.Integer pageSize
The maximum number of results to return with this call (a number from 1 to 400). The default is 400.
Constraints:
Range: 1 - 400
java.util.List<E> loadBalancerDescriptions
Information about the load balancers.
java.lang.String nextMarker
The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
java.util.List<E> loadBalancerNames
The names of the load balancers.
java.util.List<E> tagDescriptions
Information about the tags.
java.lang.String loadBalancerName
The name of the load balancer.
java.util.List<E> subnets
The IDs of the subnets.
java.util.List<E> subnets
The IDs of the remaining subnets for the load balancer.
java.lang.String loadBalancerName
The name of the load balancer.
java.util.List<E> availabilityZones
The Availability Zones.
java.util.List<E> availabilityZones
The remaining Availability Zones for the load balancer.
java.lang.String loadBalancerName
The name of the load balancer.
java.util.List<E> availabilityZones
The Availability Zones. These must be in the same region as the load balancer.
java.util.List<E> availabilityZones
The updated list of Availability Zones for the load balancer.
java.lang.String target
The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.
TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check 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/HTTPS, you must 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 must be 1024 16-bit Unicode characters or less.
java.lang.Integer interval
The approximate interval, in seconds, between health checks of an individual instance.
Constraints:
Range: 1 - 300
java.lang.Integer timeout
The amount of time, in seconds, during which no response means a failed health check.
This value must be less than the Interval
value.
Constraints:
Range: 1 - 300
java.lang.Integer unhealthyThreshold
The number of consecutive health check failures required before moving
the instance to the Unhealthy
state.
Constraints:
Range: 2 - 10
java.lang.Integer healthyThreshold
The number of consecutive health checks successes required before moving
the instance to the Healthy
state.
Constraints:
Range: 2 - 10
java.lang.String instanceId
The ID of the instance.
java.lang.String instanceId
The ID of the instance.
java.lang.String state
The current state of the instance.
Valid values: InService
| OutOfService
|
Unknown
java.lang.String reasonCode
Information about the cause of OutOfService
instances.
Specifically, whether the cause is Elastic Load Balancing or the
instance.
Valid values: ELB
| Instance
| N/A
java.lang.String description
A description of the instance state. This string can contain one or more of the following messages.
N/A
A transient error occurred. Please try again later.
Instance has failed at least the UnhealthyThreshold number of health checks consecutively.
Instance has not passed the configured HealthyThreshold number of health checks consecutively.
Instance registration is still in progress.
Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.
Instance is not currently registered with the LoadBalancer.
Instance deregistration currently in progress.
Disable Availability Zone is currently in progress.
Instance is in pending state.
Instance is in stopped state.
Instance is in terminated state.
java.lang.String policyName
The name for the policy being created. The name must be unique within the set of policies for this load balancer.
java.lang.Long cookieExpirationPeriod
The time period, in seconds, after which the cookie should be considered stale. If this parameter is not specified, the stickiness session lasts for the duration of the browser session.
java.lang.String protocol
The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.
java.lang.Integer loadBalancerPort
The port on which the load balancer is listening. On EC2-VPC, you can specify any port from the range 1-65535. On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.
java.lang.String instanceProtocol
The protocol to use for routing traffic to back-end instances: HTTP, HTTPS, TCP, or SSL.
If the front-end protocol is HTTP, HTTPS, TCP, or SSL,
InstanceProtocol
must be at the same protocol.
If there is another listener with the same InstancePort
whose InstanceProtocol
is secure, (HTTPS or SSL), the
listener's InstanceProtocol
must also be secure.
If there is another listener with the same InstancePort
whose InstanceProtocol
is HTTP or TCP, the listener's
InstanceProtocol
must be HTTP or TCP.
java.lang.Integer instancePort
The port on which the instance is listening.
Constraints:
Range: 1 - 65535
java.lang.String sSLCertificateId
The Amazon Resource Name (ARN) of the server certificate.
Listener listener
Information about a listener.
For information about the protocols and the ports supported by Elastic Load Balancing, see Listener Configurations for Elastic Load Balancing in the Elastic Load Balancing Developer Guide.
java.util.List<E> policyNames
The policies. If there are no policies enabled, the list is empty.
CrossZoneLoadBalancing crossZoneLoadBalancing
If enabled, the load balancer routes the request traffic evenly across all back-end instances regardless of the Availability Zones.
For more information, see Enable Cross-Zone Load Balancing in the Elastic Load Balancing Developer Guide.
AccessLog accessLog
If enabled, the load balancer captures detailed information of all requests and delivers the information to the Amazon S3 bucket that you specify.
For more information, see Enable Access Logs in the Elastic Load Balancing Developer Guide.
ConnectionDraining connectionDraining
If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy back-end instance.
For more information, see Enable Connection Draining in the Elastic Load Balancing Developer Guide.
ConnectionSettings connectionSettings
If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.
By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. For more information, see Configure Idle Connection Timeout in the Elastic Load Balancing Developer Guide.
java.util.List<E> additionalAttributes
This parameter is reserved.
java.lang.String loadBalancerName
The name of the load balancer.
java.lang.String dNSName
The external DNS name of the load balancer.
java.lang.String canonicalHostedZoneName
The Amazon Route 53 hosted zone associated with the load balancer.
For more information, see Using Domain Names With Elastic Load Balancing in the Elastic Load Balancing Developer Guide.
java.lang.String canonicalHostedZoneNameID
The ID of the Amazon Route 53 hosted zone name associated with the load balancer.
java.util.List<E> listenerDescriptions
The listeners for the load balancer.
Policies policies
The policies defined for the load balancer.
java.util.List<E> backendServerDescriptions
Information about the back-end servers.
java.util.List<E> availabilityZones
The Availability Zones for the load balancer.
java.util.List<E> subnets
The IDs of the subnets for the load balancer.
java.lang.String vPCId
The ID of the VPC for the load balancer.
java.util.List<E> instances
The IDs of the instances for the load balancer.
HealthCheck healthCheck
Information about the health checks conducted on the load balancer.
SourceSecurityGroup sourceSecurityGroup
The security group that you can use as part of your inbound rules for your load balancer's back-end application instances. To only allow traffic from load balancers, add a security group rule to your back end instance that specifies this source security group as the inbound source.
java.util.List<E> securityGroups
The security groups for the load balancer. Valid only for load balancers in a VPC.
java.util.Date createdTime
The date and time the load balancer was created.
java.lang.String scheme
The type of load balancer. Valid only for load balancers in a VPC.
If Scheme
is internet-facing
, the load balancer
has a public DNS name that resolves to a public IP address.
If Scheme
is internal
, the load balancer has a
public DNS name that resolves to a private IP address.
java.lang.String loadBalancerName
The name of the load balancer.
LoadBalancerAttributes loadBalancerAttributes
The attributes of the load balancer.
java.lang.String loadBalancerName
The name of the load balancer.
LoadBalancerAttributes loadBalancerAttributes
The attributes for a load balancer.
java.util.List<E> appCookieStickinessPolicies
The stickiness policies created using CreateAppCookieStickinessPolicy.
java.util.List<E> lBCookieStickinessPolicies
The stickiness policies created using CreateLBCookieStickinessPolicy.
java.util.List<E> otherPolicies
The policies other than the stickiness policies.
java.lang.String attributeName
The name of the attribute.
java.lang.String attributeValue
The value of the attribute.
java.lang.String attributeName
The name of the attribute.
java.lang.String attributeValue
The value of the attribute.
java.lang.String attributeName
The name of the attribute.
java.lang.String attributeType
The type of the attribute. For example, Boolean
or
Integer
.
java.lang.String description
A description of the attribute.
java.lang.String defaultValue
The default value of the attribute, if applicable.
java.lang.String cardinality
The cardinality of the attribute.
Valid values:
java.lang.String policyName
The name of the policy.
java.lang.String policyTypeName
The name of the policy type.
java.util.List<E> policyAttributeDescriptions
The policy attributes.
java.lang.String policyTypeName
The name of the policy type.
java.lang.String description
A description of the policy type.
java.util.List<E> policyAttributeTypeDescriptions
The description of the policy attributes associated with the policies defined by Elastic Load Balancing.
java.lang.String loadBalancerName
The name of the load balancer.
java.util.List<E> instances
The IDs of the instances.
java.util.List<E> instances
The updated list of instances for the load balancer.
java.util.List<E> loadBalancerNames
The name of the load balancer. You can specify a maximum of one load balancer name.
java.util.List<E> tags
The list of tag keys to remove.
java.lang.String loadBalancerName
The name of the load balancer.
java.lang.Integer loadBalancerPort
The port that uses the specified SSL certificate.
java.lang.String sSLCertificateId
The Amazon Resource Name (ARN) of the SSL certificate.
java.lang.String loadBalancerName
The name of the load balancer.
java.lang.Integer instancePort
The port number associated with the back-end server.
java.util.List<E> policyNames
The names of the policies. If the list is empty, then all current polices are removed from the back-end server.
java.lang.String loadBalancerName
The name of the load balancer.
java.lang.Integer loadBalancerPort
The external port of the load balancer for the policy.
java.util.List<E> policyNames
The names of the policies. If the list is empty, the current policy is removed from the listener.
java.lang.String ownerAlias
The owner of the security group.
java.lang.String groupName
The name of the security group.
java.lang.String key
The key of the tag.
Constraints:
Length: 1 - 128
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
java.lang.String value
The value of the tag.
Constraints:
Length: 0 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
java.lang.String loadBalancerName
The name of the load balancer.
java.util.List<E> tags
The tags.
java.lang.String key
The name of the key.
Constraints:
Length: 1 - 128
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
java.lang.String aliasName
String that contains the alias.
Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$
java.lang.String aliasArn
String that contains the key ARN.
Constraints:
Length: 20 - 2048
java.lang.String targetKeyId
String that contains the key identifier referred to by the alias.
Constraints:
Length: 1 - 256
java.lang.String keyId
The unique identifier for the customer master key (CMK) for which to cancel deletion.
To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd- 56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
Constraints:
Length: 1 - 256
java.lang.String keyId
The unique identifier of the master key for which deletion is canceled.
Constraints:
Length: 1 - 256
java.lang.String aliasName
String that contains the display name. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved.
Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$
java.lang.String targetKeyId
An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Constraints:
Length: 1 - 256
java.lang.String keyId
The unique identifier for the customer master key (CMK) that the grant applies to.
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
Globally unique key ID: 12345678-1234-1234-1234-123456789012
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234- 123456789012
Constraints:
Length: 1 - 256
java.lang.String granteePrincipal
The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
Constraints:
Length: 1 - 256
java.lang.String retiringPrincipal
The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
Constraints:
Length: 1 - 256
java.util.List<E> operations
A list of operations that the grant permits.
GrantConstraints constraints
The conditions under which the operations permitted by the grant are allowed.
You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
java.util.List<E> grantTokens
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
java.lang.String name
A friendly name for identifying the grant. Use this value to prevent unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant
requests result
in a new grant with a unique GrantId
even if all the
supplied parameters are identical. This can result in unintended
duplicates when you retry the CreateGrant
request.
When this value is present, you can retry a CreateGrant
request with identical parameters; if the grant already exists, the
original GrantId
is returned without creating a new grant.
Note that the returned grant token is unique with every
CreateGrant
request, even when a duplicate
GrantId
is returned. All grant tokens obtained in this way
can be used interchangeably.
Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$
java.lang.String grantToken
The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
Constraints:
Length: 1 - 8192
java.lang.String grantId
The unique identifier for the grant.
You can use the GrantId
in a subsequent RetireGrant
or RevokeGrant operation.
Constraints:
Length: 1 - 128
java.lang.String policy
The key policy to attach to the CMK.
If you specify a policy and do not set
BypassPolicyLockoutSafetyCheck
to true, the policy must meet
the following criteria:
It must allow the principal making the CreateKey
request to
make a subsequent PutKeyPolicy request on the CMK. This reduces
the likelihood that the CMK becomes unmanageable. For more information,
refer to the scenario in the Default Key Policy section in the AWS Key Management Service
Developer Guide.
The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The policy size limit is 32 KiB (32768 bytes).
Constraints:
Length: 1 - 131072
Pattern: [ -ÿ]+
java.lang.String description
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
Constraints:
Length: 0 - 8192
java.lang.String keyUsage
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
Constraints:
Allowed Values: ENCRYPT_DECRYPT
java.lang.String origin
The source of the CMK's key material.
The default is AWS_KMS
, which means AWS KMS creates the key
material. When this parameter is set to EXTERNAL
, the
request creates a CMK without key material so that you can import key
material from your existing key management infrastructure. For more
information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service
Developer Guide.
The CMK's Origin
is immutable and is set when the CMK is
created.
Constraints:
Allowed Values: AWS_KMS, EXTERNAL
java.lang.Boolean bypassPolicyLockoutSafetyCheck
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
Use this parameter only when you include a policy in the request and you intend to prevent the principal making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
KeyMetadata keyMetadata
Metadata associated with the CMK.
java.nio.ByteBuffer ciphertextBlob
Ciphertext to be decrypted. The blob includes metadata.
Constraints:
Length: 1 - 6144
java.util.Map<K,V> encryptionContext
The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.
java.util.List<E> grantTokens
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
java.lang.String keyId
ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.
Constraints:
Length: 1 - 256
java.nio.ByteBuffer plaintext
Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.
Constraints:
Length: 1 - 4096
java.lang.String aliasName
The alias to be deleted. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved.
Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$
java.lang.String keyId
The identifier of the CMK whose key material to delete. The CMK's
Origin
must be EXTERNAL
.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Constraints:
Length: 1 - 256
java.lang.String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Alias Name Example - alias/MyAliasName
Constraints:
Length: 1 - 256
java.util.List<E> grantTokens
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
KeyMetadata keyMetadata
Metadata associated with the key.
java.lang.String keyId
A unique identifier for the CMK.
Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd- 56ef-1234567890ab
Constraints:
Length: 1 - 256
java.lang.String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Constraints:
Length: 1 - 256
java.lang.String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Constraints:
Length: 1 - 256
java.lang.String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Constraints:
Length: 1 - 256
java.lang.String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Alias Name Example - alias/MyAliasName
Constraints:
Length: 1 - 256
java.nio.ByteBuffer plaintext
Data to be encrypted.
Constraints:
Length: 1 - 4096
java.util.Map<K,V> encryptionContext
Name-value pair that specifies the encryption context to be used for
authenticated encryption. If used here, the same value must be supplied
to the Decrypt
API or decryption will fail. For more
information, see Encryption Context.
java.util.List<E> grantTokens
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
java.nio.ByteBuffer ciphertextBlob
The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
Constraints:
Length: 1 - 6144
java.lang.String keyId
The ID of the key used during encryption.
Constraints:
Length: 1 - 256
java.lang.String keyId
The identifier of the CMK under which to generate and encrypt the data encryption key.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK, or the alias name or ARN of an alias that refers to the CMK. Examples:
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
CMK ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
Constraints:
Length: 1 - 256
java.util.Map<K,V> encryptionContext
A set of key-value pairs that represents additional authenticated data.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
java.lang.Integer numberOfBytes
The length of the data encryption key in bytes. For example, use the
value 64 to generate a 512-bit data key (64 bytes is 512 bits). For
common key lengths (128-bit and 256-bit symmetric keys), we recommend
that you use the KeySpec
field instead of this one.
Constraints:
Range: 1 - 1024
java.lang.String keySpec
The length of the data encryption key. Use AES_128
to
generate a 128-bit symmetric key, or AES_256
to generate a
256-bit symmetric key.
Constraints:
Allowed Values: AES_256, AES_128
java.util.List<E> grantTokens
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
java.nio.ByteBuffer ciphertextBlob
The encrypted data encryption key.
Constraints:
Length: 1 - 6144
java.nio.ByteBuffer plaintext
The data encryption key. Use this data key for local encryption and decryption, then remove it from memory as soon as possible.
Constraints:
Length: 1 - 4096
java.lang.String keyId
The identifier of the CMK under which the data encryption key was generated and encrypted.
Constraints:
Length: 1 - 256
java.lang.String keyId
The identifier of the CMK under which to generate and encrypt the data encryption key.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK, or the alias name or ARN of an alias that refers to the CMK. Examples:
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
CMK ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
Constraints:
Length: 1 - 256
java.util.Map<K,V> encryptionContext
A set of key-value pairs that represents additional authenticated data.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
java.lang.String keySpec
The length of the data encryption key. Use AES_128
to
generate a 128-bit symmetric key, or AES_256
to generate a
256-bit symmetric key.
Constraints:
Allowed Values: AES_256, AES_128
java.lang.Integer numberOfBytes
The length of the data encryption key in bytes. For example, use the
value 64 to generate a 512-bit data key (64 bytes is 512 bits). For
common key lengths (128-bit and 256-bit symmetric keys), we recommend
that you use the KeySpec
field instead of this one.
Constraints:
Range: 1 - 1024
java.util.List<E> grantTokens
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
java.nio.ByteBuffer ciphertextBlob
The encrypted data encryption key.
Constraints:
Length: 1 - 6144
java.lang.String keyId
The identifier of the CMK under which the data encryption key was generated and encrypted.
Constraints:
Length: 1 - 256
java.lang.Integer numberOfBytes
The length of the byte string.
Constraints:
Range: 1 - 1024
java.nio.ByteBuffer plaintext
The unpredictable byte string.
Constraints:
Length: 1 - 4096
java.lang.String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Constraints:
Length: 1 - 256
java.lang.String policyName
String that contains the name of the policy. Currently, this must be "default". Policy names can be discovered by calling ListKeyPolicies.
Constraints:
Length: 1 - 128
Pattern: [\w]+
java.lang.String policy
A policy document in JSON format.
Constraints:
Length: 1 - 131072
Pattern: [ -ÿ]+
java.lang.String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Constraints:
Length: 1 - 256
java.lang.Boolean keyRotationEnabled
A Boolean value that specifies whether key rotation is enabled.
java.lang.String keyId
The identifier of the CMK into which you will import key material. The
CMK's Origin
must be EXTERNAL
.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Constraints:
Length: 1 - 256
java.lang.String wrappingAlgorithm
The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the AWS Key Management Service Developer Guide.
Constraints:
Allowed Values: RSAES_PKCS1_V1_5, RSAES_OAEP_SHA_1,
RSAES_OAEP_SHA_256
java.lang.String wrappingKeySpec
The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
Constraints:
Allowed Values: RSA_2048
java.lang.String keyId
The identifier of the CMK to use in a subsequent ImportKeyMaterial
request. This is the same CMK specified in the
GetParametersForImport
request.
Constraints:
Length: 1 - 256
java.nio.ByteBuffer importToken
The import token to send in a subsequent ImportKeyMaterial request.
Constraints:
Length: 1 - 6144
java.nio.ByteBuffer publicKey
The public key to use to encrypt the key material before importing it with ImportKeyMaterial.
Constraints:
Length: 1 - 4096
java.util.Date parametersValidTo
The time at which the import token and public key are no longer valid.
After this time, you cannot use them to make an ImportKeyMaterial
request and you must send another GetParametersForImport
request to retrieve new ones.
java.util.Map<K,V> encryptionContextSubset
Contains a list of key-value pairs, a subset of which must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list or is a subset of this list, the grant allows the operation. Otherwise, the operation is not allowed.
java.util.Map<K,V> encryptionContextEquals
Contains a list of key-value pairs that must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list, the grant allows the operation. Otherwise, the operation is not allowed.
java.lang.String keyId
The unique identifier for the customer master key (CMK) to which the grant applies.
Constraints:
Length: 1 - 256
java.lang.String grantId
The unique identifier for the grant.
Constraints:
Length: 1 - 128
java.lang.String name
The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.
Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$
java.util.Date creationDate
The date and time when the grant was created.
java.lang.String granteePrincipal
The principal that receives the grant's permissions.
Constraints:
Length: 1 - 256
java.lang.String retiringPrincipal
The principal that can retire the grant.
Constraints:
Length: 1 - 256
java.lang.String issuingAccount
The AWS account under which the grant was issued.
Constraints:
Length: 1 - 256
java.util.List<E> operations
The list of operations permitted by the grant.
GrantConstraints constraints
The conditions under which the grant's operations are allowed.
java.lang.String keyId
The identifier of the CMK to import the key material into. The CMK's
Origin
must be EXTERNAL
.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Constraints:
Length: 1 - 256
java.nio.ByteBuffer importToken
The import token that you received in the response to a previous GetParametersForImport request. It must be from the same response that contained the public key that you used to encrypt the key material.
Constraints:
Length: 1 - 6144
java.nio.ByteBuffer encryptedKeyMaterial
The encrypted key material to import. It must be encrypted with the public key that you received in the response to a previous GetParametersForImport request, using the wrapping algorithm that you specified in that request.
Constraints:
Length: 1 - 6144
java.util.Date validTo
The time at which the imported key material expires. When the key
material expires, AWS KMS deletes the key material and the CMK becomes
unusable. You must omit this parameter when the
ExpirationModel
parameter is set to
KEY_MATERIAL_DOES_NOT_EXPIRE
. Otherwise it is required.
java.lang.String expirationModel
Specifies whether the key material expires. The default is
KEY_MATERIAL_EXPIRES
, in which case you must include the
ValidTo
parameter. When this parameter is set to
KEY_MATERIAL_DOES_NOT_EXPIRE
, you must omit the
ValidTo
parameter.
Constraints:
Allowed Values: KEY_MATERIAL_EXPIRES, KEY_MATERIAL_DOES_NOT_EXPIRE
java.lang.String keyId
Unique identifier of the key.
Constraints:
Length: 1 - 256
java.lang.String keyArn
ARN of the key.
Constraints:
Length: 20 - 2048
java.lang.String aWSAccountId
The twelve-digit account ID of the AWS account that owns the CMK.
java.lang.String keyId
The globally unique identifier for the CMK.
Constraints:
Length: 1 - 256
java.lang.String arn
The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.
Constraints:
Length: 20 - 2048
java.util.Date creationDate
The date and time when the CMK was created.
java.lang.Boolean enabled
Specifies whether the CMK is enabled. When KeyState
is
Enabled
this value is true, otherwise it is false.
java.lang.String description
The description of the CMK.
Constraints:
Length: 0 - 8192
java.lang.String keyUsage
java.lang.String keyState
The state of the CMK.
For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Constraints:
Allowed Values: Enabled, Disabled, PendingDeletion, PendingImport
java.util.Date deletionDate
The date and time after which AWS KMS deletes the CMK. This value is
present only when KeyState
is PendingDeletion
,
otherwise this value is omitted.
java.util.Date validTo
The time at which the imported key material expires. When the key
material expires, AWS KMS deletes the key material and the CMK becomes
unusable. This value is present only for CMKs whose Origin
is EXTERNAL
and whose ExpirationModel
is
KEY_MATERIAL_EXPIRES
, otherwise this value is omitted.
java.lang.String origin
The source of the CMK's key material. When this value is
AWS_KMS
, AWS KMS created the key material. When this value
is EXTERNAL
, the key material was imported from your
existing key management infrastructure or the CMK lacks key material.
Constraints:
Allowed Values: AWS_KMS, EXTERNAL
java.lang.String expirationModel
Specifies whether the CMK's key material expires. This value is present
only when Origin
is EXTERNAL
, otherwise this
value is omitted.
Constraints:
Allowed Values: KEY_MATERIAL_EXPIRES, KEY_MATERIAL_DOES_NOT_EXPIRE
java.lang.Integer limit
When paginating results, specify the maximum number of items to return in
the response. If additional items exist beyond the number you specify,
the Truncated
element in the response is set to true.
This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
Constraints:
Range: 1 - 1000
java.lang.String marker
Use this parameter only when paginating results and only in a subsequent
request after you receive a response with truncated results. Set it to
the value of NextMarker
from the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.util.List<E> aliases
A list of key aliases in the user's account.
java.lang.String nextMarker
When Truncated
is true, this value is present and contains
the value to use for the Marker
parameter in a subsequent
pagination request.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.Boolean truncated
A flag that indicates whether there are more items in the list. If your
results were truncated, you can use the Marker
parameter to
make a subsequent pagination request to retrieve more items in the list.
java.lang.Integer limit
When paginating results, specify the maximum number of items to return in
the response. If additional items exist beyond the number you specify,
the Truncated
element in the response is set to true.
This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
Constraints:
Range: 1 - 1000
java.lang.String marker
Use this parameter only when paginating results and only in a subsequent
request after you receive a response with truncated results. Set it to
the value of NextMarker
from the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Constraints:
Length: 1 - 256
java.util.List<E> grants
A list of grants.
java.lang.String nextMarker
When Truncated
is true, this value is present and contains
the value to use for the Marker
parameter in a subsequent
pagination request.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.Boolean truncated
A flag that indicates whether there are more items in the list. If your
results were truncated, you can use the Marker
parameter to
make a subsequent pagination request to retrieve more items in the list.
java.lang.String keyId
A unique identifier for the customer master key (CMK). You can use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Constraints:
Length: 1 - 256
java.lang.Integer limit
When paginating results, specify the maximum number of items to return in
the response. If additional items exist beyond the number you specify,
the Truncated
element in the response is set to true.
This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.
Currently only 1 policy can be attached to a key.
Constraints:
Range: 1 - 1000
java.lang.String marker
Use this parameter only when paginating results and only in a subsequent
request after you receive a response with truncated results. Set it to
the value of NextMarker
from the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.util.List<E> policyNames
A list of policy names. Currently, there is only one policy and it is named "Default".
java.lang.String nextMarker
When Truncated
is true, this value is present and contains
the value to use for the Marker
parameter in a subsequent
pagination request.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.Boolean truncated
A flag that indicates whether there are more items in the list. If your
results were truncated, you can use the Marker
parameter to
make a subsequent pagination request to retrieve more items in the list.
java.lang.Integer limit
When paginating results, specify the maximum number of items to return in
the response. If additional items exist beyond the number you specify,
the Truncated
element in the response is set to true.
This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.
Constraints:
Range: 1 - 1000
java.lang.String marker
Use this parameter only when paginating results and only in a subsequent
request after you receive a response with truncated results. Set it to
the value of NextMarker
from the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.util.List<E> keys
A list of keys.
java.lang.String nextMarker
When Truncated
is true, this value is present and contains
the value to use for the Marker
parameter in a subsequent
pagination request.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.Boolean truncated
A flag that indicates whether there are more items in the list. If your
results were truncated, you can use the Marker
parameter to
make a subsequent pagination request to retrieve more items in the list.
java.lang.Integer limit
When paginating results, specify the maximum number of items to return in
the response. If additional items exist beyond the number you specify,
the Truncated
element in the response is set to true.
This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
Constraints:
Range: 1 - 1000
java.lang.String marker
Use this parameter only when paginating results and only in a subsequent
request after you receive a response with truncated results. Set it to
the value of NextMarker
from the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.String retiringPrincipal
The retiring principal for which to list grants.
To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
Constraints:
Length: 1 - 256
java.util.List<E> grants
A list of grants.
java.lang.String nextMarker
When Truncated
is true, this value is present and contains
the value to use for the Marker
parameter in a subsequent
pagination request.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.Boolean truncated
A flag that indicates whether there are more items in the list. If your
results were truncated, you can use the Marker
parameter to
make a subsequent pagination request to retrieve more items in the list.
java.lang.String keyId
A unique identifier for the CMK.
Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd- 56ef-1234567890ab
Constraints:
Length: 1 - 256
java.lang.String policyName
The name of the key policy.
This value must be default
.
Constraints:
Length: 1 - 128
Pattern: [\w]+
java.lang.String policy
The key policy to attach to the CMK.
If you do not set BypassPolicyLockoutSafetyCheck
to true,
the policy must meet the following criteria:
It must allow the principal making the PutKeyPolicy
request
to make a subsequent PutKeyPolicy
request on the CMK. This
reduces the likelihood that the CMK becomes unmanageable. For more
information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service
Developer Guide.
The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
The policy size limit is 32 KiB (32768 bytes).
Constraints:
Length: 1 - 131072
Pattern: [ -ÿ]+
java.lang.Boolean bypassPolicyLockoutSafetyCheck
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
Use this parameter only when you intend to prevent the principal making
the request from making a subsequent PutKeyPolicy
request on
the CMK.
The default value is false.
java.nio.ByteBuffer ciphertextBlob
Ciphertext of the data to reencrypt.
Constraints:
Length: 1 - 6144
java.util.Map<K,V> sourceEncryptionContext
Encryption context used to encrypt and decrypt the data specified in the
CiphertextBlob
parameter.
java.lang.String destinationKeyId
A unique identifier for the CMK to use to reencrypt the data. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Alias Name Example - alias/MyAliasName
Constraints:
Length: 1 - 256
java.util.Map<K,V> destinationEncryptionContext
Encryption context to use when the data is reencrypted.
java.util.List<E> grantTokens
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
java.nio.ByteBuffer ciphertextBlob
The reencrypted data.
Constraints:
Length: 1 - 6144
java.lang.String sourceKeyId
Unique identifier of the CMK used to originally encrypt the data.
Constraints:
Length: 1 - 256
java.lang.String keyId
Unique identifier of the CMK used to reencrypt the data.
Constraints:
Length: 1 - 256
java.lang.String grantToken
Token that identifies the grant to be retired.
Constraints:
Length: 1 - 8192
java.lang.String keyId
The Amazon Resource Name of the CMK associated with the grant. Example:
arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd- 56ef-1234567890ab
Constraints:
Length: 1 - 256
java.lang.String grantId
Unique identifier of the grant to retire. The grant ID is returned in the
response to a CreateGrant
operation.
Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
Constraints:
Length: 1 - 128
java.lang.String keyId
A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Constraints:
Length: 1 - 256
java.lang.String grantId
Identifier of the grant to be revoked.
Constraints:
Length: 1 - 128
java.lang.String keyId
The unique identifier for the customer master key (CMK) to delete.
To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd- 56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
Constraints:
Length: 1 - 256
java.lang.Integer pendingWindowInDays
The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).
This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.
Constraints:
Range: 1 - 365
java.lang.String keyId
The unique identifier of the customer master key (CMK) for which deletion is scheduled.
Constraints:
Length: 1 - 256
java.util.Date deletionDate
The date and time after which AWS KMS deletes the customer master key (CMK).
java.lang.String aliasName
String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.
Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$
java.lang.String targetKeyId
Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
You can call ListAliases to verify that the alias is mapped to the
correct TargetKeyId
.
Constraints:
Length: 1 - 256
java.lang.String keyId
A unique identifier for the CMK. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Constraints:
Length: 1 - 256
java.lang.String description
New description for the CMK.
Constraints:
Length: 0 - 8192
java.lang.String mLModelId
The ID assigned to the MLModel
at creation.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+
java.lang.Boolean verbose
Specifies whether the GetMLModel
operation should return
Recipe
.
If true, Recipe
is returned.
If false, Recipe
is not returned.
java.lang.String mLModelId
The MLModel ID, which is same as the
MLModelId
in the request.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+
java.lang.String trainingDataSourceId
The ID of the training DataSource
.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+
java.lang.String createdByIamUser
The AWS user account from which the MLModel
was created. The
account type can be either an AWS root account or an AWS Identity and
Access Management (IAM) user account.
Constraints:
Pattern: arn:aws:iam::[0-9]+:((user/.+)|(root))
java.util.Date createdAt
The time that the MLModel
was created. The time is expressed
in epoch time.
java.util.Date lastUpdatedAt
The time of the most recent edit to the MLModel
. The time is
expressed in epoch time.
java.lang.String name
A user-supplied name or description of the MLModel
.
Constraints:
Length: - 1024
java.lang.String status
The current status of the MLModel
. This element can have one
of the following values:
PENDING
- Amazon Machine Learning (Amazon ML) submitted
a request to describe a MLModel
.INPROGRESS
- The request is processing.FAILED
- The request did not run to completion. The ML
model isn't usable.COMPLETED
- The request completed successfully.DELETED
- The MLModel
is marked as deleted.
It isn't usable.
Constraints:
Allowed Values: PENDING, INPROGRESS, FAILED, COMPLETED, DELETED
java.lang.Long sizeInBytes
Long integer type that is a 64-bit signed number.
RealtimeEndpointInfo endpointInfo
The current endpoint of the MLModel
java.util.Map<K,V> trainingParameters
A list of the training parameters in the MLModel
. The list
is implemented as a map of key-value pairs.
The following is the current set of training parameters:
sgd.maxMLModelSizeInBytes
- The maximum allowed size of the
model. Depending on the input data, the size of the model might affect
its performance.
The value is an integer that ranges from 100000
to
2147483648
. The default value is 33554432
.
sgd.maxPasses
- The number of times that the training
process traverses the observations to build the MLModel
. The
value is an integer that ranges from 1
to 10000
. The default value is 10
.
sgd.shuffleType
- Whether Amazon ML shuffles the training
data. Shuffling data improves a model's ability to find the optimal
solution for a variety of data types. The valid values are
auto
and none
. The default value is
none
. We strongly recommend that you shuffle your data.
sgd.l1RegularizationAmount
- The coefficient regularization
L1 norm. It controls overfitting the data by penalizing large
coefficients. This tends to drive coefficients to zero, resulting in a
sparse feature set. If you use this parameter, start by specifying a
small value, such as 1.0E-08
.
The value is a double that ranges from 0
to
MAX_DOUBLE
. The default is to not use L1 normalization. This
parameter can't be used when L2
is specified. Use this
parameter sparingly.
sgd.l2RegularizationAmount
- The coefficient regularization
L2 norm. It controls overfitting the data by penalizing large
coefficients. This tends to drive coefficients to small, nonzero values.
If you use this parameter, start by specifying a small value, such as
1.0E-08
.
The value is a double that ranges from 0
to
MAX_DOUBLE
. The default is to not use L2 normalization. This
parameter can't be used when L1
is specified. Use this
parameter sparingly.
java.lang.String inputDataLocationS3
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
Constraints:
Length: - 2048
Pattern: s3://([^/]+)(/.*)?
java.lang.String mLModelType
Identifies the MLModel
category. The following are the
available types:
Constraints:
Allowed Values: REGRESSION, BINARY, MULTICLASS
java.lang.Float scoreThreshold
The scoring threshold is used in binary classification
MLModel
models. It marks the
boundary between a positive prediction and a negative prediction.
Output values greater than or equal to the threshold receive a positive
result from the MLModel, such as true
. Output values less
than the threshold receive a negative response from the MLModel, such as
false
.
java.util.Date scoreThresholdLastUpdatedAt
The time of the most recent edit to the ScoreThreshold
. The
time is expressed in epoch time.
java.lang.String logUri
A link to the file that contains logs of the CreateMLModel
operation.
java.lang.String message
A description of the most recent details about accessing the
MLModel
.
Constraints:
Length: - 10240
java.lang.String recipe
The recipe to use when training the MLModel
. The
Recipe
provides detailed information about the observation
data to use during training, and manipulations to perform on the
observation data during training.
This parameter is provided as part of the verbose format.
Constraints:
Length: - 131071
java.lang.String schema
The schema used by all of the data files referenced by the
DataSource
.
This parameter is provided as part of the verbose format.
Constraints:
Length: - 131071
java.lang.Integer code
java.lang.Integer code
java.lang.Integer code
java.lang.String predictedLabel
The prediction label for either a BINARY
or
MULTICLASS
MLModel
.
Constraints:
Length: 1 -
java.lang.Float predictedValue
REGRESSION
MLModel
.java.util.Map<K,V> predictedScores
java.util.Map<K,V> details
java.lang.String mLModelId
A unique identifier of the MLModel
.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+
java.util.Map<K,V> record
A map of variable name-value pairs that represent an observation.
java.lang.String predictEndpoint
Constraints:
Length: - 2048
Pattern: https://[a-zA-Z0-9-.]*\.amazon(aws)?\.com[/]?
Prediction prediction
The output from a Predict
operation:
Details
- Contains the following attributes:
DetailsAttributes.PREDICTIVE_MODEL_TYPE - REGRESSION | BINARY | MULTICLASS
DetailsAttributes.ALGORITHM - SGD
PredictedLabel
- Present for either a BINARY
or
MULTICLASS
MLModel
request.
PredictedScores
- Contains the raw classification score
corresponding to each label.
PredictedValue
- Present for a REGRESSION
MLModel
request.
java.lang.Integer peakRequestsPerSecond
The maximum processing rate for the real-time endpoint for
MLModel
, measured in incoming requests per second.
java.util.Date createdAt
The time that the request to create the real-time endpoint for the
MLModel
was received. The time is expressed in epoch time.
java.lang.String endpointUrl
The URI that specifies where to send real-time prediction requests for
the MLModel
.
The application must wait until the real-time endpoint is ready before using this URI.
Constraints:
Length: - 2048
Pattern: https://[a-zA-Z0-9-.]*\.amazon(aws)?\.com[/]?
java.lang.String endpointStatus
The current status of the real-time endpoint for the MLModel
. This element can have one of the following values:
NONE
- Endpoint does not exist or was previously
deleted.READY
- Endpoint is ready to be used for real-time
predictions.UPDATING
- Updating/creating the endpoint.
Constraints:
Allowed Values: NONE, READY, UPDATING, FAILED
java.lang.Integer code
int daysAfterInitiation
java.lang.String bucketName
java.lang.String key
java.lang.String uploadId
boolean isRequesterPays
java.lang.String bucketName
Permission.Write
permission granted to you
in order to upload new objects to a bucket.java.lang.String key
java.io.File file
ObjectMetadata metadata
CannedAccessControlList cannedAcl
AccessControlList accessControlList
java.lang.String storageClass
For more information on Amazon S3 storage classes and available values,
see the StorageClass
enumeration.
java.lang.String redirectLocation
SSECustomerKey sseCustomerKey
SSEAwsKeyManagementParams sseAwsKeyManagementParams
ObjectTagging tagging
java.util.Set<E> grantSet
java.util.List<E> grantList
Owner owner
boolean isRequesterCharged
java.lang.String extendedRequestId
java.lang.String cloudFrontId
java.util.Map<K,V> additionalDetails
java.lang.String errorResponseXml
java.lang.String name
Owner owner
java.util.Date creationDate
java.util.List<E> rules
java.util.List<E> rules
int days
java.lang.String storageClass
java.lang.String id
java.lang.String prefix
java.lang.String status
LifecycleFilter filter
int expirationInDays
boolean expiredObjectDeleteMarker
int noncurrentVersionExpirationInDays
java.util.Date expirationDate
java.util.List<E> transitions
java.util.List<E> noncurrentVersionTransitions
AbortIncompleteMultipartUpload abortIncompleteMultipartUpload
int days
java.util.Date date
java.lang.String storageClass
java.lang.String destinationBucketName
java.lang.String logFilePrefix
java.util.Map<K,V> configurations
java.lang.String policyText
java.lang.String roleARN
java.util.Map<K,V> rules
java.util.List<E> tagSets
java.lang.String status
java.lang.Boolean isMfaDeleteEnabled
java.lang.String indexDocumentSuffix
java.lang.String errorDocument
RedirectRule redirectAllRequestsTo
java.util.List<E> routingRules
java.lang.String id
java.lang.String displayName
java.lang.String invocationRoleARN
java.lang.String cloudFunctionARN
java.lang.String bucketName
java.lang.String key
java.lang.String uploadId
java.util.List<E> partETags
boolean isRequesterPays
java.lang.String bucketName
java.lang.String key
java.lang.String location
java.lang.String eTag
java.lang.String versionId
java.util.Date expirationTime
java.lang.String expirationTimeRuleId
boolean isRequesterCharged
java.lang.String sourceBucketName
java.lang.String sourceKey
java.lang.String sourceVersionId
For more information about enabling versioning for a bucket, see
AmazonS3.setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest)
.
java.lang.String destinationBucketName
java.lang.String destinationKey
java.lang.String storageClass
For more information on Amazon S3 storage classes and available values,
see the StorageClass
enumeration.
ObjectMetadata newObjectMetadata
CannedAccessControlList cannedACL
AccessControlList accessControlList
java.util.List<E> matchingETagConstraints
java.util.List<E> nonmatchingEtagConstraints
java.util.Date unmodifiedSinceConstraint
java.util.Date modifiedSinceConstraint
java.lang.String redirectLocation
SSECustomerKey sourceSSECustomerKey
SSECustomerKey destinationSSECustomerKey
SSEAwsKeyManagementParams sseAwsKeyManagementParams
boolean isRequesterPays
ObjectTagging newObjectTagging
java.lang.String etag
java.util.Date lastModifiedDate
java.lang.String versionId
java.util.Date expirationTime
java.lang.String expirationTimeRuleId
boolean isRequesterCharged
java.lang.String uploadId
int partNumber
AmazonS3.uploadPart(UploadPartRequest)
java.lang.String sourceBucketName
java.lang.String sourceKey
java.lang.String sourceVersionId
For more information about enabling versioning for a bucket, see
AmazonS3#withBucketVersioningConfiguration(withBucketVersioningConfigurationRequest)
.
java.lang.String destinationBucketName
java.lang.String destinationKey
java.util.List<E> matchingETagConstraints
java.util.List<E> nonmatchingEtagConstraints
java.util.Date unmodifiedSinceConstraint
java.util.Date modifiedSinceConstraint
java.lang.Long firstByte
CopyPartRequest.lastByte
java.lang.Long lastByte
CopyPartRequest.firstByte
.SSECustomerKey sourceSSECustomerKey
SSECustomerKey destinationSSECustomerKey
java.lang.String etag
java.util.Date lastModifiedDate
java.lang.String versionId
int partNumber
CryptoMode cryptoMode
CryptoStorageMode storageMode
java.security.Provider cryptoProvider
boolean ignoreMissingInstructionFile
CryptoMode.StrictAuthenticatedEncryption
where
missing instruction file would always cause security exception.java.lang.String bucketName
java.lang.String id
java.lang.String bucketName
java.lang.String id
java.lang.String bucketName
java.lang.String id
java.lang.String bucketName
java.lang.String bucketName
java.lang.String bucketName
java.lang.String key
boolean isRequesterPays
java.lang.String key
java.lang.String version
java.util.List<E> deletedObjects
boolean isRequesterCharged
java.lang.String key
java.lang.String versionId
boolean deleteMarker
java.lang.String deleteMarkerVersionId
java.lang.String bucketName
java.lang.String key
java.lang.String versionId
java.lang.String bucketName
java.lang.String key
java.lang.String versionId
MultiFactorAuthentication mfa
BucketVersioningConfiguration.setMfaDeleteEnabled(Boolean)
for
more information on MFA Delete.ExtraMaterialsDescription supplemental
java.lang.String instructionFileSuffix
boolean keyWrapExpected
Note, however, that if CryptoMode.StrictAuthenticatedEncryption
is in use, key wrapping is always expected for the CEK regardless.
java.util.Map<K,V> materialsDescription
boolean createEncryptionMaterial
java.util.Map<K,V> materialsDescription
java.security.KeyPair keyPair
javax.crypto.SecretKey symmetricKey
java.util.Map<K,V> desc
java.util.Map<K,V> extra
ExtraMaterialsDescription.ConflictResolution resolve
ExtraMaterialsDescription.ConflictResolution.FAIL_FAST
.S3KeyFilter s3KeyFilter
java.lang.String name
java.lang.String value
HttpMethod method
java.lang.String bucketName
java.lang.String key
java.lang.String contentType
java.lang.String contentMd5
java.util.Date expiration
boolean zeroByteContent
java.util.Map<K,V> requestParameters
ResponseHeaderOverrides responseHeaders
SSECustomerKey sseCustomerKey
java.lang.String sseAlgorithm
java.lang.String kmsCmkId
java.lang.String bucketName
java.lang.String bucketName
java.lang.String id
AnalyticsConfiguration analyticsConfiguration
java.lang.String bucketName
java.lang.String id
java.lang.String bucketName
java.lang.String bucketName
java.lang.String id
MetricsConfiguration metricsConfiguration
java.lang.String bucketName
S3ObjectIdBuilder s3ObjectIdBuilder
boolean isRequesterPays
java.lang.String bucketName
java.lang.String key
java.lang.String versionId
boolean isRequesterPays
SSECustomerKey sseCustomerKey
java.lang.Integer partNumber
S3ObjectIdBuilder s3ObjectIdBuilder
long[] range
java.util.List<E> matchingETagConstraints
java.util.List<E> nonmatchingEtagConstraints
java.util.Date unmodifiedSinceConstraint
java.util.Date modifiedSinceConstraint
ResponseHeaderOverrides responseHeaders
ProgressListener generalProgressListener
boolean isRequesterPays
SSECustomerKey sseCustomerKey
java.lang.Integer partNumber
java.lang.String bucketName
java.lang.String key
java.lang.String versionId
java.lang.String bucketName
java.lang.String bucketName
java.lang.String key
ObjectMetadata objectMetadata
CannedAccessControlList cannedACL
AccessControlList accessControlList
StorageClass storageClass
java.lang.String redirectLocation
SSECustomerKey sseCustomerKey
SSEAwsKeyManagementParams sseAwsKeyManagementParams
boolean isRequesterPays
java.lang.String functionARN
java.lang.String bucketName
java.lang.String continuationToken
java.util.List<E> analyticsConfigurationList
java.lang.String continuationToken
ListBucketAnalyticsConfigurationsRequest
.boolean isTruncated
java.lang.String nextContinuationToken
java.lang.String bucketName
java.lang.String continuationToken
java.util.List<E> inventoryConfigurationList
java.lang.String continuationToken
ListBucketInventoryConfigurationsResult
.boolean isTruncated
java.lang.String nextContinuationToken
java.lang.String bucketName
java.lang.String continuationToken
java.util.List<E> metricsConfigurationList
java.lang.String continuationToken
ListBucketMetricsConfigurationsRequest
.boolean isTruncated
java.lang.String nextContinuationToken
ObjectListing previousObjectListing
VersionListing previousVersionListing
java.util.List<E> errors
java.util.List<E> deletedObjects
java.util.List<E> objectSummaries
java.util.List<E> commonPrefixes
java.lang.String bucketName
java.lang.String nextMarker
boolean isTruncated
java.lang.String prefix
java.lang.String marker
int maxKeys
java.lang.String delimiter
java.lang.String encodingType
java.util.Map<K,V> userMetadata
java.util.Map<K,V> metadata
java.util.Date httpExpiresDate
java.util.Date expirationTime
This and the expiration time rule aren't stored in the metadata map because the header contains both the time and the rule.
java.lang.String expirationTimeRuleId
java.lang.Boolean ongoingRestore
java.util.Date restoreExpirationTime
java.util.List<E> tagSet
java.lang.String displayName
java.lang.String id
boolean isRequesterPays
java.lang.String queueARN
java.util.List<E> filterRules
java.lang.String key
java.lang.String bucketName
ObjectMetadata metadata
java.lang.String redirectLocation
java.lang.Integer taggingCount
boolean isRequesterCharged
java.lang.String bucket
java.lang.String key
java.lang.String versionId
java.lang.String bucket
java.lang.String key
java.lang.String versionId
java.lang.String bucketName
AnalyticsConfiguration analyticsConfiguration
java.lang.String bucketName
InventoryConfiguration inventoryConfiguration
java.lang.String bucketName
MetricsConfiguration metricsConfiguration
java.lang.String bucketName
java.lang.String key
java.lang.String versionId
AccessControlList acl
CannedAccessControlList cannedAcl
boolean isRequesterPays
java.lang.String bucketName
java.lang.String key
java.lang.String versionId
ObjectTagging tagging
java.lang.String awsKmsKeyId
java.lang.String key
java.lang.String value
java.lang.String topicARN
ObjectMetadata uploadPartMetadata
java.util.Map<K,V> materialsDescription
long partSize
long diskLimit
UploadObjectRequest.partSize
. The default is .ObjectMetadata objectMetadata
int id
int mainUploadId
java.lang.String bucketName
java.lang.String key
java.lang.String uploadId
int partNumber
long partSize
java.lang.String md5Digest
java.io.File file
long fileOffset
boolean isLastPart
SSECustomerKey sseCustomerKey
boolean isRequesterPays
java.lang.String id
AnalyticsFilter filter
StorageClassAnalysis storageClassAnalysis
AnalyticsS3BucketDestination s3BucketDestination
AnalyticsFilterPredicate predicate
java.lang.String prefix
java.lang.String format
java.lang.String bucketAccountId
java.lang.String bucketArn
java.lang.String prefix
Tag tag
StorageClassAnalysisDataExport dataExport
java.lang.String outputSchemaVersion
AnalyticsExportDestination destination
java.lang.String id
InventoryDestination destination
java.lang.Boolean isEnabled
InventoryFilter inventoryFilter
java.lang.String includedObjectVersions
java.util.List<E> optionalFields
InventorySchedule schedule
InventoryS3BucketDestination s3BucketDestination
InventoryFilterPredicate predicate
java.lang.String prefix
java.lang.String accountId
java.lang.String bucketArn
java.lang.String format
java.lang.String prefix
java.lang.String frequency
LifecycleFilterPredicate predicate
java.lang.String prefix
Tag tag
java.lang.String id
MetricsFilter filter
MetricsFilterPredicate predicate
java.lang.String prefix
Tag tag
java.lang.String name
java.lang.String alternateNameEncoding
java.lang.String value
java.lang.String alternateValueEncoding
java.lang.Float boxUsage
java.lang.String domainName
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
java.lang.String domainName
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
java.lang.String domainName
java.lang.String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
java.lang.String domainName
java.lang.String itemName
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
UpdateCondition expected
java.lang.String domainName
java.lang.String domainName
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
java.lang.Float boxUsage
java.lang.String domainName
java.lang.String itemName
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
java.lang.Float boxUsage
java.lang.Float boxUsage
java.lang.Float boxUsage
java.lang.Float boxUsage
java.lang.Float boxUsage
java.lang.String name
java.lang.String alternateNameEncoding
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
java.lang.Integer maxNumberOfDomains
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainNames
java.lang.String nextToken
MaxNumberOfDomains
still available.java.lang.Float boxUsage
java.lang.Float boxUsage
java.lang.Float boxUsage
java.lang.Float boxUsage
java.lang.Float boxUsage
java.lang.Float boxUsage
java.lang.Float boxUsage
java.lang.Float boxUsage
java.lang.String domainName
java.lang.String itemName
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
UpdateCondition expected
java.lang.String name
java.lang.String value
java.lang.Boolean replace
false
.java.lang.String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
java.lang.Float boxUsage
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.com.amazonaws.internal.ListWithAutoConstructFlag<T> items
java.lang.String nextToken
MaxNumberOfItems
were matched, the response size exceeded
1 megabyte, or the execution time exceeded 5 seconds.java.lang.Float boxUsage
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.java.lang.String headerName
The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.
java.lang.String headerValue
Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n").
java.lang.String name
Content text
The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).
Content html
The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.
java.lang.String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
bounce action is taken. An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
java.lang.String smtpReplyCode
The SMTP reply code, as defined by RFC 5321.
java.lang.String statusCode
The SMTP enhanced status code, as defined by RFC 3463.
java.lang.String message
Human-readable text to include in the bounce message.
java.lang.String sender
The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.
java.lang.String recipient
The email address of the recipient of the bounced email.
java.lang.String recipientArn
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to receive email for the recipient of the bounced email. For more information about sending authorization, see the Amazon SES Developer Guide.
java.lang.String bounceType
The reason for the bounce. You must provide either this parameter or
RecipientDsnFields
.
Constraints:
Allowed Values: DoesNotExist, MessageTooLarge, ExceededQuota,
ContentRejected, Undefined, TemporaryFailure
RecipientDsnFields recipientDsnFields
Recipient-related DSN fields, most of which would normally be filled in
automatically when provided with a BounceType
. You must
provide either this parameter or BounceType
.
java.lang.String name
java.lang.String ruleSetName
The name of the rule set to create. The name must:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain less than 64 characters.
java.lang.String originalRuleSetName
The name of the rule set to clone.
java.lang.String data
The textual data of the content.
java.lang.String charset
The character set of the content.
ReceiptFilter filter
A data structure that describes the IP address filter to create, which consists of a name, an IP address range, and whether to allow or block mail from it.
java.lang.String ruleSetName
The name of the rule set to which to add the rule.
java.lang.String after
The name of an existing rule after which the new rule will be placed. If this parameter is null, the new rule will be inserted at the beginning of the rule list.
ReceiptRule rule
A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
java.lang.String ruleSetName
The name of the rule set to create. The name must:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain less than 64 characters.
java.lang.String identity
The identity that is associated with the policy that you want to delete.
You can specify the identity by using its name or by using its Amazon
Resource Name (ARN). Examples: user@example.com
,
example.com
,
arn:aws:ses:us-east-1:123456789012:identity/example.com
.
To successfully call this API, you must own the identity.
java.lang.String policyName
The name of the policy to be deleted.
Constraints:
Length: 1 - 64
java.lang.String identity
The identity to be removed from the list of identities for the AWS Account.
java.lang.String filterName
The name of the IP address filter to delete.
java.lang.String ruleSetName
The name of the receipt rule set that contains the receipt rule to delete.
java.lang.String ruleName
The name of the receipt rule to delete.
java.lang.String ruleSetName
The name of the receipt rule set to delete.
java.lang.String emailAddress
An email address to be removed from the list of verified addresses.
ReceiptRuleSetMetadata metadata
The metadata for the currently active receipt rule set. The metadata consists of the rule set name and a timestamp of when the rule set was created.
java.util.List<E> rules
The receipt rules that belong to the active rule set.
java.lang.String ruleSetName
The name of the receipt rule set to which the receipt rule belongs.
java.lang.String ruleName
The name of the receipt rule.
ReceiptRule rule
A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy.
java.lang.String ruleSetName
The name of the receipt rule set to describe.
ReceiptRuleSetMetadata metadata
The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when the rule set was created.
java.util.List<E> rules
A list of the receipt rules that belong to the specified receipt rule set.
java.util.List<E> toAddresses
The To: field(s) of the message.
java.util.List<E> ccAddresses
The CC: field(s) of the message.
java.util.List<E> bccAddresses
The BCC: field(s) of the message.
java.lang.String name
The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.
java.lang.String value
The value of the header to add. Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n").
java.util.List<E> identities
A list of one or more verified identities - email addresses, domains, or both.
java.util.Map<K,V> dkimAttributes
The DKIM attributes for an email address or a domain.
java.util.List<E> identities
A list of one or more identities.
java.util.Map<K,V> mailFromDomainAttributes
A map of identities to custom MAIL FROM attributes.
java.util.List<E> identities
A list of one or more identities. You can specify an identity by using
its name or by using its Amazon Resource Name (ARN). Examples:
user@example.com
, example.com
,
arn:aws:ses:us-east-1:123456789012:identity/example.com
.
java.util.Map<K,V> notificationAttributes
A map of Identity to IdentityNotificationAttributes.
java.lang.String identity
The identity for which the policies will be retrieved. You can specify an
identity by using its name or by using its Amazon Resource Name (ARN).
Examples: user@example.com
, example.com
,
arn:aws:ses:us-east-1:123456789012:identity/example.com
.
To successfully call this API, you must own the identity.
java.util.List<E> policyNames
A list of the names of policies to be retrieved. You can retrieve a
maximum of 20 policies at a time. If you do not know the names of the
policies that are attached to the identity, you can use
ListIdentityPolicies
.
java.util.Map<K,V> policies
A map of policy names to policies.
java.util.List<E> identities
A list of identities.
java.util.Map<K,V> verificationAttributes
A map of Identities to IdentityVerificationAttributes objects.
java.lang.Double max24HourSend
The maximum number of emails the user is allowed to send in a 24-hour interval. A value of -1 signifies an unlimited quota.
java.lang.Double maxSendRate
The maximum number of emails that Amazon SES can accept from the user's account per second.
The rate at which Amazon SES accepts the user's messages might be less than the maximum send rate.
java.lang.Double sentLast24Hours
The number of emails sent during the previous 24 hours.
java.util.List<E> sendDataPoints
A list of data points, each of which represents 15 minutes of activity.
java.lang.Boolean dkimEnabled
True if DKIM signing is enabled for email sent from the identity; false otherwise.
java.lang.String dkimVerificationStatus
Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS. (This only applies to domain identities, not email address identities.)
Constraints:
Allowed Values: Pending, Success, Failed, TemporaryFailure,
NotStarted
java.util.List<E> dkimTokens
A set of character strings that represent the domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
java.lang.String mailFromDomain
The custom MAIL FROM domain that the identity is configured to use.
java.lang.String mailFromDomainStatus
The state that indicates whether Amazon SES has successfully read the MX
record required for custom MAIL FROM domain setup. If the state is
Success
, Amazon SES uses the specified custom MAIL FROM
domain when the verified identity sends an email. All other states
indicate that Amazon SES takes the action described by
BehaviorOnMXFailure
.
Constraints:
Allowed Values: Pending, Success, Failed, TemporaryFailure
java.lang.String behaviorOnMXFailure
The action that Amazon SES takes if it cannot successfully read the
required MX record when you send an email. A value of
UseDefaultValue
indicates that if Amazon SES cannot read the
required MX record, it uses amazonses.com (or a subdomain of that) as the
MAIL FROM domain. A value of RejectMessage
indicates that if
Amazon SES cannot read the required MX record, Amazon SES returns a
MailFromDomainNotVerified
error and does not send the email.
The custom MAIL FROM setup states that result in this behavior are
Pending
, Failed
, and
TemporaryFailure
.
Constraints:
Allowed Values: UseDefaultValue, RejectMessage
java.lang.String bounceTopic
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications.
java.lang.String complaintTopic
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications.
java.lang.String deliveryTopic
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications.
java.lang.Boolean forwardingEnabled
Describes whether Amazon SES will forward bounce and complaint
notifications as email. true
indicates that Amazon SES will
forward bounce and complaint notifications as email, while
false
indicates that bounce and complaint notifications will
be published only to the specified bounce and complaint Amazon SNS
topics.
java.lang.Boolean headersInBounceNotificationsEnabled
Describes whether Amazon SES includes the original email headers in
Amazon SNS notifications of type Bounce
. A value of
true
specifies that Amazon SES will include headers in
bounce notifications, and a value of false
specifies that
Amazon SES will not include headers in bounce notifications.
java.lang.Boolean headersInComplaintNotificationsEnabled
Describes whether Amazon SES includes the original email headers in
Amazon SNS notifications of type Complaint
. A value of
true
specifies that Amazon SES will include headers in
complaint notifications, and a value of false
specifies that
Amazon SES will not include headers in complaint notifications.
java.lang.Boolean headersInDeliveryNotificationsEnabled
Describes whether Amazon SES includes the original email headers in
Amazon SNS notifications of type Delivery
. A value of
true
specifies that Amazon SES will include headers in
delivery notifications, and a value of false
specifies that
Amazon SES will not include headers in delivery notifications.
java.lang.String verificationStatus
The verification status of the identity: "Pending", "Success", "Failed", or "TemporaryFailure".
Constraints:
Allowed Values: Pending, Success, Failed, TemporaryFailure,
NotStarted
java.lang.String verificationToken
The verification token for a domain identity. Null for email address identities.
java.lang.String functionArn
java.lang.String bucket
java.lang.String topic
java.lang.String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
Lambda action is taken. An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
java.lang.String functionArn
The Amazon Resource Name (ARN) of the AWS Lambda function. An example of
an AWS Lambda function ARN is
arn:aws:lambda:us-west-2:account-id:function:MyFunction
. For
more information about AWS Lambda, see the AWS
Lambda Developer Guide.
java.lang.String invocationType
The invocation type of the AWS Lambda function. An invocation type of
RequestResponse
means that the execution of the function
will immediately result in a response, and a value of Event
means that the function will be invoked asynchronously. The default value
is Event
. For information about AWS Lambda invocation types,
see the AWS
Lambda Developer Guide.
There is a 30-second timeout on RequestResponse
invocations.
You should use Event
invocation in most cases. Use
RequestResponse
only when you want to make a mail flow
decision, such as whether to stop the receipt rule or the receipt rule
set.
Constraints:
Allowed Values: Event, RequestResponse
java.lang.String identityType
The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this parameter is omitted, then all identities will be listed.
Constraints:
Allowed Values: EmailAddress, Domain
java.lang.String nextToken
The token to use for pagination.
java.lang.Integer maxItems
The maximum number of identities per page. Possible values are 1-1000 inclusive.
java.util.List<E> identities
A list of identities.
java.lang.String nextToken
The token used for pagination.
java.lang.String identity
The identity that is associated with the policy for which the policies
will be listed. You can specify an identity by using its name or by using
its Amazon Resource Name (ARN). Examples: user@example.com
,
example.com
,
arn:aws:ses:us-east-1:123456789012:identity/example.com
.
To successfully call this API, you must own the identity.
java.util.List<E> policyNames
A list of names of policies that apply to the specified identity.
java.util.List<E> filters
A list of IP address filter data structures, which each consist of a name, an IP address range, and whether to allow or block mail from it.
java.lang.String nextToken
A token returned from a previous call to ListReceiptRuleSets
to indicate the position in the receipt rule set list.
java.util.List<E> ruleSets
The metadata for the currently active receipt rule set. The metadata consists of the rule set name and the timestamp of when the rule set was created.
java.lang.String nextToken
A token indicating that there are additional receipt rule sets available
to be listed. Pass this token to successive calls of
ListReceiptRuleSets
to retrieve up to 100 receipt rule sets
at a time.
java.util.List<E> verifiedEmailAddresses
A list of email addresses that have been verified.
java.lang.String reportingMta
The reporting MTA that attempted to deliver the message, formatted as
specified in RFC 3464 (
mta-name-type; mta-name
). The default value is
dns; inbound-smtp.[region].amazonaws.com
.
java.util.Date arrivalDate
When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format.
java.util.List<E> extensionFields
Additional X-headers to include in the DSN.
java.lang.String identity
The identity to which the policy will apply. You can specify an identity
by using its name or by using its Amazon Resource Name (ARN). Examples:
user@example.com
, example.com
,
arn:aws:ses:us-east-1:123456789012:identity/example.com
.
To successfully call this API, you must own the identity.
java.lang.String policyName
The name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
Constraints:
Length: 1 - 64
java.lang.String policy
The text of the policy in JSON format. The policy cannot exceed 4 KB.
For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.
Constraints:
Length: 1 -
java.nio.ByteBuffer data
The raw data of the message. The client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, MIME encoding, and base64 encoding (if necessary).
The To:, CC:, and BCC: headers in the raw message can contain a group list.
If you are using SendRawEmail
with sending authorization,
you can include X-headers in the raw message to specify the "Source,"
"From," and "Return-Path" addresses. For more information, see the
documentation for SendRawEmail
.
Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.
For more information, go to the Amazon SES Developer Guide.
S3Action s3Action
Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
BounceAction bounceAction
Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
WorkmailAction workmailAction
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.
LambdaAction lambdaAction
Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
StopAction stopAction
Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
AddHeaderAction addHeaderAction
Adds a header to the received email.
SNSAction sNSAction
Publishes the email content within a notification to Amazon SNS.
java.lang.String name
The name of the IP address filter. The name must:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain less than 64 characters.
ReceiptIpFilter ipFilter
A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.
java.lang.String policy
Indicates whether to block or allow incoming mail from the specified IP addresses.
Constraints:
Allowed Values: Block, Allow
java.lang.String cidr
A single IP address or a range of IP addresses that you want to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see RFC 2317.
java.lang.String name
The name of the receipt rule. The name must:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain less than 64 characters.
java.lang.Boolean enabled
If true
, the receipt rule is active. The default value is
false
.
java.lang.String tlsPolicy
Specifies whether Amazon SES should require that incoming email is
delivered over a connection encrypted with Transport Layer Security
(TLS). If this parameter is set to Require
, Amazon SES will
bounce emails that are not received over TLS. The default is
Optional
.
Constraints:
Allowed Values: Require, Optional
java.util.List<E> recipients
The recipient domains and email addresses to which the receipt rule applies. If this field is not specified, this rule will match all recipients under all verified domains.
java.util.List<E> actions
An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
java.lang.Boolean scanEnabled
If true
, then messages to which this receipt rule applies
are scanned for spam and viruses. The default value is false
.
java.lang.String name
The name of the receipt rule set. The name must:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain less than 64 characters.
java.util.Date createdTimestamp
The date and time the receipt rule set was created.
java.lang.String finalRecipient
The email address to which the message was ultimately delivered. This
corresponds to the Final-Recipient
in the DSN. If not
specified, FinalRecipient
will be set to the
Recipient
specified in the BouncedRecipientInfo
structure. Either FinalRecipient
or the recipient in
BouncedRecipientInfo
must be a recipient of the original
bounced message.
Do not prepend the FinalRecipient
email address with
rfc 822;
, as described in RFC 3798.
java.lang.String action
The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.
Constraints:
Allowed Values: failed, delayed, delivered, relayed, expanded
java.lang.String remoteMta
The MTA to which the remote MTA attempted to deliver the message,
formatted as specified in RFC 3464 (
mta-name-type; mta-name
). This parameter typically applies
only to propagating synchronous bounces.
java.lang.String status
The status code that indicates what went wrong. This is required by RFC 3464.
java.lang.String diagnosticCode
An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.
java.util.Date lastAttemptDate
The time the final delivery attempt was made, in RFC 822 date-time format.
java.util.List<E> extensionFields
Additional X-headers to include in the DSN.
java.lang.String ruleSetName
The name of the receipt rule set to reorder.
java.util.List<E> ruleNames
A list of the specified receipt rule set's receipt rules in the order that you want to put them.
java.lang.String name
java.lang.String name
java.lang.String topicArn
The ARN of the Amazon SNS topic to notify when the message is saved to
the Amazon S3 bucket. An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
java.lang.String bucketName
The name of the Amazon S3 bucket to which to save the received email.
java.lang.String objectKeyPrefix
The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.
java.lang.String kmsKeyArn
The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows:
To use the default master key, provide an ARN in the form of
arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses
.
For example, if your AWS account ID is 123456789012 and you want to use
the default master key in the US West (Oregon) region, the ARN of the
default master key would be
arn:aws:kms:us-west-2:123456789012:alias/aws/ses
. If you use
the default master key, you don't need to perform any extra steps to give
Amazon SES permission to use the key.
To use a custom master key you created in AWS KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide.
For more information about key policies, see the AWS KMS Developer Guide. If you do not specify a master key, Amazon SES will not encrypt your emails.
Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS Java SDK and AWS Ruby SDK only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide.
java.lang.String originalMessageId
The message ID of the message to be bounced.
java.lang.String bounceSender
The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES.
java.lang.String explanation
Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information.
MessageDsn messageDsn
Message-related DSN fields. If not specified, Amazon SES will choose the values.
java.util.List<E> bouncedRecipientInfoList
A list of recipients of the bounced message, including the information
required to create the Delivery Status Notifications (DSNs) for the
recipients. You must specify at least one
BouncedRecipientInfo
in the list.
java.lang.String bounceSenderArn
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the "From" header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide.
java.lang.String messageId
The message ID of the bounce message.
java.util.Date timestamp
Time of the data point.
java.lang.Long deliveryAttempts
Number of emails that have been enqueued for sending.
java.lang.Long bounces
Number of emails that have bounced.
java.lang.Long complaints
Number of unwanted emails that were rejected by recipients.
java.lang.Long rejects
Number of emails rejected by Amazon SES.
java.lang.String source
The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
If you are sending on behalf of another user and have been permitted to
do so by a sending authorization policy, then you must also specify the
SourceArn
parameter. For more information about sending
authorization, see the Amazon SES Developer Guide.
In all cases, the email address 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
The destination for this email, composed of To:, CC:, and BCC: fields.
Message message
The message to be sent.
java.util.List<E> replyToAddresses
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
java.lang.String returnPath
The email address to which bounces and complaints are to be forwarded
when feedback forwarding is enabled. If the message cannot be delivered
to the recipient, then an error message will be returned from the
recipient's ISP; this message will then be forwarded to the email address
specified by the ReturnPath
parameter. The
ReturnPath
parameter is never overwritten. This email
address must be either individually verified with Amazon SES, or from a
domain that has been verified with Amazon SES.
java.lang.String sourceArn
This parameter is used only for sending authorization. It is the ARN of
the identity that is associated with the sending authorization policy
that permits you to send for the email address specified in the
Source
parameter.
For example, if the owner of example.com
(which has ARN
arn:aws:ses:us-east-1:123456789012:identity/example.com
)
attaches a policy to it that authorizes you to send from
user@example.com
, then you would specify the
SourceArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com
, and
the Source
to be user@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
java.lang.String returnPathArn
This parameter is used only for sending authorization. It is the ARN of
the identity that is associated with the sending authorization policy
that permits you to use the email address specified in the
ReturnPath
parameter.
For example, if the owner of example.com
(which has ARN
arn:aws:ses:us-east-1:123456789012:identity/example.com
)
attaches a policy to it that authorizes you to use
feedback@example.com
, then you would specify the
ReturnPathArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com
, and
the ReturnPath
to be feedback@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
java.lang.String messageId
The unique message identifier returned from the SendEmail
action.
java.lang.String source
The identity's email address. If you do not provide a value for this parameter, you must specify a "From" address in the raw text of the message. (You can also specify both.)
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.
If you specify the Source
parameter and have feedback
forwarding enabled, then bounces and complaints will be sent to this
email address. This takes precedence over any Return-Path header
that you might include in the raw text of the message.
java.util.List<E> destinations
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
RawMessage rawMessage
The raw text of the message. The client is responsible for ensuring the following:
Message must contain a header and a body, separated by a blank line.
All required header fields must be present.
Each part of a multipart MIME message must be formatted properly.
MIME content types must be among those supported by Amazon SES. For more information, go to the Amazon SES Developer Guide.
Content must be base64-encoded, if MIME requires it.
java.lang.String fromArn
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to specify a particular "From" address in the header of the raw email.
Instead of using this parameter, you can use the X-header
X-SES-FROM-ARN
in the raw message of the email. If you use
both the FromArn
parameter and the corresponding X-header,
Amazon SES uses the value of the FromArn
parameter.
For information about when to use this parameter, see the description of
SendRawEmail
in this guide, or see the Amazon SES Developer Guide.
java.lang.String sourceArn
This parameter is used only for sending authorization. It is the ARN of
the identity that is associated with the sending authorization policy
that permits you to send for the email address specified in the
Source
parameter.
For example, if the owner of example.com
(which has ARN
arn:aws:ses:us-east-1:123456789012:identity/example.com
)
attaches a policy to it that authorizes you to send from
user@example.com
, then you would specify the
SourceArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com
, and
the Source
to be user@example.com
.
Instead of using this parameter, you can use the X-header
X-SES-SOURCE-ARN
in the raw message of the email. If you use
both the SourceArn
parameter and the corresponding X-header,
Amazon SES uses the value of the SourceArn
parameter.
For information about when to use this parameter, see the description of
SendRawEmail
in this guide, or see the Amazon SES Developer Guide.
java.lang.String returnPathArn
This parameter is used only for sending authorization. It is the ARN of
the identity that is associated with the sending authorization policy
that permits you to use the email address specified in the
ReturnPath
parameter.
For example, if the owner of example.com
(which has ARN
arn:aws:ses:us-east-1:123456789012:identity/example.com
)
attaches a policy to it that authorizes you to use
feedback@example.com
, then you would specify the
ReturnPathArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com
, and
the ReturnPath
to be feedback@example.com
.
Instead of using this parameter, you can use the X-header
X-SES-RETURN-PATH-ARN
in the raw message of the email. If
you use both the ReturnPathArn
parameter and the
corresponding X-header, Amazon SES uses the value of the
ReturnPathArn
parameter.
For information about when to use this parameter, see the description of
SendRawEmail
in this guide, or see the Amazon SES Developer Guide.
java.lang.String messageId
The unique message identifier returned from the SendRawEmail
action.
java.lang.String ruleSetName
The name of the receipt rule set to make active. Setting this value to null disables all email receiving.
java.lang.String identity
The identity for which DKIM signing should be enabled or disabled.
java.lang.Boolean dkimEnabled
Sets whether DKIM signing is enabled for an identity. Set to
true
to enable DKIM signing for this identity;
false
to disable it.
java.lang.String identity
The identity for which to set bounce and complaint notification
forwarding. Examples: user@example.com
,
example.com
.
java.lang.Boolean forwardingEnabled
Sets whether Amazon SES will forward bounce and complaint notifications
as email. true
specifies that Amazon SES will forward bounce
and complaint notifications as email, in addition to any Amazon SNS topic
publishing otherwise specified. false
specifies that Amazon
SES will publish bounce and complaint notifications only through Amazon
SNS. This value can only be set to false
when Amazon SNS
topics are set for both Bounce
and Complaint
notification types.
java.lang.String identity
The identity for which to enable or disable headers in notifications.
Examples: user@example.com
, example.com
.
java.lang.String notificationType
The notification type for which to enable or disable headers in notifications.
Constraints:
Allowed Values: Bounce, Complaint, Delivery
java.lang.Boolean enabled
Sets whether Amazon SES includes the original email headers in Amazon SNS
notifications of the specified notification type. A value of
true
specifies that Amazon SES will include headers in
notifications, and a value of false
specifies that Amazon
SES will not include headers in notifications.
This value can only be set when NotificationType
is already
set to use a particular Amazon SNS topic.
java.lang.String identity
The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.
java.lang.String mailFromDomain
The custom MAIL FROM domain that you want the verified identity to use.
The MAIL FROM domain must 1) be a subdomain of the verified identity, 2)
not be used in a "From" address if the MAIL FROM domain is the
destination of email feedback forwarding (for more information, see the
Amazon SES Developer Guide), and 3) not be used to receive emails. A
value of null
disables the custom MAIL FROM setting for the
identity.
java.lang.String behaviorOnMXFailure
The action that you want Amazon SES to take if it cannot successfully
read the required MX record when you send an email. If you choose
UseDefaultValue
, Amazon SES will use amazonses.com (or a
subdomain of that) as the MAIL FROM domain. If you choose
RejectMessage
, Amazon SES will return a
MailFromDomainNotVerified
error and not send the email.
The action specified in BehaviorOnMXFailure
is taken when
the custom MAIL FROM domain setup is in the Pending
,
Failed
, and TemporaryFailure
states.
Constraints:
Allowed Values: UseDefaultValue, RejectMessage
java.lang.String identity
The identity for which the Amazon SNS topic will be set. You can specify
an identity by using its name or by using its Amazon Resource Name (ARN).
Examples: user@example.com
, example.com
,
arn:aws:ses:us-east-1:123456789012:identity/example.com
.
java.lang.String notificationType
The type of notifications that will be published to the specified Amazon SNS topic.
Constraints:
Allowed Values: Bounce, Complaint, Delivery
java.lang.String snsTopic
The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter
is omitted from the request or a null value is passed,
SnsTopic
is cleared and publishing is disabled.
java.lang.String ruleSetName
The name of the receipt rule set that contains the receipt rule to reposition.
java.lang.String ruleName
The name of the receipt rule to reposition.
java.lang.String after
The name of the receipt rule after which to place the specified receipt rule.
java.lang.String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An
example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
java.lang.String encoding
The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.
Constraints:
Allowed Values: UTF-8, Base64
java.lang.String scope
The scope to which the Stop action applies. That is, what is being stopped.
Constraints:
Allowed Values: RuleSet
java.lang.String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
stop action is taken. An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
java.lang.String ruleSetName
The name of the receipt rule set to which the receipt rule belongs.
ReceiptRule rule
A data structure that contains the updated receipt rule information.
java.lang.String domain
The name of the domain to be verified for Easy DKIM signing.
java.util.List<E> dkimTokens
A set of character strings that represent the domain's identity. If the identity is an email address, the tokens represent the domain of that address.
Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign emails originating from that domain.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
java.lang.String domain
The domain to be verified.
java.lang.String verificationToken
A TXT record that must be placed in the DNS settings for the domain, in order to complete domain verification.
java.lang.String emailAddress
The email address to be verified.
java.lang.String emailAddress
The email address to be verified.
java.lang.String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
WorkMail action is called. An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
java.lang.String organizationArn
The ARN of the Amazon WorkMail organization. An example of an Amazon
WorkMail organization ARN is
arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7
. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.
java.lang.String topicArn
The ARN of the topic whose access control policy you wish to modify.
java.lang.String label
A unique identifier for the new policy statement.
java.util.List<E> aWSAccountIds
The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.
java.util.List<E> actionNames
The action you want to allow for the specified principal(s).
Valid values: any Amazon SNS action name.
java.lang.String phoneNumber
The phone number for which you want to check the opt out status.
java.lang.Boolean isOptedOut
Indicates whether the phone number is opted out:
true
– The phone number is opted out, meaning you cannot
publish SMS messages to it.
false
– The phone number is opted in, meaning you can
publish SMS messages to it.
java.lang.String topicArn
The ARN of the topic for which you wish to confirm a subscription.
java.lang.String token
Short-lived token sent to an endpoint during the Subscribe
action.
java.lang.String authenticateOnUnsubscribe
Disallows unauthenticated unsubscribes of the subscription. If the value
of this parameter is true
and the request has an AWS
signature, then only the topic owner and the subscription owner can
unsubscribe the endpoint. The unsubscribe action requires AWS
authentication.
java.lang.String subscriptionArn
The ARN of the created subscription.
java.lang.String name
Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.
java.lang.String platform
The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).
java.util.Map<K,V> attributes
For a list of attributes, see SetPlatformApplicationAttributes
java.lang.String platformApplicationArn
PlatformApplicationArn is returned.
java.lang.String platformApplicationArn
PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
java.lang.String token
Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.
java.lang.String 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.
java.util.Map<K,V> attributes
For a list of attributes, see SetEndpointAttributes.
java.lang.String endpointArn
EndpointArn returned from CreateEndpoint action.
java.lang.String name
The name of the topic you want to create.
Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
java.lang.String topicArn
The Amazon Resource Name (ARN) assigned to the created topic.
java.lang.String endpointArn
EndpointArn of endpoint to delete.
java.lang.String platformApplicationArn
PlatformApplicationArn of platform application object to delete.
java.lang.String topicArn
The ARN of the topic you want to delete.
java.lang.String endpointArn
EndpointArn for mobile app and device.
java.util.Map<K,V> attributes
Attributes for endpoint.
java.lang.String endpointArn
EndpointArn for GetEndpointAttributes input.
java.util.Map<K,V> attributes
Attributes include the following:
CustomUserData
-- arbitrary user data to associate with the
endpoint. Amazon SNS does not use this data. The data must be in UTF-8
format and less than 2KB.
Enabled
-- flag that enables/disables delivery to the
endpoint. Amazon SNS will set this to false when a notification service
indicates to Amazon SNS that the endpoint is invalid. Users can set it
back to true, typically after updating Token.
Token
-- device token, also referred to as a registration
id, for an app and mobile device. This is returned from the notification
service when an app and mobile device are registered with the
notification service.
java.lang.String platformApplicationArn
PlatformApplicationArn for GetPlatformApplicationAttributesInput.
java.util.Map<K,V> attributes
Attributes include the following:
EventEndpointCreated
-- Topic ARN to which EndpointCreated
event notifications should be sent.
EventEndpointDeleted
-- Topic ARN to which EndpointDeleted
event notifications should be sent.
EventEndpointUpdated
-- Topic ARN to which EndpointUpdate
event notifications should be sent.
EventDeliveryFailure
-- Topic ARN to which DeliveryFailure
event notifications should be sent upon Direct Publish delivery failure
(permanent) to one of the application's endpoints.
java.util.List<E> attributes
A list of the individual attribute names, such as
MonthlySpendLimit
, for which you want values.
For all attribute names, see SetSMSAttributes.
If you don't use this parameter, Amazon SNS returns all SMS attributes.
java.util.Map<K,V> attributes
The SMS attribute names and their values.
java.lang.String subscriptionArn
The ARN of the subscription whose properties you want to get.
java.util.Map<K,V> attributes
A map of the subscription's attributes. Attributes in this map include the following:
SubscriptionArn
-- the subscription's ARN
TopicArn
-- the topic ARN that the subscription is
associated with
Owner
-- the AWS account ID of the subscription's owner
ConfirmationWasAuthenticated
-- true if the subscription
confirmation request was authenticated
DeliveryPolicy
-- the JSON serialization of the
subscription's delivery policy
EffectiveDeliveryPolicy
-- the JSON serialization of the
effective delivery policy that takes into account the topic delivery
policy and account system defaults
java.lang.String topicArn
The ARN of the topic whose properties you want to get.
java.util.Map<K,V> attributes
A map of the topic's attributes. Attributes in this map include the following:
TopicArn
-- the topic's ARN
Owner
-- the AWS account ID of the topic's owner
Policy
-- the JSON serialization of the topic's access
control policy
DisplayName
-- the human-readable name used in the "From"
field for notifications to email and email-json endpoints
SubscriptionsPending
-- the number of subscriptions pending
confirmation on this topic
SubscriptionsConfirmed
-- the number of confirmed
subscriptions on this topic
SubscriptionsDeleted
-- the number of deleted subscriptions
on this topic
DeliveryPolicy
-- the JSON serialization of the topic's
delivery policy
EffectiveDeliveryPolicy
-- the JSON serialization of the
effective delivery policy that takes into account system defaults
java.lang.String platformApplicationArn
PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.
java.lang.String nextToken
NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.
java.util.List<E> endpoints
Endpoints returned for ListEndpointsByPlatformApplication action.
java.lang.String nextToken
NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.
java.lang.String nextToken
A NextToken
string is used when you call the
ListPhoneNumbersOptedOut
action to retrieve additional
records that are available after the first page of results.
java.util.List<E> phoneNumbers
A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.
java.lang.String nextToken
A NextToken
string is returned when you call the
ListPhoneNumbersOptedOut
action if additional records are
available after the first page of results.
java.lang.String nextToken
NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.
java.util.List<E> platformApplications
Platform applications returned when calling ListPlatformApplications action.
java.lang.String nextToken
NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.
java.lang.String topicArn
The ARN of the topic for which you wish to find subscriptions.
java.lang.String nextToken
Token returned by the previous ListSubscriptionsByTopic
request.
java.util.List<E> subscriptions
A list of subscriptions.
java.lang.String nextToken
Token to pass along to the next ListSubscriptionsByTopic
request. This element is returned if there are more subscriptions to
retrieve.
java.lang.String nextToken
Token returned by the previous ListSubscriptions
request.
java.util.List<E> subscriptions
A list of subscriptions.
java.lang.String nextToken
Token to pass along to the next ListSubscriptions
request.
This element is returned if there are more subscriptions to retrieve.
java.lang.String nextToken
Token returned by the previous ListTopics
request.
java.util.List<E> topics
A list of topic ARNs.
java.lang.String nextToken
Token to pass along to the next ListTopics
request. This
element is returned if there are additional topics to retrieve.
java.lang.String dataType
Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.
java.lang.String stringValue
Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
java.nio.ByteBuffer binaryValue
Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
java.lang.String phoneNumber
The phone number to opt in.
java.lang.String platformApplicationArn
PlatformApplicationArn for platform application object.
java.util.Map<K,V> attributes
Attributes for platform application object.
java.lang.String topicArn
The topic you want to publish to.
If you don't specify a value for the TopicArn
parameter, you
must specify a value for the PhoneNumber
or
TargetArn
parameters.
java.lang.String targetArn
Either TopicArn or EndpointArn, but not both.
If you don't specify a value for the TargetArn
parameter,
you must specify a value for the PhoneNumber
or
TopicArn
parameters.
java.lang.String phoneNumber
The phone number to which you want to deliver an SMS message. Use E.164 format.
If you don't specify a value for the PhoneNumber
parameter,
you must specify a value for the TargetArn
or
TopicArn
parameters.
java.lang.String message
The message you want to send to the topic.
If you want to send the same message to all transport protocols, include the text of the message as a String value.
If you want to send different messages for each transport protocol, set
the value of the MessageStructure
parameter to
json
and use a JSON object for the Message
parameter. See the Examples section for the format of the JSON object.
Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters).
JSON-specific constraints:
Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
The values will be parsed (unescaped) before they are used in outgoing messages.
Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
Values have a minimum length of 0 (the empty string, "", is allowed).
Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
Non-string values will cause the key to be ignored.
Keys that do not correspond to supported transport protocols are ignored.
Duplicate keys are not allowed.
Failure to parse or validate any key or value in the message will cause
the Publish
call to return an error (no partial delivery).
java.lang.String subject
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
java.lang.String messageStructure
Set MessageStructure
to json
if you want to
send a different message for each protocol. For example, using one
publish action, you can send a short message to your SMS subscribers and
a longer message to your email subscribers. If you set
MessageStructure
to json
, the value of the
Message
parameter must:
be a syntactically valid JSON object; and
contain at least a top-level JSON key of "default" with a value that is a string.
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
Message attributes for Publish action.
java.lang.String messageId
Unique identifier assigned to the published message.
Length Constraint: Maximum 100 characters
java.lang.String topicArn
The ARN of the topic whose access control policy you wish to modify.
java.lang.String label
The unique label of the statement you want to remove.
java.lang.String endpointArn
EndpointArn used for SetEndpointAttributes action.
java.util.Map<K,V> attributes
A map of the endpoint attributes. Attributes in this map include the following:
CustomUserData
-- arbitrary user data to associate with the
endpoint. Amazon SNS does not use this data. The data must be in UTF-8
format and less than 2KB.
Enabled
-- flag that enables/disables delivery to the
endpoint. Amazon SNS will set this to false when a notification service
indicates to Amazon SNS that the endpoint is invalid. Users can set it
back to true, typically after updating Token.
Token
-- device token, also referred to as a registration
id, for an app and mobile device. This is returned from the notification
service when an app and mobile device are registered with the
notification service.
java.lang.String platformApplicationArn
PlatformApplicationArn for SetPlatformApplicationAttributes action.
java.util.Map<K,V> attributes
A map of the platform application attributes. Attributes in this map include the following:
PlatformCredential
-- The credential received from the
notification service. For APNS/APNS_SANDBOX, PlatformCredential is
private key. For GCM, PlatformCredential is "API key". For ADM,
PlatformCredential is "client secret".
PlatformPrincipal
-- The principal received from the
notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is SSL
certificate. For GCM, PlatformPrincipal is not applicable. For ADM,
PlatformPrincipal is "client id".
EventEndpointCreated
-- Topic ARN to which EndpointCreated
event notifications should be sent.
EventEndpointDeleted
-- Topic ARN to which EndpointDeleted
event notifications should be sent.
EventEndpointUpdated
-- Topic ARN to which EndpointUpdate
event notifications should be sent.
EventDeliveryFailure
-- Topic ARN to which DeliveryFailure
event notifications should be sent upon Direct Publish delivery failure
(permanent) to one of the application's endpoints.
SuccessFeedbackRoleArn
-- IAM role ARN used to give Amazon
SNS write access to use CloudWatch Logs on your behalf.
FailureFeedbackRoleArn
-- IAM role ARN used to give Amazon
SNS write access to use CloudWatch Logs on your behalf.
SuccessFeedbackSampleRate
-- Sample rate percentage (0-100)
of successfully delivered messages.
java.util.Map<K,V> attributes
The default settings for sending SMS messages from your account. You can set values for the following attribute names:
MonthlySpendLimit
– The maximum amount in USD that you are
willing to spend each month to send SMS messages. When Amazon SNS
determines that sending an SMS message would incur a cost that exceeds
this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole
– The ARN of the IAM role that allows
Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For
each SMS message that you send, Amazon SNS writes a log that includes the
message price, the success or failure status, the reason for failure (if
the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate
– The percentage of
successful SMS deliveries for which Amazon SNS will write logs in
CloudWatch Logs. The value can be an integer from 0 - 100. For example,
to write logs only for failed deliveries, set this value to
0
. To write logs for 10% of your successful deliveries, set
it to 10
.
DefaultSenderID
– A string, such as your business brand,
that is displayed as the sender on the receiving device. Support for
sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric
characters, and it must contain at least one letter.
DefaultSMSType
– The type of SMS message that you will send
by default. You can assign the following values:
Promotional
– Noncritical messages, such as marketing
messages. Amazon SNS optimizes the message delivery to incur the lowest
cost.
Transactional
– (Default) Critical messages that support
customer transactions, such as one-time passcodes for multi-factor
authentication. Amazon SNS optimizes the message delivery to achieve the
highest reliability.
UsageReportS3Bucket
– The name of the Amazon S3 bucket to
receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS
will deliver a usage report as a CSV file to the bucket. The report
includes the following information for each SMS message that was
successfully delivered by your account:
Time that the message was published (in UTC)
Message ID
Destination phone number
Message type
Delivery status
Message price (in USD)
Part number (a message is split into multiple parts if it is too long for a single message)
Total number of parts
To receive the report, the bucket must have a policy that allows the
Amazon SNS service principle to perform the s3:PutObject
and
s3:GetBucketLocation
actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.
java.lang.String subscriptionArn
The ARN of the subscription to modify.
java.lang.String attributeName
The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.
Valid values: DeliveryPolicy
|
RawMessageDelivery
java.lang.String attributeValue
The new value for the attribute in JSON format.
java.lang.String topicArn
The ARN of the topic to modify.
java.lang.String attributeName
The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.
Valid values: Policy
| DisplayName
|
DeliveryPolicy
java.lang.String attributeValue
The new value for the attribute.
java.lang.String topicArn
The ARN of the topic you want to subscribe to.
java.lang.String protocol
The protocol you want to use. Supported protocols include:
http
-- delivery of JSON-encoded message via HTTP POST
https
-- delivery of JSON-encoded message via HTTPS POST
email
-- delivery of message via SMTP
email-json
-- delivery of JSON-encoded message via SMTP
sms
-- delivery of message via SMS
sqs
-- delivery of JSON-encoded message to an Amazon SQS
queue
application
-- delivery of JSON-encoded message to an
EndpointArn for a mobile app and device.
lambda
-- delivery of JSON-encoded message to an AWS Lambda
function.
java.lang.String endpoint
The endpoint that you want to receive notifications. Endpoints vary by protocol:
For the http
protocol, the endpoint is an URL beginning with
"http://"
For the https
protocol, the endpoint is a URL beginning with
"https://"
For the email
protocol, the endpoint is an email address
For the email-json
protocol, the endpoint is an email
address
For the sms
protocol, the endpoint is a phone number of an
SMS-enabled device
For the sqs
protocol, the endpoint is the ARN of an Amazon
SQS queue
For the application
protocol, the endpoint is the
EndpointArn of a mobile app and device.
For the lambda
protocol, the endpoint is the ARN of an AWS
Lambda function.
java.lang.String subscriptionArn
The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).
java.lang.String subscriptionArn
The subscription's ARN.
java.lang.String owner
The subscription's owner.
java.lang.String protocol
The subscription's protocol.
java.lang.String endpoint
The subscription's endpoint (format depends on the protocol).
java.lang.String topicArn
The ARN of the subscription's topic.
java.lang.String topicArn
The topic's ARN.
java.lang.String subscriptionArn
The ARN of the subscription to be deleted.
java.lang.String queueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
java.lang.String label
The unique identification of the permission you're setting (e.g.,
AliceSendMessage
). Constraints: Maximum 80 characters;
alphanumeric characters, hyphens (-), and underscores (_) are allowed.
java.util.List<E> aWSAccountIds
The AWS account number of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon SQS Developer Guide.
java.util.List<E> actions
The action the client wants to allow for the specified principal. The
following are valid values:
* | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl
. For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide.
Specifying SendMessage
, DeleteMessage
, or
ChangeMessageVisibility
for the ActionName.n
also grants permissions for the corresponding batch versions of those
actions: SendMessageBatch
, DeleteMessageBatch
,
and ChangeMessageVisibilityBatch
.
java.lang.String id
The id of an entry in a batch request.
java.lang.Boolean senderFault
Whether the error happened due to the sender's fault.
java.lang.String code
An error code representing why the action failed on this entry.
java.lang.String message
A message explaining why the action failed on this entry.
java.lang.String queueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
java.util.List<E> entries
A list of receipt handles of the messages for which the visibility timeout must be changed.
java.lang.String id
An identifier for this particular receipt handle. This is used to
communicate the result. Note that the Id
s of a batch request
need to be unique within the request.
java.lang.String receiptHandle
A receipt handle.
java.lang.Integer visibilityTimeout
The new value (in seconds) for the message's visibility timeout.
java.util.List<E> successful
A list of ChangeMessageVisibilityBatchResultEntry items.
java.util.List<E> failed
A list of BatchResultErrorEntry items.
java.lang.String id
Represents a message whose visibility timeout has been changed successfully.
java.lang.String queueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
java.lang.String receiptHandle
The receipt handle associated with the message whose visibility timeout should be changed. This parameter is returned by the ReceiveMessage action.
java.lang.Integer visibilityTimeout
The new value (in seconds - from 0 to 43200 - maximum 12 hours) for the message's visibility timeout.
java.lang.String queueName
The name of the new queue. The following limits apply to this name:
A queue name can have up to 80 characters.
The following are accepted: alphanumeric chatacters, hyphens (
-
), and underscores (_
).
A FIFO queue name must end with the .fifo
suffix.
Queue names are case-sensitive.
java.util.Map<K,V> attributes
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special
request parameters that the CreateQueue
action uses:
DelaySeconds
- The number of seconds for which the delivery
of all messages in the queue is delayed. An integer from 0 to 900 (15
minutes). The default is 0 (zero).
MaximumMessageSize
- The limit of how many bytes a message
can contain before Amazon SQS rejects it. An integer from 1,024 bytes (1
KiB) up to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB).
MessageRetentionPeriod
- The number of seconds for which
Amazon SQS retains a message. An integer representing seconds, from 60 (1
minute) to 120,9600 (14 days). The default is 345,600 (4 days).
Policy
- The queue's policy. A valid AWS policy. For more
information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.
ReceiveMessageWaitTimeSeconds
- The number of seconds for
which a ReceiveMessage action will wait for a message to arrive.
An integer from 0 to 20 (seconds). The default is 0.
RedrivePolicy
- The parameters for the dead letter queue
functionality of the source queue. For more information about the redrive
policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer
Guide.
The dead letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead letter queue of a standard queue must also be a standard queue.
VisibilityTimeout
- The visibility timeout for the queue. An
integer from 0 to 43200 (12 hours). The default is 30. For more
information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
The following attributes apply only to FIFO (first-in-first-out) queues:
FifoQueue
- Designates a queue as FIFO. You can provide this
attribute only during queue creation; you can't change it for an existing
queue. When you set this attribute, you must provide a
MessageGroupId
explicitly.
For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide.
ContentBasedDeduplication
- Enables content-based
deduplication. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.
Every message must have a unique MessageDeduplicationId
,
You may provide a MessageDeduplicationId
explicitly.
If you aren't able to provide a MessageDeduplicationId
and
you enable ContentBasedDeduplication
for your queue, Amazon
SQS uses a SHA-256 hash to generate the
MessageDeduplicationId
using the body of the message (but
not the attributes of the message).
If you don't provide a MessageDeduplicationId
and the queue
doesn't have ContentBasedDeduplication
set, the action fails
with an error.
If the queue has ContentBasedDeduplication
set, your
MessageDeduplicationId
overrides the generated one.
When ContentBasedDeduplication
is in effect, messages with
identical content sent within the deduplication interval are treated as
duplicates and only one copy of the message is delivered.
You can also use ContentBasedDeduplication
for messages with
identical content to be treated as duplicates.
If you send one message with ContentBasedDeduplication
enabled and then another message with a
MessageDeduplicationId
that is the same as the one generated
for the first MessageDeduplicationId
, the two messages are
treated as duplicates and only one copy of the message is delivered.
Any other valid special request parameters that are specified (such as
ApproximateNumberOfMessages
,
ApproximateNumberOfMessagesDelayed
,
ApproximateNumberOfMessagesNotVisible
,
CreatedTimestamp
, LastModifiedTimestamp
, and
QueueArn
) will be ignored.
java.lang.String queueUrl
The URL for the created Amazon SQS queue.
java.lang.String queueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
java.util.List<E> entries
A list of receipt handles for the messages to be deleted.
java.lang.String id
An identifier for this particular receipt handle. This is used to
communicate the result. Note that the Id
s of a batch request
need to be unique within the request.
java.lang.String receiptHandle
A receipt handle.
java.util.List<E> successful
A list of DeleteMessageBatchResultEntry items.
java.util.List<E> failed
A list of BatchResultErrorEntry items.
java.lang.String id
Represents a successfully deleted message.
java.lang.String queueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
java.lang.String receiptHandle
The receipt handle associated with the message to delete.
java.lang.String queueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
java.lang.String queueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
java.util.List<E> attributeNames
A list of attributes for which to retrieve information.
Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
The following attributes are supported:
All
- Returns all values.
ApproximateNumberOfMessages
- Returns the approximate number
of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS
Developer Guide.
ApproximateNumberOfMessagesDelayed
- Returns the approximate
number of messages that are waiting to be added to the queue.
ApproximateNumberOfMessagesNotVisible
- Returns the
approximate number of messages that have not timed-out and are not
deleted. For more information, see Resources Required to Process Messages in the Amazon SQS
Developer Guide.
CreatedTimestamp
- Returns the time when the queue was
created in seconds (epoch time).
DelaySeconds
- Returns the default delay on the queue in
seconds.
LastModifiedTimestamp
- Returns the time when the queue was
last changed in seconds (epoch time).
MaximumMessageSize
- Returns the limit of how many bytes a
message can contain before Amazon SQS rejects it.
MessageRetentionPeriod
- Returns the number of seconds for
which Amazon SQS retains a message.
Policy
- Returns the policy of the queue.
QueueArn
- Returns the Amazon resource name (ARN) of the
queue.
ReceiveMessageWaitTimeSeconds
- Returns the number of
seconds for which ReceiveMessage call will wait for a message to arrive.
RedrivePolicy
- Returns the parameters for dead letter queue
functionality of the source queue. For more information about the redrive
policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer
Guide.
VisibilityTimeout
- Returns the visibility timeout for the
queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
The following attributes apply only to FIFO (first-in-first-out) queues:
FifoQueue
- Returns whether the queue is FIFO. For more
information, see FIFO Queue Logic in the Amazon SQS Developer Guide.
ContentBasedDeduplication
- Returns whether content-based
deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.
java.util.Map<K,V> attributes
A map of attributes to the respective values.
java.lang.String queueName
The name of the queue whose URL must be fetched. Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.
Queue names are case-sensitive.
java.lang.String queueOwnerAWSAccountId
The AWS account ID of the account that created the queue.
java.lang.String queueUrl
The URL for the queue.
java.lang.String queueUrl
The queue URL of a dead letter queue.
Queue URLs are case-sensitive.
java.util.List<E> queueUrls
A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead letter queue.
java.lang.String queueNamePrefix
A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.
Queue names are case-sensitive.
java.util.List<E> queueUrls
A list of queue URLs, up to 1000 entries.
java.lang.String messageId
A unique identifier for the message. Message IDs are considered unique across all AWS accounts for an extended period of time.
java.lang.String receiptHandle
An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.
java.lang.String mD5OfBody
An MD5 digest of the non-URL-encoded message body string.
java.lang.String body
The message's contents (not URL-encoded).
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
An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
java.util.Map<K,V> messageAttributes
Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items in the Amazon SQS Developer Guide.
java.lang.String stringValue
Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters.
java.nio.ByteBuffer binaryValue
Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
java.util.List<E> stringListValues
Not implemented. Reserved for future use.
java.util.List<E> binaryListValues
Not implemented. Reserved for future use.
java.lang.String dataType
Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.
You can also append custom labels. For more information, see Message Attribute Data Types in the Amazon SQS Developer Guide.
java.lang.String queueUrl
The queue URL of the queue to delete the messages from when using the
PurgeQueue
API.
Queue URLs are case-sensitive.
java.lang.String queueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
java.util.List<E> attributeNames
A list of attributes that need to be returned along with each message. These attributes include:
All
- Returns all values.
ApproximateFirstReceiveTimestamp
- Returns the time the
message was first received from the queue (epoch time in milliseconds).
ApproximateReceiveCount
- Returns the number of times a
message has been received from the queue but not deleted.
SenderId
For an IAM user, returns the IAM user ID, for example
ABCDEFGHI1JKLMNOPQ23R
.
For an IAM role, returns the IAM role ID, for example
ABCDE1F2GH3I4JK5LMNOP:i-a123b456
.
SentTimestamp
- Returns the time the message was sent to the
queue (epoch time in milliseconds).
MessageDeduplicationId
- Returns the value provided by the
sender that calls the SendMessage
action.
MessageGroupId
- Returns the value provided by the sender
that calls the SendMessage
action. Messages with
the same MessageGroupId
are returned in sequence.
SequenceNumber
- Returns the value provided by Amazon SQS.
Any other valid special request parameters (such as the following) that are specified are ignored:
ApproximateNumberOfMessages
ApproximateNumberOfMessagesDelayed
ApproximateNumberOfMessagesNotVisible
CreatedTimestamp
ContentBasedDeduplication
DelaySeconds
LastModifiedTimestamp
MaximumMessageSize
MessageRetentionPeriod
Policy
QueueArn
,
ReceiveMessageWaitTimeSeconds
RedrivePolicy
FifoQueue
VisibilityTimeout
java.util.List<E> messageAttributeNames
The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name can't start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.
When using ReceiveMessage
, you can send a list of attribute
names to receive, or you can return all of the attributes by specifying
"All" or ".*" in your request. You can also use "bar.*" to return all
message attributes starting with the "bar" prefix.
java.lang.Integer maxNumberOfMessages
The maximum number of messages to return. Amazon SQS never returns more messages than this value but might return fewer. Values can be from 1 to 10. Default is 1.
All of the messages are not necessarily returned.
java.lang.Integer visibilityTimeout
The duration (in seconds) that the received messages are hidden from
subsequent retrieve requests after being retrieved by a
ReceiveMessage
request.
java.lang.Integer waitTimeSeconds
The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning. If a message is available, the call will return sooner than WaitTimeSeconds.
java.lang.String receiveRequestAttemptId
This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of ReceiveMessage
calls. If
a networking issue occurs after a ReceiveMessage
action, and
instead of a response you receive a generic error, you can retry the same
action with an identical ReceiveRequestAttemptId
to retrieve
the same set of messages, even if their visibility timeout has not yet
expired.
You can use ReceiveRequestAttemptId
only for 5 minutes after
a ReceiveMessage
action.
When you set FifoQueue
, a caller of the
ReceiveMessage
action can provide a
ReceiveRequestAttemptId
explicitly.
If a caller of the ReceiveMessage
action doesn't provide a
ReceiveRequestAttemptId
, Amazon SQS generates a
ReceiveRequestAttemptId
.
You can retry the ReceiveMessage
action with the same
ReceiveRequestAttemptId
if none of the messages have been
modified (deleted or had their visibility changes).
During a visibility timeout, subsequent calls with the same
ReceiveRequestAttemptId
return the same messages and receipt
handles. If a retry occurs within the deduplication interval, it resets
the visibility timeout. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer
Guide.
If a caller of the ReceiveMessage
action is still processing
messages when the visibility timeout expires and messages become visible,
another worker reading from the same queue can receive the same messages
and therefore process duplicates. Also, if a reader whose message
processing time is longer than the visibility timeout tries to delete the
processed messages, the action fails with an error.
To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.
While messages with a particular MessageGroupId
are
invisible, no more messages belonging to the same
MessageGroupId
are returned until the visibility timeout
expires. You can still receive messages with another
MessageGroupId
as long as it is also visible.
If a caller of ReceiveMessage
can't track the
ReceiveRequestAttemptId
, no retries will work until the
original visibility timeout expires. As a result, delays might occur but
the messages in the queue will remain in a strict order.
The length of ReceiveRequestAttemptId
is 128 characters.
ReceiveRequestAttemptId
can contain alphanumeric characters
(a-z
, A-Z
, 0-9
) and punctuation (
!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
).
For best practices of using ReceiveRequestAttemptId
, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon
Simple Queue Service Developer Guide.
java.util.List<E> messages
A list of messages.
java.lang.String queueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
java.lang.String label
The identification of the permission to remove. This is the label added with the AddPermission action.
java.lang.String queueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
java.util.List<E> entries
A list of SendMessageBatchRequestEntry items.
java.lang.String id
An identifier for the message in this batch. This is used to communicate
the result. Note that the Id
s of a batch request need to be
unique within the request.
java.lang.String messageBody
Body of the message.
java.lang.Integer delaySeconds
The number of seconds (0 to 900 - 15 minutes) to delay a specific
message. Messages with a positive DelaySeconds
value become
available for processing after the delay time is finished. If you don't
specify a value, the default value for the queue applies.
When you set FifoQueue
, you can't set
DelaySeconds
per message. You can set this parameter only on
a queue level.
java.util.Map<K,V> messageAttributes
Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items in the Amazon SQS Developer Guide.
java.lang.String messageDeduplicationId
This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of messages within a 5-minute minimum
deduplication interval. If a message with a particular
MessageDeduplicationId
is sent successfully, subsequent
messages with the same MessageDeduplicationId
are accepted
successfully but aren't delivered. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.
Every message must have a unique MessageDeduplicationId
,
You may provide a MessageDeduplicationId
explicitly.
If you aren't able to provide a MessageDeduplicationId
and
you enable ContentBasedDeduplication
for your queue, Amazon
SQS uses a SHA-256 hash to generate the
MessageDeduplicationId
using the body of the message (but
not the attributes of the message).
If you don't provide a MessageDeduplicationId
and the queue
doesn't have ContentBasedDeduplication
set, the action fails
with an error.
If the queue has ContentBasedDeduplication
set, your
MessageDeduplicationId
overrides the generated one.
When ContentBasedDeduplication
is in effect, messages with
identical content sent within the deduplication interval are treated as
duplicates and only one copy of the message is delivered.
You can also use ContentBasedDeduplication
for messages with
identical content to be treated as duplicates.
If you send one message with ContentBasedDeduplication
enabled and then another message with a
MessageDeduplicationId
that is the same as the one generated
for the first MessageDeduplicationId
, the two messages are
treated as duplicates and only one copy of the message is delivered.
The MessageDeduplicationId
is available to the recipient of
the message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the
message is resent with the same MessageDeduplicationId
after
the deduplication interval, Amazon SQS can't detect duplicate messages.
The length of MessageDeduplicationId
is 128 characters.
MessageDeduplicationId
can contain alphanumeric characters (
a-z
, A-Z
, 0-9
) and punctuation (
!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
).
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon Simple
Queue Service Developer Guide.
java.lang.String messageGroupId
This parameter applies only to FIFO (first-in-first-out) queues.
The tag that specifies that a message belongs to a specific message
group. Messages that belong to the same message group are processed in a
FIFO manner (however, messages in different message groups might be
processed out of order). To interleave multiple ordered streams within a
single queue, use MessageGroupId
values (for example,
session data for multiple users). In this scenario, multiple readers can
process the queue, but the session data of each user is processed in a
FIFO fashion.
You must associate a non-empty MessageGroupId
with a
message. If you don't provide a MessageGroupId
, the action
fails.
ReceiveMessage
might return messages with multiple
MessageGroupId
values. For each MessageGroupId
,
the messages are sorted by time sent. The caller can't specify a
MessageGroupId
.
The length of MessageGroupId
is 128 characters. Valid values
are alphanumeric characters and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon Simple Queue
Service Developer Guide.
java.util.List<E> successful
A list of SendMessageBatchResultEntry items.
java.util.List<E> failed
A list of BatchResultErrorEntry items with the error detail about each message that could not be enqueued.
java.lang.String id
An identifier for the message in this batch.
java.lang.String messageId
An identifier for the message.
java.lang.String mD5OfMessageBody
An MD5 digest of the non-URL-encoded message body string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
java.lang.String mD5OfMessageAttributes
An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message batch correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
java.lang.String sequenceNumber
This element applies only to FIFO (first-in-first-out) queues.
A large, non-consecutive number that Amazon SQS assigns to each message.
The length of SequenceNumber
is 128 bits. As
SequenceNumber
continues to increase for a particular
MessageGroupId
.
java.lang.String queueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
java.lang.String messageBody
The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding note.
java.lang.Integer delaySeconds
The number of seconds (0 to 900 - 15 minutes) to delay a specific
message. Messages with a positive DelaySeconds
value become
available for processing after the delay time is finished. If you don't
specify a value, the default value for the queue applies.
When you set FifoQueue
, you can't set
DelaySeconds
per message. You can set this parameter only on
a queue level.
java.util.Map<K,V> messageAttributes
Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items in the Amazon SQS Developer Guide.
java.lang.String messageDeduplicationId
This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of sent messages. If a message with a
particular MessageDeduplicationId
is sent successfully, any
messages sent with the same MessageDeduplicationId
are
accepted successfully but aren't delivered during the 5-minute
deduplication interval. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.
Every message must have a unique MessageDeduplicationId
,
You may provide a MessageDeduplicationId
explicitly.
If you aren't able to provide a MessageDeduplicationId
and
you enable ContentBasedDeduplication
for your queue, Amazon
SQS uses a SHA-256 hash to generate the
MessageDeduplicationId
using the body of the message (but
not the attributes of the message).
If you don't provide a MessageDeduplicationId
and the queue
doesn't have ContentBasedDeduplication
set, the action fails
with an error.
If the queue has ContentBasedDeduplication
set, your
MessageDeduplicationId
overrides the generated one.
When ContentBasedDeduplication
is in effect, messages with
identical content sent within the deduplication interval are treated as
duplicates and only one copy of the message is delivered.
You can also use ContentBasedDeduplication
for messages with
identical content to be treated as duplicates.
If you send one message with ContentBasedDeduplication
enabled and then another message with a
MessageDeduplicationId
that is the same as the one generated
for the first MessageDeduplicationId
, the two messages are
treated as duplicates and only one copy of the message is delivered.
The MessageDeduplicationId
is available to the recipient of
the message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgdment is lost and the
message is resent with the same MessageDeduplicationId
after
the deduplication interval, Amazon SQS can't detect duplicate messages.
The length of MessageDeduplicationId
is 128 characters.
MessageDeduplicationId
can contain alphanumeric characters (
a-z
, A-Z
, 0-9
) and punctuation (
!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
).
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon Simple
Queue Service Developer Guide.
java.lang.String messageGroupId
This parameter applies only to FIFO (first-in-first-out) queues.
The tag that specifies that a message belongs to a specific message
group. Messages that belong to the same message group are processed in a
FIFO manner (however, messages in different message groups might be
processed out of order). To interleave multiple ordered streams within a
single queue, use MessageGroupId
values (for example,
session data for multiple users). In this scenario, multiple readers can
process the queue, but the session data of each user is processed in a
FIFO fashion.
You must associate a non-empty MessageGroupId
with a
message. If you don't provide a MessageGroupId
, the action
fails.
ReceiveMessage
might return messages with multiple
MessageGroupId
values. For each MessageGroupId
,
the messages are sorted by time sent. The caller can't specify a
MessageGroupId
.
The length of MessageGroupId
is 128 characters. Valid values
are alphanumeric characters and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon Simple Queue
Service Developer Guide.
java.lang.String mD5OfMessageBody
An MD5 digest of the non-URL-encoded message body string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
java.lang.String mD5OfMessageAttributes
An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
java.lang.String messageId
An element containing the message ID of the message sent to the queue. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.
java.lang.String sequenceNumber
This element applies only to FIFO (first-in-first-out) queues.
A large, non-consecutive number that Amazon SQS assigns to each message.
The length of SequenceNumber
is 128 bits.
SequenceNumber
continues to increase for a particular
MessageGroupId
.
java.lang.String queueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
java.util.Map<K,V> attributes
A map of attributes to set.
The following lists the names, descriptions, and values of the special
request parameters that the SetQueueAttributes
action uses:
DelaySeconds
- The number of seconds for which the delivery
of all messages in the queue is delayed. An integer from 0 to 900 (15
minutes). The default is 0 (zero).
MaximumMessageSize
- The limit of how many bytes a message
can contain before Amazon SQS rejects it. An integer from 1,024 bytes (1
KiB) up to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB).
MessageRetentionPeriod
- The number of seconds for which
Amazon SQS retains a message. An integer representing seconds, from 60 (1
minute) to 120,9600 (14 days). The default is 345,600 (4 days).
Policy
- The queue's policy. A valid AWS policy. For more
information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.
ReceiveMessageWaitTimeSeconds
- The number of seconds for
which a ReceiveMessage action will wait for a message to arrive.
An integer from 0 to 20 (seconds). The default is 0.
RedrivePolicy
- The parameters for the dead letter queue
functionality of the source queue. For more information about the redrive
policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer
Guide.
The dead letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead letter queue of a standard queue must also be a standard queue.
VisibilityTimeout
- The visibility timeout for the queue. An
integer from 0 to 43200 (12 hours). The default is 30. For more
information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
The following attribute applies only to FIFO (first-in-first-out) queues:
ContentBasedDeduplication
- Enables content-based
deduplication. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.
Every message must have a unique MessageDeduplicationId
,
You may provide a MessageDeduplicationId
explicitly.
If you aren't able to provide a MessageDeduplicationId
and
you enable ContentBasedDeduplication
for your queue, Amazon
SQS uses a SHA-256 hash to generate the
MessageDeduplicationId
using the body of the message (but
not the attributes of the message).
If you don't provide a MessageDeduplicationId
and the queue
doesn't have ContentBasedDeduplication
set, the action fails
with an error.
If the queue has ContentBasedDeduplication
set, your
MessageDeduplicationId
overrides the generated one.
When ContentBasedDeduplication
is in effect, messages with
identical content sent within the deduplication interval are treated as
duplicates and only one copy of the message is delivered.
You can also use ContentBasedDeduplication
for messages with
identical content to be treated as duplicates.
If you send one message with ContentBasedDeduplication
enabled and then another message with a
MessageDeduplicationId
that is the same as the one generated
for the first MessageDeduplicationId
, the two messages are
treated as duplicates and only one copy of the message is delivered.
Any other valid special request parameters that are specified (such as
ApproximateNumberOfMessages
,
ApproximateNumberOfMessagesDelayed
,
ApproximateNumberOfMessagesNotVisible
,
CreatedTimestamp
, LastModifiedTimestamp
, and
QueueArn
) will be ignored.
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.