Serialized Form

Package com.amazonaws

Class com.amazonaws.AmazonClientException extends RuntimeException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.AmazonServiceException extends AmazonClientException implements Serializable

serialVersionUID: 1L

Serialized Fields

requestId

String requestId

The unique AWS identifier for the service request the caller made. The AWS request ID can uniquely identify the AWS request, and is used for reporting an error to AWS support team.

errorCode

String errorCode

The AWS error code represented by this exception (ex: InvalidParameterValue).

errorType

AmazonServiceException.ErrorType errorType

Indicates (if known) whether this exception was the fault of the caller or the service.

See Also:

AmazonServiceException.ErrorType

statusCode

int statusCode

The HTTP status code that was returned with this error

serviceName

String serviceName

The name of the Amazon service that sent this error response.

Package com.amazonaws.services.autoscaling.model

Class com.amazonaws.services.autoscaling.model.Activity extends Object implements Serializable

Serialized Fields

activityId

String activityId

Specifies the ID of the activity.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

description

String description

Contains a friendly, more verbose description of the scaling activity.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

cause

String cause

Contains the reason the activity was begun.

Constraints:
Length: 1 - 1023
Pattern: [ -??-??-?\r\n\t]*

startTime

Date startTime

Provides the start time of this activity.

endTime

Date endTime

Provides the end time of this activity.

statusCode

String statusCode

Contains the current status of the activity.

Constraints:
Allowed Values: WaitingForSpotInstanceRequestId, WaitingForSpotInstanceId, WaitingForInstanceId, PreInService, InProgress, Successful, Failed, Cancelled

statusMessage

String statusMessage

Contains a friendly, more verbose description of the activity status.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

progress

Integer progress

Specifies a value between 0 and 100 that indicates the progress of the activity.

details

String details

Contains details of the scaling activity.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.AdjustmentType extends Object implements Serializable

Serialized Fields

adjustmentType

String adjustmentType

A policy adjustment type. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.Alarm extends Object implements Serializable

Serialized Fields

alarmName

String alarmName

The name of the alarm.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

alarmARN

String alarmARN

The Amazon Resource Name (ARN) of the alarm.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.AlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.autoscaling.model.AutoScalingGroup extends Object implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

Specifies the name of the group.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

autoScalingGroupARN

String autoScalingGroupARN

The Amazon Resource Name (ARN) of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

launchConfigurationName

String launchConfigurationName

Specifies the name of the associated LaunchConfiguration.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

minSize

Integer minSize

Contains the minimum size of the Auto Scaling group.

maxSize

Integer maxSize

Contains the maximum size of the Auto Scaling group.

desiredCapacity

Integer desiredCapacity

Specifies the desired capacity for the Auto Scaling group.

defaultCooldown

Integer defaultCooldown

The number of seconds after a scaling activity completes before any further scaling activities can start.

availabilityZones

List<E> availabilityZones

Contains a list of Availability Zones for the group.

Constraints:
Length: 1 -

loadBalancerNames

List<E> loadBalancerNames

A list of load balancers associated with this Auto Scaling group.

healthCheckType

String healthCheckType

The service of interest for the health status check, either "EC2" for Amazon EC2 or "ELB" for Elastic Load Balancing.

Constraints:
Length: 1 - 32
Pattern: [ -??-??-?\r\n\t]*

healthCheckGracePeriod

Integer healthCheckGracePeriod

The length of time that Auto Scaling waits before checking an instance's health status. The grace period begins when an instance comes into service.

instances

List<E> instances

Provides a summary list of Amazon EC2 instances.

createdTime

Date createdTime

Specifies the date and time the Auto Scaling group was created.

suspendedProcesses

List<E> suspendedProcesses

Suspended processes associated with this Auto Scaling group.

placementGroup

String placementGroup

The name of the cluster placement group, if applicable. For more information, go to Using Cluster Instances in the Amazon EC2 User Guide.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

vPCZoneIdentifier

String vPCZoneIdentifier

The subnet identifier for the Amazon VPC connection, if applicable. You can specify several subnets in a comma-separated list.

When you specify VPCZoneIdentifier with AvailabilityZones, ensure that the subnets' Availability Zones match the values you specify for AvailabilityZones.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

enabledMetrics

List<E> enabledMetrics

A list of metrics enabled for this Auto Scaling group.

status

String status

A list of status conditions for the Auto Scaling group.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

tags

List<E> tags

A list of tags for the Auto Scaling group.

terminationPolicies

List<E> terminationPolicies

A standalone termination policy or a list of termination policies for this Auto Scaling group.

Class com.amazonaws.services.autoscaling.model.AutoScalingInstanceDetails extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

The instance ID of the Amazon EC2 instance.

Constraints:
Length: 1 - 16
Pattern: [ -??-??-?\r\n\t]*

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group associated with this instance.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

availabilityZone

String availabilityZone

The Availability Zone in which this instance resides.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

lifecycleState

String lifecycleState

The life cycle state of this instance.

Constraints:
Length: 1 - 32
Pattern: [ -??-??-?\r\n\t]*

healthStatus

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. Auto Scaling should terminate and replace it.

Constraints:
Length: 1 - 32
Pattern: [ -??-??-?\r\n\t]*

launchConfigurationName

String launchConfigurationName

The launch configuration associated with this instance.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.BlockDeviceMapping extends Object implements Serializable

Serialized Fields

virtualName

String virtualName

The virtual name associated with the device.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

deviceName

String deviceName

The name of the device within Amazon EC2.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

ebs

Ebs ebs

The Elastic Block Storage volume information.

Class com.amazonaws.services.autoscaling.model.CreateAutoScalingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

launchConfigurationName

String launchConfigurationName

The name of the launch configuration to use with the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

minSize

Integer minSize

The minimum size of the Auto Scaling group.

maxSize

Integer maxSize

The maximum size of the Auto Scaling group.

desiredCapacity

Integer desiredCapacity

The number of Amazon EC2 instances that should be running in the group.

defaultCooldown

Integer defaultCooldown

The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.

availabilityZones

List<E> availabilityZones

A list of Availability Zones for the Auto Scaling group.

Constraints:
Length: 1 -

loadBalancerNames

List<E> loadBalancerNames

A list of load balancers to use.

healthCheckType

String healthCheckType

The service you want the health status from, Amazon EC2 or Elastic Load Balancer. Valid values are EC2 or ELB.

Constraints:
Length: 1 - 32
Pattern: [ -??-??-?\r\n\t]*

healthCheckGracePeriod

Integer healthCheckGracePeriod

Length of time in seconds after a new Amazon EC2 instance comes into service that Auto Scaling starts checking its health.

placementGroup

String placementGroup

Physical location of your cluster placement group created in Amazon EC2. For more information about cluster placement group, see Using Cluster Instances

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

vPCZoneIdentifier

String vPCZoneIdentifier

A comma-separated list of subnet identifiers of Amazon Virtual Private Clouds (Amazon VPCs).

When you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

terminationPolicies

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 on configuring a termination policy for your Auto Scaling group, go to Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.

tags

List<E> tags

The tag to be created or updated. Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. Valid values: key=value, value=value, propagate=true or false. Value and propagate are optional parameters.

Class com.amazonaws.services.autoscaling.model.CreateLaunchConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

launchConfigurationName

String launchConfigurationName

The name of the launch configuration to create.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

imageId

String imageId

Unique ID of the Amazon Machine Image (AMI) which was assigned during registration. For more information about Amazon EC2 images, please see Amazon EC2 product documentation.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

keyName

String keyName

The name of the Amazon EC2 key pair.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

securityGroups

List<E> securityGroups

The names of the security groups with which to associate Amazon EC2 or Amazon VPC instances. Specify Amazon EC2 security groups using security group names, such as websrv. Specify Amazon VPC security groups using security group IDs, such as sg-12345678. For more information about Amazon EC2 security groups, go to Using Security Groups in the Amazon EC2 product documentation. For more information about Amazon VPC security groups, go to Security Groups in the Amazon VPC product documentation.

userData

String userData

The user data available to the launched Amazon EC2 instances. For more information about Amazon EC2 user data, please see Amazon EC2 product documentation.

Constraints:
Length: 0 - 21847
Pattern: [ -??-??-?\r\n\t]*

instanceType

String instanceType

The instance type of the Amazon EC2 instance. For more information about Amazon EC2 instance types, please see Amazon EC2 product documentation

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

kernelId

String kernelId

The ID of the kernel associated with the Amazon EC2 AMI.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

ramdiskId

String ramdiskId

The ID of the RAM disk associated with the Amazon EC2 AMI.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

blockDeviceMappings

List<E> blockDeviceMappings

A list of mappings that specify how block devices are exposed to the instance. Each mapping is made up of a VirtualName, a DeviceName, and an ebs data structure that contains information about the associated Elastic Block Storage volume. For more information about Amazon EC2 BlockDeviceMappings, go to Block Device Mapping in the Amazon EC2 product documentation.

instanceMonitoring

InstanceMonitoring instanceMonitoring

Enables detailed monitoring, which is enabled by default.

When detailed monitoring is enabled, CloudWatch will generate metrics every minute and your account will be charged a fee. When you disable detailed monitoring, by specifying False, Cloudwatch will generate metrics every 5 minutes. For information about monitoring, see the Amazon CloudWatch product page.

spotPrice

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 on launching Spot Instances, go to Using Auto Scaling to Launch Spot Instances in the Auto Scaling Developer Guide.

Constraints:
Length: 1 - 255

iamInstanceProfile

String iamInstanceProfile

The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. For information on launching EC2 instances with an IAM role, go to Launching Auto Scaling Instances With an IAM Role in the Auto Scaling Developer Guide.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

ebsOptimized

Boolean ebsOptimized

Class com.amazonaws.services.autoscaling.model.CreateOrUpdateTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tags

List<E> tags

The tag to be created or updated. Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. The resource type and resource ID identify the type and name of resource for which the tag is created. Currently, auto-scaling-group is the only supported resource type. The valid value for the resource ID is groupname.

The PropagateAtLaunch flag defines whether the new tag will be applied to instances launched by the Auto Scaling group. Valid values are true or false. However, instances that are already running will not get the new or updated tag. Likewise, when you modify a tag, the updated version will be applied only to new instances launched by the Auto Scaling group after the change. Running instances that had the previous version of the tag will continue to have the older tag.

When you create a tag and a tag of the same name already exists, the operation overwrites the previous tag definition, but you will not get an error message.

Class com.amazonaws.services.autoscaling.model.DeleteAutoScalingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

forceDelete

Boolean forceDelete

Starting with API version 2011-01-01, specifies that the Auto Scaling group will be deleted along with all instances associated with the group, without waiting for all instances to be terminated.

Class com.amazonaws.services.autoscaling.model.DeleteLaunchConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

launchConfigurationName

String launchConfigurationName

The name of the launch configuration.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.DeleteNotificationConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

topicARN

String topicARN

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.DeletePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

policyName

String policyName

The name or PolicyARN of the policy you want to delete.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.DeleteScheduledActionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

scheduledActionName

String scheduledActionName

The name of the action you want to delete.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.DeleteTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tags

List<E> tags

Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. Valid values are: Resource type = auto-scaling-group, Resource ID = AutoScalingGroupName, key=value, value=value, propagate=true or false.

Class com.amazonaws.services.autoscaling.model.DescribeAdjustmentTypesRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.autoscaling.model.DescribeAdjustmentTypesResult extends Object implements Serializable

Serialized Fields

adjustmentTypes

List<E> adjustmentTypes

A list of specific policy adjustment types.

Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupNames

List<E> autoScalingGroupNames

A list of Auto Scaling group names.

nextToken

String nextToken

A string that marks the start of the next batch of returned results.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

maxRecords

Integer maxRecords

The maximum number of records to return.

Constraints:
Range: 1 - 50

Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingGroupsResult extends Object implements Serializable

Serialized Fields

autoScalingGroups

List<E> autoScalingGroups

A list of Auto Scaling groups.

nextToken

String nextToken

A string that marks the start of the next batch of returned results.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceIds

List<E> instanceIds

The list of Auto Scaling instances to describe. If this list is omitted, all auto scaling instances are described. The list of requested instances cannot contain more than 50 items. If unknown instances are requested, they are ignored with no error.

maxRecords

Integer maxRecords

The maximum number of Auto Scaling instances to be described with each call.

Constraints:
Range: 1 - 50

nextToken

String nextToken

The token returned by a previous call to indicate that there is more data available.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingInstancesResult extends Object implements Serializable

Serialized Fields

autoScalingInstances

List<E> autoScalingInstances

A list of Auto Scaling instances.

nextToken

String nextToken

A string that marks the start of the next batch of returned results.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingNotificationTypesRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingNotificationTypesResult extends Object implements Serializable

Serialized Fields

autoScalingNotificationTypes

List<E> autoScalingNotificationTypes

Notification types supported by Auto Scaling. They are: autoscaling:EC2_INSTANCE_LAUNCH, autoscaling:EC2_INSTANCE_LAUNCH_ERROR, autoscaling:EC2_INSTANCE_TERMINATE, autoscaling:EC2_INSTANCE_TERMINATE_ERROR, autoscaling:TEST_NOTIFICATION

Class com.amazonaws.services.autoscaling.model.DescribeLaunchConfigurationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

launchConfigurationNames

List<E> launchConfigurationNames

A list of launch configuration names.

nextToken

String nextToken

A string that marks the start of the next batch of returned results.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

maxRecords

Integer maxRecords

The maximum number of launch configurations. The default is 100.

Constraints:
Range: 1 - 50

Class com.amazonaws.services.autoscaling.model.DescribeLaunchConfigurationsResult extends Object implements Serializable

Serialized Fields

launchConfigurations

List<E> launchConfigurations

A list of launch configurations.

nextToken

String nextToken

A string that marks the start of the next batch of returned results.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.DescribeMetricCollectionTypesRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.autoscaling.model.DescribeMetricCollectionTypesResult extends Object implements Serializable

Serialized Fields

metrics

List<E> metrics

The list of Metrics collected.The following metrics are supported:

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupTerminatingInstances

• GroupTotalInstances

granularities

List<E> granularities

A list of granularities for the listed Metrics.

Class com.amazonaws.services.autoscaling.model.DescribeNotificationConfigurationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupNames

List<E> autoScalingGroupNames

The name of the Auto Scaling group.

nextToken

String nextToken

A string that is used to mark the start of the next batch of returned results for pagination.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

maxRecords

Integer maxRecords

Maximum number of records to be returned.

Constraints:
Range: 1 - 50

Class com.amazonaws.services.autoscaling.model.DescribeNotificationConfigurationsResult extends Object implements Serializable

Serialized Fields

notificationConfigurations

List<E> notificationConfigurations

The list of notification configurations.

nextToken

String nextToken

A string that is used to mark the start of the next batch of returned results for pagination.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.DescribePoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

policyNames

List<E> policyNames

A list of policy names or policy ARNs to be described. If this list is omitted, all policy names are described. If an auto scaling group name is provided, the results are limited to that group. The list of requested policy names cannot contain more than 50 items. If unknown policy names are requested, they are ignored with no error.

nextToken

String nextToken

A string that is used to mark the start of the next batch of returned results for pagination.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

maxRecords

Integer maxRecords

The maximum number of policies that will be described with each call.

Constraints:
Range: 1 - 50

Class com.amazonaws.services.autoscaling.model.DescribePoliciesResult extends Object implements Serializable

Serialized Fields

scalingPolicies

List<E> scalingPolicies

A list of scaling policies.

nextToken

String nextToken

A string that marks the start of the next batch of returned results.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.DescribeScalingActivitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

activityIds

List<E> activityIds

A list containing the activity IDs of the desired scaling activities. If this list is omitted, all activities are described. If an AutoScalingGroupName is provided, the results are limited to that group. The list of requested activities cannot contain more than 50 items. If unknown activities are requested, they are ignored with no error.

autoScalingGroupName

String autoScalingGroupName

The name of the AutoScalingGroup.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

maxRecords

Integer maxRecords

The maximum number of scaling activities to return.

Constraints:
Range: 1 - 50

nextToken

String nextToken

A string that marks the start of the next batch of returned results for pagination.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.DescribeScalingActivitiesResult extends Object implements Serializable

Serialized Fields

activities

List<E> activities

A list of the requested scaling activities.

nextToken

String nextToken

Acts as a paging mechanism for large result sets. Set to a non-empty string if there are additional results waiting to be returned. Pass this in to subsequent calls to return additional results.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.DescribeScalingProcessTypesRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.autoscaling.model.DescribeScalingProcessTypesResult extends Object implements Serializable

Serialized Fields

processes

List<E> processes

A list of ProcessType names.

Class com.amazonaws.services.autoscaling.model.DescribeScheduledActionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

scheduledActionNames

List<E> scheduledActionNames

A list of scheduled actions to be described. If this list is omitted, all scheduled actions are described. The list of requested scheduled actions cannot contain more than 50 items. If an auto scaling group name is provided, the results are limited to that group. If unknown scheduled actions are requested, they are ignored with no error.

startTime

Date startTime

The earliest scheduled start time to return. If scheduled action names are provided, this field will be ignored.

endTime

Date endTime

The latest scheduled start time to return. If scheduled action names are provided, this field is ignored.

nextToken

String nextToken

A string that marks the start of the next batch of returned results.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

maxRecords

Integer maxRecords

The maximum number of scheduled actions to return.

Constraints:
Range: 1 - 50

Class com.amazonaws.services.autoscaling.model.DescribeScheduledActionsResult extends Object implements Serializable

Serialized Fields

scheduledUpdateGroupActions

List<E> scheduledUpdateGroupActions

A list of scheduled actions designed to update an Auto Scaling group.

nextToken

String nextToken

A string that marks the start of the next batch of returned results.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

List<E> filters

The value of the filter type used to identify the tags to be returned. For example, you can filter so that tags are returned according to Auto Scaling group, the key and value, or whether the new tag will be applied to instances launched after the tag is created (PropagateAtLaunch).

nextToken

String nextToken

A string that marks the start of the next batch of returned results.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

maxRecords

Integer maxRecords

The maximum number of records to return.

Constraints:
Range: 1 - 50

Class com.amazonaws.services.autoscaling.model.DescribeTagsResult extends Object implements Serializable

Serialized Fields

tags

List<E> tags

The list of tags.

nextToken

String nextToken

A string used to mark the start of the next batch of returned results.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.DescribeTerminationPolicyTypesRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.autoscaling.model.DescribeTerminationPolicyTypesResult extends Object implements Serializable

Serialized Fields

terminationPolicyTypes

List<E> terminationPolicyTypes

Termination policies supported by Auto Scaling. They are: OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, Default

Class com.amazonaws.services.autoscaling.model.DisableMetricsCollectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name or ARN of the Auto Scaling Group.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

metrics

List<E> metrics

The list of metrics to disable. If no metrics are specified, all metrics are disabled. The following metrics are supported:

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupTerminatingInstances

• GroupTotalInstances

Class com.amazonaws.services.autoscaling.model.Ebs extends Object implements Serializable

Serialized Fields

snapshotId

String snapshotId

The snapshot ID.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

volumeSize

Integer volumeSize

The volume size, in gigabytes.

Constraints:
Range: 1 - 1024

Class com.amazonaws.services.autoscaling.model.EnabledMetric extends Object implements Serializable

Serialized Fields

metric

String metric

The name of the enabled metric.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

granularity

String granularity

The granularity of the enabled metric.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.EnableMetricsCollectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name or ARN of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

metrics

List<E> metrics

The list of metrics to collect. If no metrics are specified, all metrics are enabled. The following metrics are supported:

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupTerminatingInstances

• GroupTotalInstances

granularity

String granularity

The granularity to associate with the metrics to collect. Currently, the only legal granularity is "1Minute".

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.ExecutePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name or ARN of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

policyName

String policyName

The name or PolicyARN of the policy you want to run.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

honorCooldown

Boolean honorCooldown

Set to True if you want Auto Scaling to reject this request when the Auto Scaling group is in cooldown.

Class com.amazonaws.services.autoscaling.model.Filter extends Object implements Serializable

Serialized Fields

name

String name

The name of the filter. Valid Name values are: "auto-scaling-group", "key", "value", and "propagate-at-launch".

Constraints:
Pattern: [ -??-??-?\r\n\t]*

values

List<E> values

The value of the filter.

Class com.amazonaws.services.autoscaling.model.Instance extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

Specifies the ID of the Amazon EC2 instance.

Constraints:
Length: 1 - 16
Pattern: [ -??-??-?\r\n\t]*

availabilityZone

String availabilityZone

Availability Zones associated with this instance.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

lifecycleState

String lifecycleState

Contains a description of the current lifecycle state.

Constraints:
Allowed Values: Pending, Quarantined, InService, Terminating, Terminated

healthStatus

String healthStatus

The instance's health status.

Constraints:
Length: 1 - 32
Pattern: [ -??-??-?\r\n\t]*

launchConfigurationName

String launchConfigurationName

The launch configuration associated with this instance.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.InstanceMonitoring extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

If True, instance monitoring is enabled.

Class com.amazonaws.services.autoscaling.model.InvalidNextTokenException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.autoscaling.model.LaunchConfiguration extends Object implements Serializable

Serialized Fields

launchConfigurationName

String launchConfigurationName

Specifies the name of the launch configuration.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

launchConfigurationARN

String launchConfigurationARN

The launch configuration's Amazon Resource Name (ARN).

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

imageId

String imageId

Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

keyName

String keyName

Provides the name of the Amazon EC2 key pair.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

securityGroups

List<E> securityGroups

A description of the security groups to associate with the Amazon EC2 instances.

userData

String userData

The user data available to the launched Amazon EC2 instances.

Constraints:
Length: 0 - 21847
Pattern: [ -??-??-?\r\n\t]*

instanceType

String instanceType

Specifies the instance type of the Amazon EC2 instance.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

kernelId

String kernelId

Provides the ID of the kernel associated with the Amazon EC2 AMI.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

ramdiskId

String ramdiskId

Provides ID of the RAM disk associated with the Amazon EC2 AMI.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

blockDeviceMappings

List<E> blockDeviceMappings

Specifies how block devices are exposed to the instance. Each mapping is made up of a virtualName and a deviceName.

instanceMonitoring

InstanceMonitoring instanceMonitoring

Controls whether instances in this group are launched with detailed monitoring or not.

spotPrice

String spotPrice

Specifies the price to bid when launching Spot Instances.

Constraints:
Length: 1 - 255

iamInstanceProfile

String iamInstanceProfile

Provides the name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

createdTime

Date createdTime

Provides the creation date and time for this launch configuration.

ebsOptimized

Boolean ebsOptimized

Class com.amazonaws.services.autoscaling.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.autoscaling.model.MetricCollectionType extends Object implements Serializable

Serialized Fields

metric

String metric

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.MetricGranularityType extends Object implements Serializable

Serialized Fields

granularity

String granularity

The granularity of a Metric.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.NotificationConfiguration extends Object implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

Specifies the Auto Scaling group name.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

topicARN

String topicARN

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

notificationType

String notificationType

The types of events for an action to start.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.ProcessType extends Object implements Serializable

Serialized Fields

processName

String processName

The name of a process.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.PutNotificationConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

topicARN

String topicARN

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

notificationTypes

List<E> notificationTypes

The type of events that will trigger the notification. For more information, go to DescribeAutoScalingNotificationTypes.

Class com.amazonaws.services.autoscaling.model.PutScalingPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name or ARN of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

policyName

String policyName

The name of the policy you want to create or update.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

scalingAdjustment

Integer scalingAdjustment

The number of instances by which to scale. AdjustmentType determines the interpretation of this number (e.g., as an absolute number or as a percentage of the existing Auto Scaling group size). A positive increment adds to the current capacity and a negative value removes from the current capacity.

adjustmentType

String adjustmentType

Specifies whether the ScalingAdjustment is an absolute number or a percentage of the current capacity. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

cooldown

Integer cooldown

The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.

minAdjustmentStep

Integer minAdjustmentStep

Used with AdjustmentType with the value PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least the number of instances specified in the value.

You will get a ValidationError if you use MinAdjustmentStep on a policy with an AdjustmentType other than PercentChangeInCapacity.

Class com.amazonaws.services.autoscaling.model.PutScalingPolicyResult extends Object implements Serializable

Serialized Fields

policyARN

String policyARN

A policy's Amazon Resource Name (ARN).

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.PutScheduledUpdateGroupActionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name or ARN of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

scheduledActionName

String scheduledActionName

The name of this scaling action.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

time

Date time

Time is deprecated.

The time for this action to start. Time is an alias for StartTime and can be specified instead of StartTime, or vice versa. If both Time and StartTime are specified, their values should be identical. Otherwise, PutScheduledUpdateGroupAction will return an error.

startTime

Date startTime

The time for this action to start, as in --start-time 2010-06-01T00:00:00Z.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action will start and stop.

endTime

Date endTime

The time for this action to end.

recurrence

String recurrence

The time when recurring future actions will start. Start time is specified by the user following the Unix cron syntax format. For information about cron syntax, go to Wikipedia, The Free Encyclopedia.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action will start and stop.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

minSize

Integer minSize

The minimum size for the new Auto Scaling group.

maxSize

Integer maxSize

The maximum size for the Auto Scaling group.

desiredCapacity

Integer desiredCapacity

The number of Amazon EC2 instances that should be running in the group.

Class com.amazonaws.services.autoscaling.model.ResourceInUseException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.autoscaling.model.ResumeProcessesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name or Amazon Resource Name (ARN) of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

scalingProcesses

List<E> scalingProcesses

The processes that you want to suspend or resume, which can include one or more of the following:

• Launch
• Terminate
• HealthCheck
• ReplaceUnhealthy
• AZRebalance
• AlarmNotification
• ScheduledActions
• AddToLoadBalancer

To suspend all process types, omit this parameter.

Class com.amazonaws.services.autoscaling.model.ScalingActivityInProgressException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.autoscaling.model.ScalingPolicy extends Object implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group associated with this scaling policy.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

policyName

String policyName

The name of the scaling policy.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

scalingAdjustment

Integer scalingAdjustment

The number associated with the specified adjustment type. A positive value adds to the current capacity and a negative value removes from the current capacity.

adjustmentType

String adjustmentType

Specifies whether the ScalingAdjustment is an absolute number or a percentage of the current capacity. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

cooldown

Integer cooldown

The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.

policyARN

String policyARN

The Amazon Resource Name (ARN) of the policy.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

alarms

List<E> alarms

A list of CloudWatch Alarms related to the policy.

minAdjustmentStep

Integer minAdjustmentStep

Changes the DesiredCapacity of the Auto Scaling group by at least the specified number of instances.

Class com.amazonaws.services.autoscaling.model.ScheduledUpdateGroupAction extends Object implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group to be updated.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

scheduledActionName

String scheduledActionName

The name of this scheduled action.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

scheduledActionARN

String scheduledActionARN

The Amazon Resource Name (ARN) of this scheduled action.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

time

Date time

Time is deprecated.

The time that the action is scheduled to begin. Time is an alias for StartTime.

startTime

Date startTime

The time that the action is scheduled to begin. This value can be up to one month in the future.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action will start and stop.

endTime

Date endTime

The time that the action is scheduled to end. This value can be up to one month in the future.

recurrence

String recurrence

The regular schedule that an action occurs.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

minSize

Integer minSize

The minimum size of the Auto Scaling group.

maxSize

Integer maxSize

The maximum size of the Auto Scaling group.

desiredCapacity

Integer desiredCapacity

The number of instances you prefer to maintain in your Auto Scaling group.

Class com.amazonaws.services.autoscaling.model.SetDesiredCapacityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

desiredCapacity

Integer desiredCapacity

The new capacity setting for the Auto Scaling group.

honorCooldown

Boolean honorCooldown

By default, SetDesiredCapacity overrides any cooldown period. Set to True if you want Auto Scaling to reject this request when the Auto Scaling group is in cooldown.

Class com.amazonaws.services.autoscaling.model.SetInstanceHealthRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The identifier of the Amazon EC2 instance.

Constraints:
Length: 1 - 16
Pattern: [ -??-??-?\r\n\t]*

healthStatus

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. Auto Scaling should terminate and replace it.

Constraints:
Length: 1 - 32
Pattern: [ -??-??-?\r\n\t]*

shouldRespectGracePeriod

Boolean shouldRespectGracePeriod

If True, this call should respect the grace period associated with the group.

Class com.amazonaws.services.autoscaling.model.SuspendedProcess extends Object implements Serializable

Serialized Fields

processName

String processName

The name of the suspended process.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

suspensionReason

String suspensionReason

The reason that the process was suspended.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.autoscaling.model.SuspendProcessesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name or Amazon Resource Name (ARN) of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

scalingProcesses

List<E> scalingProcesses

The processes that you want to suspend or resume, which can include one or more of the following:

• Launch
• Terminate
• HealthCheck
• ReplaceUnhealthy
• AZRebalance
• AlarmNotification
• ScheduledActions
• AddToLoadBalancer

To suspend all process types, omit this parameter.

Class com.amazonaws.services.autoscaling.model.Tag extends Object implements Serializable

Serialized Fields

resourceId

String resourceId

The name of the Auto Scaling group.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

resourceType

String resourceType

The kind of resource to which the tag is applied. Currently, Auto Scaling supports the auto-scaling-group resource type.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

key

String key

The key of the tag.

Constraints:
Length: 1 - 128
Pattern: [ -??-??-?\r\n\t]*

value

String value

The value of the tag.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

propagateAtLaunch

Boolean propagateAtLaunch

Specifies whether the new tag will be applied to instances launched after the tag is created. The same behavior applies to updates: If you change a tag, the changed tag will be applied to all instances launched after you made the change.

Class com.amazonaws.services.autoscaling.model.TagDescription extends Object implements Serializable

Serialized Fields

resourceId

String resourceId

The name of the Auto Scaling group.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

resourceType

String resourceType

The kind of resource to which the tag is applied. Currently, Auto Scaling supports the auto-scaling-group resource type.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

key

String key

The key of the tag.

Constraints:
Length: 1 - 128
Pattern: [ -??-??-?\r\n\t]*

value

String value

The value of the tag.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

propagateAtLaunch

Boolean propagateAtLaunch

Specifies whether the new tag will be applied to instances launched after the tag is created. The same behavior applies to updates: If you change a tag, the changed tag will be applied to all instances launched after you made the change.

Class com.amazonaws.services.autoscaling.model.TerminateInstanceInAutoScalingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The ID of the Amazon EC2 instance to be terminated.

Constraints:
Length: 1 - 16
Pattern: [ -??-??-?\r\n\t]*

shouldDecrementDesiredCapacity

Boolean shouldDecrementDesiredCapacity

Specifies whether (true) or not (false) terminating this instance should also decrement the size of the AutoScalingGroup.

Class com.amazonaws.services.autoscaling.model.TerminateInstanceInAutoScalingGroupResult extends Object implements Serializable

Serialized Fields

activity

Activity activity

A scaling Activity.

Class com.amazonaws.services.autoscaling.model.UpdateAutoScalingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

launchConfigurationName

String launchConfigurationName

The name of the launch configuration.

Constraints:
Length: 1 - 1600
Pattern: [ -??-??-?\r\n\t]*

minSize

Integer minSize

The minimum size of the Auto Scaling group.

maxSize

Integer maxSize

The maximum size of the Auto Scaling group.

desiredCapacity

Integer desiredCapacity

The desired capacity for the Auto Scaling group.

defaultCooldown

Integer defaultCooldown

The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.

availabilityZones

List<E> availabilityZones

Availability Zones for the group.

Constraints:
Length: 1 -

healthCheckType

String healthCheckType

The service of interest for the health status check, either "EC2" for Amazon EC2 or "ELB" for Elastic Load Balancing.

Constraints:
Length: 1 - 32
Pattern: [ -??-??-?\r\n\t]*

healthCheckGracePeriod

Integer healthCheckGracePeriod

The length of time that Auto Scaling waits before checking an instance's health status. The grace period begins when an instance comes into service.

placementGroup

String placementGroup

The name of the cluster placement group, if applicable. For more information, go to Using Cluster Instances in the Amazon EC2 User Guide.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

vPCZoneIdentifier

String vPCZoneIdentifier

The subnet identifier for the Amazon VPC connection, if applicable. You can specify several subnets in a comma-separated list.

When you specify VPCZoneIdentifier with AvailabilityZones, ensure that the subnets' Availability Zones match the values you specify for AvailabilityZones.

Constraints:
Length: 1 - 255
Pattern: [ -??-??-?\r\n\t]*

terminationPolicies

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 on creating a termination policy for your Auto Scaling group, go to Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.

Package com.amazonaws.services.cloudformation.model

Class com.amazonaws.services.cloudformation.model.AlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudformation.model.CancelUpdateStackRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackName

String stackName

The name or the unique identifier associated with the stack.

Class com.amazonaws.services.cloudformation.model.CreateStackRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackName

String stackName

The name associated with the stack. The name must be unique within your AWS account. Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters.

templateBody

String templateBody

Structure containing the template body. (For more information, go to the AWS CloudFormation User Guide.)

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

Constraints:
Length: 1 - 51200

templateURL

String templateURL

Location of file containing the template body. The URL must point to a template (max size: 307,200 bytes) located in an S3 bucket in the same region as the stack. For more information, go to the AWS CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Constraints:
Length: 1 - 1024

parameters

List<E> parameters

A list of Parameter structures that specify input parameters for the stack.

disableRollback

Boolean disableRollback

Set to true to disable rollback of the stack if stack creation failed. You can specify either DisableRollback or OnFailure, but not both.

Default: false

timeoutInMinutes

Integer timeoutInMinutes

The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.

Constraints:
Range: 1 -

notificationARNs

List<E> notificationARNs

The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).

Constraints:
Length: 0 - 5

capabilities

List<E> capabilities

The list of capabilities that you want to allow in the stack. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter; otherwise, this action returns an InsufficientCapabilities error. IAM resources are the following: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::User, and AWS::IAM::UserToGroupAddition.

onFailure

String onFailure

Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.

Default: ROLLBACK

Constraints:
Allowed Values: DO_NOTHING, ROLLBACK, DELETE

tags

List<E> tags

A set of user-defined Tags to associate with this stack, represented by key/value pairs. Tags defined for the stack are propogated to EC2 resources that are created as part of the stack. A maximum number of 10 tags can be specified.

Class com.amazonaws.services.cloudformation.model.CreateStackResult extends Object implements Serializable

Serialized Fields

stackId

String stackId

Unique identifier of the stack.

Class com.amazonaws.services.cloudformation.model.DeleteStackRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackName

String stackName

The name or the unique identifier associated with the stack.

Class com.amazonaws.services.cloudformation.model.DescribeStackEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackName

String stackName

The name or the unique identifier associated with the stack.

Default: There is no default value.

nextToken

String nextToken

String that identifies the start of the next list of events, if there is one.

Default: There is no default value.

Constraints:
Length: 1 - 1024

Class com.amazonaws.services.cloudformation.model.DescribeStackEventsResult extends Object implements Serializable

Serialized Fields

stackEvents

List<E> stackEvents

A list of StackEvents structures.

nextToken

String nextToken

String that identifies the start of the next list of events, if there is one.

Constraints:
Length: 1 - 1024

Class com.amazonaws.services.cloudformation.model.DescribeStackResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackName

String stackName

The name or the unique identifier associated with the stack.

Default: There is no default value.

logicalResourceId

String logicalResourceId

The logical name of the resource as specified in the template.

Default: There is no default value.

Class com.amazonaws.services.cloudformation.model.DescribeStackResourceResult extends Object implements Serializable

Serialized Fields

stackResourceDetail

StackResourceDetail stackResourceDetail

A StackResourceDetail structure containing the description of the specified resource in the specified stack.

Class com.amazonaws.services.cloudformation.model.DescribeStackResourcesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackName

String stackName

The name or the unique identifier associated with the stack.

Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.

Default: There is no default value.

logicalResourceId

String logicalResourceId

The logical name of the resource as specified in the template.

Default: There is no default value.

physicalResourceId

String physicalResourceId

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

Class com.amazonaws.services.cloudformation.model.DescribeStackResourcesResult extends Object implements Serializable

Serialized Fields

stackResources

List<E> stackResources

A list of StackResource structures.

Class com.amazonaws.services.cloudformation.model.DescribeStacksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackName

String stackName

The name or the unique identifier associated with the stack.

Default: There is no default value.

nextToken

String nextToken

Class com.amazonaws.services.cloudformation.model.DescribeStacksResult extends Object implements Serializable

Serialized Fields

stacks

List<E> stacks

A list of stack structures.

nextToken

String nextToken

Class com.amazonaws.services.cloudformation.model.EstimateTemplateCostRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

templateBody

String templateBody

Structure containing the template body. (For more information, go to the AWS CloudFormation User Guide.)

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

Constraints:
Length: 1 - 51200

templateURL

String templateURL

Location of file containing the template body. The URL must point to a template located in an S3 bucket in the same region as the stack. For more information, go to the AWS CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Constraints:
Length: 1 - 1024

parameters

List<E> parameters

A list of Parameter structures that specify input parameters.

Class com.amazonaws.services.cloudformation.model.EstimateTemplateCostResult extends Object implements Serializable

Serialized Fields

url

String url

An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

Class com.amazonaws.services.cloudformation.model.GetTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackName

String stackName

The name or the unique identifier associated with the stack.

Class com.amazonaws.services.cloudformation.model.GetTemplateResult extends Object implements Serializable

Serialized Fields

templateBody

String templateBody

Structure containing the template body. (For more information, go to the AWS CloudFormation User Guide.)

Constraints:
Length: 1 - 51200

Class com.amazonaws.services.cloudformation.model.InsufficientCapabilitiesException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudformation.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudformation.model.ListStackResourcesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackName

String stackName

The name or the unique identifier associated with the stack.

Default: There is no default value.

nextToken

String nextToken

String that identifies the start of the next list of stack resource summaries, if there is one.

Default: There is no default value.

Constraints:
Length: 1 - 1024

Class com.amazonaws.services.cloudformation.model.ListStackResourcesResult extends Object implements Serializable

Serialized Fields

stackResourceSummaries

List<E> stackResourceSummaries

A list of StackResourceSummary structures.

nextToken

String nextToken

String that identifies the start of the next list of events, if there is one.

Constraints:
Length: 1 - 1024

Class com.amazonaws.services.cloudformation.model.ListStacksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

String nextToken

String that identifies the start of the next list of stacks, if there is one.

Default: There is no default value.

Constraints:
Length: 1 - 1024

stackStatusFilters

List<E> stackStatusFilters

Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

Class com.amazonaws.services.cloudformation.model.ListStacksResult extends Object implements Serializable

Serialized Fields

stackSummaries

List<E> stackSummaries

A list of StackSummary structures containing information about the specified stacks.

nextToken

String nextToken

String that identifies the start of the next list of stacks, if there is one.

Constraints:
Length: 1 - 1024

Class com.amazonaws.services.cloudformation.model.Output extends Object implements Serializable

Serialized Fields

outputKey

String outputKey

The key associated with the output.

outputValue

String outputValue

The value associated with the output.

description

String description

User defined description associated with the output.

Class com.amazonaws.services.cloudformation.model.Parameter extends Object implements Serializable

Serialized Fields

parameterKey

String parameterKey

The key associated with the parameter.

parameterValue

String parameterValue

The value associated with the parameter.

Class com.amazonaws.services.cloudformation.model.Stack extends Object implements Serializable

Serialized Fields

stackId

String stackId

Unique identifier of the stack.

stackName

String stackName

The name associated with the stack.

description

String description

User defined description associated with the stack.

parameters

List<E> parameters

A list of Parameter structures.

creationTime

Date creationTime

Time at which the stack was created.

lastUpdatedTime

Date lastUpdatedTime

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

stackStatus

String stackStatus

Current status of the stack.

Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE

stackStatusReason

String stackStatusReason

Success/failure message associated with the stack status.

disableRollback

Boolean disableRollback

Boolean to enable or disable rollback on stack creation failures:

• true: disable rollback
• false: enable rollback

notificationARNs

List<E> notificationARNs

SNS topic ARNs to which stack related events are published.

Constraints:
Length: 0 - 5

timeoutInMinutes

Integer timeoutInMinutes

The amount of time within which stack creation should complete.

Constraints:
Range: 1 -

capabilities

List<E> capabilities

The capabilities allowed in the stack.

outputs

List<E> outputs

A list of output structures.

tags

List<E> tags

A list of Tags that specify cost allocation information for the stack.

Class com.amazonaws.services.cloudformation.model.StackEvent extends Object implements Serializable

Serialized Fields

stackId

String stackId

The unique ID name of the instance of the stack.

eventId

String eventId

The unique ID of this event.

stackName

String stackName

The name associated with a stack.

logicalResourceId

String logicalResourceId

The logical name of the resource specified in the template.

physicalResourceId

String physicalResourceId

The name or unique identifier associated with the physical instance of the resource.

resourceType

String resourceType

Type of the resource. (For more information, go to the AWS CloudFormation User Guide.)

timestamp

Date timestamp

Time the status was updated.

resourceStatus

String resourceStatus

Current status of the resource.

Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE

resourceStatusReason

String resourceStatusReason

Success/failure message associated with the resource.

resourceProperties

String resourceProperties

BLOB of the properties used to create the resource.

Class com.amazonaws.services.cloudformation.model.StackResource extends Object implements Serializable

Serialized Fields

stackName

String stackName

The name associated with the stack.

stackId

String stackId

Unique identifier of the stack.

logicalResourceId

String logicalResourceId

The logical name of the resource specified in the template.

physicalResourceId

String physicalResourceId

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

resourceType

String resourceType

Type of the resource. (For more information, go to the AWS CloudFormation User Guide.)

timestamp

Date timestamp

Time the status was updated.

resourceStatus

String resourceStatus

Current status of the resource.

Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE

resourceStatusReason

String resourceStatusReason

Success/failure message associated with the resource.

description

String description

User defined description associated with the resource.

Class com.amazonaws.services.cloudformation.model.StackResourceDetail extends Object implements Serializable

Serialized Fields

stackName

String stackName

The name associated with the stack.

stackId

String stackId

Unique identifier of the stack.

logicalResourceId

String logicalResourceId

The logical name of the resource specified in the template.

physicalResourceId

String physicalResourceId

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

resourceType

String resourceType

Type of the resource. (For more information, go to the AWS CloudFormation User Guide.)

lastUpdatedTimestamp

Date lastUpdatedTimestamp

Time the status was updated.

resourceStatus

String resourceStatus

Current status of the resource.

Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE

resourceStatusReason

String resourceStatusReason

Success/failure message associated with the resource.

description

String description

User defined description associated with the resource.

metadata

String metadata

The JSON format content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the AWS CloudFormation User Guide.

Class com.amazonaws.services.cloudformation.model.StackResourceSummary extends Object implements Serializable

Serialized Fields

logicalResourceId

String logicalResourceId

The logical name of the resource specified in the template.

physicalResourceId

String physicalResourceId

The name or unique identifier that corresponds to a physical instance ID of the resource.

resourceType

String resourceType

Type of the resource. (For more information, go to the AWS CloudFormation User Guide.)

lastUpdatedTimestamp

Date lastUpdatedTimestamp

Time the status was updated.

resourceStatus

String resourceStatus

Current status of the resource.

Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE

resourceStatusReason

String resourceStatusReason

Success/failure message associated with the resource.

Class com.amazonaws.services.cloudformation.model.StackSummary extends Object implements Serializable

Serialized Fields

stackId

String stackId

Unique stack identifier.

stackName

String stackName

The name associated with the stack.

templateDescription

String templateDescription

The template description of the template used to create the stack.

creationTime

Date creationTime

The time the stack was created.

lastUpdatedTime

Date lastUpdatedTime

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

deletionTime

Date deletionTime

The time the stack was deleted.

stackStatus

String stackStatus

The current status of the stack.

Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE

stackStatusReason

String stackStatusReason

Success/Failure message associated with the stack status.

Class com.amazonaws.services.cloudformation.model.Tag extends Object implements Serializable

Serialized Fields

key

String key

Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws:.

value

String value

Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

Class com.amazonaws.services.cloudformation.model.TemplateParameter extends Object implements Serializable

Serialized Fields

parameterKey

String parameterKey

The name associated with the parameter.

defaultValue

String defaultValue

The default value associated with the parameter.

noEcho

Boolean noEcho

Flag indicating whether the parameter should be displayed as plain text in logs and UIs.

description

String description

User defined description associated with the parameter.

Class com.amazonaws.services.cloudformation.model.UpdateStackRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackName

String stackName

The name or stack ID of the stack to update. Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters.

templateBody

String templateBody

Structure containing the template body. (For more information, go to the AWS CloudFormation User Guide.)

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

Constraints:
Length: 1 - 51200

templateURL

String templateURL

Location of file containing the template body. The URL must point to a template located in an S3 bucket in the same region as the stack. For more information, go to the AWS CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Constraints:
Length: 1 - 1024

parameters

List<E> parameters

A list of Parameter structures that specify input parameters for the stack.

capabilities

List<E> capabilities

The list of capabilities that you want to allow in the stack. If your stack contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter; otherwise, this action returns an InsufficientCapabilities error. IAM resources are the following: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::User, and AWS::IAM::UserToGroupAddition.

Class com.amazonaws.services.cloudformation.model.UpdateStackResult extends Object implements Serializable

Serialized Fields

stackId

String stackId

Unique identifier of the stack.

Class com.amazonaws.services.cloudformation.model.ValidateTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

templateBody

String templateBody

String containing the template body. (For more information, go to the AWS CloudFormation User Guide.)

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Constraints:
Length: 1 - 51200

templateURL

String templateURL

Location of file containing the template body. The URL must point to a template (max size: 307,200 bytes) located in an S3 bucket in the same region as the stack. For more information, go to the AWS CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Constraints:
Length: 1 - 1024

Class com.amazonaws.services.cloudformation.model.ValidateTemplateResult extends Object implements Serializable

Serialized Fields

parameters

List<E> parameters

A list of TemplateParameter structures.

description

String description

The description found within the template.

capabilities

List<E> capabilities

The capabitilites found within the template. Currently, CAPABILITY_IAM is the only capability detected. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

capabilitiesReason

String capabilitiesReason

The capabilities reason found within the template.

Package com.amazonaws.services.cloudfront_2012_03_15.model

Class com.amazonaws.services.cloudfront_2012_03_15.model.AccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.BatchTooLargeException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.CloudFrontOriginAccessIdentityAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.CloudFrontOriginAccessIdentityInUseException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.CNAMEAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.DistributionAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.DistributionNotDisabledException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.IllegalUpdateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.InvalidArgumentException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.InvalidDefaultRootObjectException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.InvalidIfMatchVersionException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.InvalidOriginAccessIdentityException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.InvalidOriginException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.InvalidRequiredProtocolException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.MissingBodyException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.NoSuchCloudFrontOriginAccessIdentityException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.NoSuchDistributionException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.NoSuchInvalidationException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.NoSuchStreamingDistributionException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.PreconditionFailedException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.StreamingDistributionAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.StreamingDistributionNotDisabledException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.TooManyCloudFrontOriginAccessIdentitiesException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.TooManyDistributionCNAMEsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.TooManyDistributionsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.TooManyInvalidationsInProgressException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.TooManyStreamingDistributionCNAMEsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.TooManyStreamingDistributionsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.TooManyTrustedSignersException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront_2012_03_15.model.TrustedSignerDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Package com.amazonaws.services.cloudfront.model

Class com.amazonaws.services.cloudfront.model.AccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.ActiveTrustedSigners extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

Each active trusted signer.

quantity

Integer quantity

The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3.

items

List<E> items

A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors.

Class com.amazonaws.services.cloudfront.model.Aliases extends Object implements Serializable

Serialized Fields

quantity

Integer quantity

The number of CNAMEs, if any, for this distribution.

items

List<E> items

Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items.

Class com.amazonaws.services.cloudfront.model.BatchTooLargeException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.CacheBehavior extends Object implements Serializable

Serialized Fields

pathPattern

String pathPattern

The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

targetOriginId

String targetOriginId

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.

forwardedValues

ForwardedValues forwardedValues

A complex type that specifies how CloudFront handles query strings and cookies.

trustedSigners

TrustedSigners trustedSigners

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

viewerProtocolPolicy

String viewerProtocolPolicy

Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https.

Constraints:
Allowed Values: allow-all, https-only

minTTL

Long minTTL

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years).

Class com.amazonaws.services.cloudfront.model.CacheBehaviors extends Object implements Serializable

Serialized Fields

quantity

Integer quantity

The number of cache behaviors for this distribution.

items

List<E> items

Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items.

Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentity extends Object implements Serializable

Serialized Fields

id

String id

The ID for the origin access identity. For example: E74FTE3AJFJ256A.

s3CanonicalUserId

String s3CanonicalUserId

The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.

cloudFrontOriginAccessIdentityConfig

CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig

The current configuration information for the identity.

Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentityAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentityConfig extends Object implements Serializable

Serialized Fields

callerReference

String callerReference

A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

comment

String comment

Any comments you want to include about the origin access identity.

Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentityInUseException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentityList extends Object implements Serializable

Serialized Fields

marker

String marker

The value you provided for the Marker request parameter.

nextMarker

String nextMarker

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off.

maxItems

Integer maxItems

The value you provided for the MaxItems request parameter.

isTruncated

Boolean isTruncated

A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list.

quantity

Integer quantity

The number of CloudFront origin access identities that were created by the current AWS account.

items

List<E> items

A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account.

Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentitySummary extends Object implements Serializable

Serialized Fields

id

String id

The ID for the origin access identity. For example: E74FTE3AJFJ256A.

s3CanonicalUserId

String s3CanonicalUserId

The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.

comment

String comment

The comment for this origin access identity, as originally specified when created.

Class com.amazonaws.services.cloudfront.model.CNAMEAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.CookieNames extends Object implements Serializable

Serialized Fields

quantity

Integer quantity

The number of whitelisted cookies for this cache behavior.

items

List<E> items

Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items.

Class com.amazonaws.services.cloudfront.model.CookiePreference extends Object implements Serializable

Serialized Fields

forward

String forward

Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses.

Constraints:
Allowed Values: none, whitelist, all

whitelistedNames

CookieNames whitelistedNames

A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior.

Class com.amazonaws.services.cloudfront.model.CreateCloudFrontOriginAccessIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cloudFrontOriginAccessIdentityConfig

CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig

The origin access identity's configuration information.

Class com.amazonaws.services.cloudfront.model.CreateCloudFrontOriginAccessIdentityResult extends Object implements Serializable

Serialized Fields

cloudFrontOriginAccessIdentity

CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity

The origin access identity's information.

location

String location

The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.

eTag

String eTag

The current version of the origin access identity created.

Class com.amazonaws.services.cloudfront.model.CreateDistributionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

distributionConfig

DistributionConfig distributionConfig

The distribution's configuration information.

Class com.amazonaws.services.cloudfront.model.CreateDistributionResult extends Object implements Serializable

Serialized Fields

distribution

Distribution distribution

The distribution's information.

location

String location

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

eTag

String eTag

The current version of the distribution created.

Class com.amazonaws.services.cloudfront.model.CreateInvalidationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

distributionId

String distributionId

The distribution's id.

invalidationBatch

InvalidationBatch invalidationBatch

The batch information for the invalidation.

Class com.amazonaws.services.cloudfront.model.CreateInvalidationResult extends Object implements Serializable

Serialized Fields

location

String location

The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.

invalidation

Invalidation invalidation

The invalidation's information.

Class com.amazonaws.services.cloudfront.model.CreateStreamingDistributionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamingDistributionConfig

StreamingDistributionConfig streamingDistributionConfig

The streaming distribution's configuration information.

Class com.amazonaws.services.cloudfront.model.CreateStreamingDistributionResult extends Object implements Serializable

Serialized Fields

streamingDistribution

StreamingDistribution streamingDistribution

The streaming distribution's information.

location

String location

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

eTag

String eTag

The current version of the streaming distribution created.

Class com.amazonaws.services.cloudfront.model.CustomOriginConfig extends Object implements Serializable

Serialized Fields

hTTPPort

Integer hTTPPort

The HTTP port the custom origin listens on.

hTTPSPort

Integer hTTPSPort

The HTTPS port the custom origin listens on.

originProtocolPolicy

String originProtocolPolicy

The origin protocol policy to apply to your origin.

Constraints:
Allowed Values: http-only, match-viewer

Class com.amazonaws.services.cloudfront.model.DefaultCacheBehavior extends Object implements Serializable

Serialized Fields

targetOriginId

String targetOriginId

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.

forwardedValues

ForwardedValues forwardedValues

A complex type that specifies how CloudFront handles query strings and cookies.

trustedSigners

TrustedSigners trustedSigners

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

viewerProtocolPolicy

String viewerProtocolPolicy

Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https.

Constraints:
Allowed Values: allow-all, https-only

minTTL

Long minTTL

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years).

Class com.amazonaws.services.cloudfront.model.DeleteCloudFrontOriginAccessIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The origin access identity's id.

ifMatch

String ifMatch

The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.

Class com.amazonaws.services.cloudfront.model.DeleteDistributionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The distribution id.

ifMatch

String ifMatch

The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.

Class com.amazonaws.services.cloudfront.model.DeleteStreamingDistributionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The distribution id.

ifMatch

String ifMatch

The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.

Class com.amazonaws.services.cloudfront.model.Distribution extends Object implements Serializable

Serialized Fields

id

String id

The identifier for the distribution. For example: EDFDVBD632BHDS5.

status

String status

This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.

lastModifiedTime

Date lastModifiedTime

The date and time the distribution was last modified.

inProgressInvalidationBatches

Integer inProgressInvalidationBatches

The number of invalidation batches currently in progress.

domainName

String domainName

The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.

activeTrustedSigners

ActiveTrustedSigners activeTrustedSigners

CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.

distributionConfig

DistributionConfig distributionConfig

The current configuration information for the distribution.

Class com.amazonaws.services.cloudfront.model.DistributionAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.DistributionConfig extends Object implements Serializable

Serialized Fields

callerReference

String callerReference

A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

aliases

Aliases aliases

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

defaultRootObject

String defaultRootObject

The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object.

origins

Origins origins

A complex type that contains information about origins for this distribution.

defaultCacheBehavior

DefaultCacheBehavior defaultCacheBehavior

A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior.

cacheBehaviors

CacheBehaviors cacheBehaviors

A complex type that contains zero or more CacheBehavior elements.

comment

String comment

Any comments you want to include about the distribution.

logging

LoggingConfig logging

A complex type that controls whether access logs are written for the distribution.

priceClass

String priceClass

A complex type that contains information about price class for this distribution.

Constraints:
Allowed Values: PriceClass_100, PriceClass_200, PriceClass_All

enabled

Boolean enabled

Whether the distribution is enabled to accept end user requests for content.

Class com.amazonaws.services.cloudfront.model.DistributionList extends Object implements Serializable

Serialized Fields

marker

String marker

The value you provided for the Marker request parameter.

nextMarker

String nextMarker

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off.

maxItems

Integer maxItems

The value you provided for the MaxItems request parameter.

isTruncated

Boolean isTruncated

A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

quantity

Integer quantity

The number of distributions that were created by the current AWS account.

items

List<E> items

A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account.

Class com.amazonaws.services.cloudfront.model.DistributionNotDisabledException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.DistributionSummary extends Object implements Serializable

Serialized Fields

id

String id

The identifier for the distribution. For example: EDFDVBD632BHDS5.

status

String status

This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.

lastModifiedTime

Date lastModifiedTime

The date and time the distribution was last modified.

domainName

String domainName

The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.

aliases

Aliases aliases

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

origins

Origins origins

A complex type that contains information about origins for this distribution.

defaultCacheBehavior

DefaultCacheBehavior defaultCacheBehavior

A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior.

cacheBehaviors

CacheBehaviors cacheBehaviors

A complex type that contains zero or more CacheBehavior elements.

comment

String comment

The comment originally specified when this distribution was created.

priceClass

String priceClass

enabled

Boolean enabled

Whether the distribution is enabled to accept end user requests for content.

Class com.amazonaws.services.cloudfront.model.ForwardedValues extends Object implements Serializable

Serialized Fields

queryString

Boolean queryString

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false.

cookies

CookiePreference cookies

A complex type that specifies how CloudFront handles cookies.

Class com.amazonaws.services.cloudfront.model.GetCloudFrontOriginAccessIdentityConfigRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The identity's id.

Class com.amazonaws.services.cloudfront.model.GetCloudFrontOriginAccessIdentityConfigResult extends Object implements Serializable

Serialized Fields

cloudFrontOriginAccessIdentityConfig

CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig

The origin access identity's configuration information.

eTag

String eTag

The current version of the configuration. For example: E2QWRUHAPOMQZL.

Class com.amazonaws.services.cloudfront.model.GetCloudFrontOriginAccessIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The identity's id.

Class com.amazonaws.services.cloudfront.model.GetCloudFrontOriginAccessIdentityResult extends Object implements Serializable

Serialized Fields

cloudFrontOriginAccessIdentity

CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity

The origin access identity's information.

eTag

String eTag

The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.

Class com.amazonaws.services.cloudfront.model.GetDistributionConfigRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The distribution's id.

Class com.amazonaws.services.cloudfront.model.GetDistributionConfigResult extends Object implements Serializable

Serialized Fields

distributionConfig

DistributionConfig distributionConfig

The distribution's configuration information.

eTag

String eTag

The current version of the configuration. For example: E2QWRUHAPOMQZL.

Class com.amazonaws.services.cloudfront.model.GetDistributionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The distribution's id.

Class com.amazonaws.services.cloudfront.model.GetDistributionResult extends Object implements Serializable

Serialized Fields

distribution

Distribution distribution

The distribution's information.

eTag

String eTag

The current version of the distribution's information. For example: E2QWRUHAPOMQZL.

Class com.amazonaws.services.cloudfront.model.GetInvalidationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

distributionId

String distributionId

The distribution's id.

id

String id

The invalidation's id.

Class com.amazonaws.services.cloudfront.model.GetInvalidationResult extends Object implements Serializable

Serialized Fields

invalidation

Invalidation invalidation

The invalidation's information.

Class com.amazonaws.services.cloudfront.model.GetStreamingDistributionConfigRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The streaming distribution's id.

Class com.amazonaws.services.cloudfront.model.GetStreamingDistributionConfigResult extends Object implements Serializable

Serialized Fields

streamingDistributionConfig

StreamingDistributionConfig streamingDistributionConfig

The streaming distribution's configuration information.

eTag

String eTag

The current version of the configuration. For example: E2QWRUHAPOMQZL.

Class com.amazonaws.services.cloudfront.model.GetStreamingDistributionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The streaming distribution's id.

Class com.amazonaws.services.cloudfront.model.GetStreamingDistributionResult extends Object implements Serializable

Serialized Fields

streamingDistribution

StreamingDistribution streamingDistribution

The streaming distribution's information.

eTag

String eTag

The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.

Class com.amazonaws.services.cloudfront.model.IllegalUpdateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.InconsistentQuantitiesException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.InvalidArgumentException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.Invalidation extends Object implements Serializable

Serialized Fields

id

String id

The identifier for the invalidation request. For example: IDFDVBD632BHDS5.

status

String status

The status of the invalidation request. When the invalidation batch is finished, the status is Completed.

createTime

Date createTime

The date and time the invalidation request was first made.

invalidationBatch

InvalidationBatch invalidationBatch

The current invalidation information for the batch request.

Class com.amazonaws.services.cloudfront.model.InvalidationBatch extends Object implements Serializable

Serialized Fields

paths

Paths paths

The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags. If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object.

callerReference

String callerReference

A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request, the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.

Class com.amazonaws.services.cloudfront.model.InvalidationList extends Object implements Serializable

Serialized Fields

marker

String marker

The value you provided for the Marker request parameter.

nextMarker

String nextMarker

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your invalidation batches where they left off.

maxItems

Integer maxItems

The value you provided for the MaxItems request parameter.

isTruncated

Boolean isTruncated

A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list.

quantity

Integer quantity

The number of invalidation batches that were created by the current AWS account.

items

List<E> items

A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account.

Class com.amazonaws.services.cloudfront.model.InvalidationSummary extends Object implements Serializable

Serialized Fields

id

String id

The unique ID for an invalidation request.

createTime

Date createTime

status

String status

The status of an invalidation request.

Class com.amazonaws.services.cloudfront.model.InvalidDefaultRootObjectException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.InvalidForwardCookiesException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.InvalidIfMatchVersionException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.InvalidOriginAccessIdentityException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.InvalidOriginException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.InvalidRequiredProtocolException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.KeyPairIds extends Object implements Serializable

Serialized Fields

quantity

Integer quantity

The number of active CloudFront key pairs for AwsAccountNumber.

items

List<E> items

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

Class com.amazonaws.services.cloudfront.model.ListCloudFrontOriginAccessIdentitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

marker

String marker

Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).

maxItems

String maxItems

The maximum number of origin access identities you want in the response body.

Class com.amazonaws.services.cloudfront.model.ListCloudFrontOriginAccessIdentitiesResult extends Object implements Serializable

Serialized Fields

cloudFrontOriginAccessIdentityList

CloudFrontOriginAccessIdentityList cloudFrontOriginAccessIdentityList

The CloudFrontOriginAccessIdentityList type.

Class com.amazonaws.services.cloudfront.model.ListDistributionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

marker

String marker

Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).

maxItems

String maxItems

The maximum number of distributions you want in the response body.

Class com.amazonaws.services.cloudfront.model.ListDistributionsResult extends Object implements Serializable

Serialized Fields

distributionList

DistributionList distributionList

The DistributionList type.

Class com.amazonaws.services.cloudfront.model.ListInvalidationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

distributionId

String distributionId

The distribution's id.

marker

String marker

Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.

maxItems

String maxItems

The maximum number of invalidation batches you want in the response body.

Class com.amazonaws.services.cloudfront.model.ListInvalidationsResult extends Object implements Serializable

Serialized Fields

invalidationList

InvalidationList invalidationList

Information about invalidation batches.

Class com.amazonaws.services.cloudfront.model.ListStreamingDistributionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

marker

String marker

Use this when paginating results to indicate where to begin in your list of streaming distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).

maxItems

String maxItems

The maximum number of streaming distributions you want in the response body.

Class com.amazonaws.services.cloudfront.model.ListStreamingDistributionsResult extends Object implements Serializable

Serialized Fields

streamingDistributionList

StreamingDistributionList streamingDistributionList

The StreamingDistributionList type.

Class com.amazonaws.services.cloudfront.model.LoggingConfig extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted.

includeCookies

Boolean includeCookies

Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies.

bucket

String bucket

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

prefix

String prefix

An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element.

Class com.amazonaws.services.cloudfront.model.MissingBodyException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.NoSuchCloudFrontOriginAccessIdentityException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.NoSuchDistributionException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.NoSuchInvalidationException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.NoSuchOriginException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.NoSuchStreamingDistributionException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.Origin extends Object implements Serializable

Serialized Fields

id

String id

A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior.

domainName

String domainName

Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.

s3OriginConfig

S3OriginConfig s3OriginConfig

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

customOriginConfig

CustomOriginConfig customOriginConfig

A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead.

Class com.amazonaws.services.cloudfront.model.Origins extends Object implements Serializable

Serialized Fields

quantity

Integer quantity

The number of origins for this distribution.

items

List<E> items

A complex type that contains origins for this distribution.

Constraints:
Length: 1 -

Class com.amazonaws.services.cloudfront.model.Paths extends Object implements Serializable

Serialized Fields

quantity

Integer quantity

The number of objects that you want to invalidate.

items

List<E> items

A complex type that contains a list of the objects that you want to invalidate.

Class com.amazonaws.services.cloudfront.model.PreconditionFailedException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.S3Origin extends Object implements Serializable

Serialized Fields

domainName

String domainName

The DNS name of the S3 origin.

originAccessIdentity

String originAccessIdentity

Your S3 origin's origin access identity.

Class com.amazonaws.services.cloudfront.model.S3OriginConfig extends Object implements Serializable

Serialized Fields

originAccessIdentity

String originAccessIdentity

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

Class com.amazonaws.services.cloudfront.model.Signer extends Object implements Serializable

Serialized Fields

awsAccountNumber

String awsAccountNumber

Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number.

keyPairIds

KeyPairIds keyPairIds

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

Class com.amazonaws.services.cloudfront.model.StreamingDistribution extends Object implements Serializable

Serialized Fields

id

String id

The identifier for the streaming distribution. For example: EGTXBD79H29TRA8.

status

String status

The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.

lastModifiedTime

Date lastModifiedTime

The date and time the distribution was last modified.

domainName

String domainName

The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net.

activeTrustedSigners

ActiveTrustedSigners activeTrustedSigners

CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.

streamingDistributionConfig

StreamingDistributionConfig streamingDistributionConfig

The current configuration information for the streaming distribution.

Class com.amazonaws.services.cloudfront.model.StreamingDistributionAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.StreamingDistributionConfig extends Object implements Serializable

Serialized Fields

callerReference

String callerReference

A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

s3Origin

S3Origin s3Origin

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

aliases

Aliases aliases

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

comment

String comment

Any comments you want to include about the streaming distribution.

logging

StreamingLoggingConfig logging

A complex type that controls whether access logs are written for the streaming distribution.

trustedSigners

TrustedSigners trustedSigners

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

priceClass

String priceClass

A complex type that contains information about price class for this streaming distribution.

Constraints:
Allowed Values: PriceClass_100, PriceClass_200, PriceClass_All

enabled

Boolean enabled

Whether the streaming distribution is enabled to accept end user requests for content.

Class com.amazonaws.services.cloudfront.model.StreamingDistributionList extends Object implements Serializable

Serialized Fields

marker

String marker

The value you provided for the Marker request parameter.

nextMarker

String nextMarker

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your streaming distributions where they left off.

maxItems

Integer maxItems

The value you provided for the MaxItems request parameter.

isTruncated

Boolean isTruncated

A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

quantity

Integer quantity

The number of streaming distributions that were created by the current AWS account.

items

List<E> items

A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account.

Class com.amazonaws.services.cloudfront.model.StreamingDistributionNotDisabledException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.StreamingDistributionSummary extends Object implements Serializable

Serialized Fields

id

String id

The identifier for the distribution. For example: EDFDVBD632BHDS5.

status

String status

Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.

lastModifiedTime

Date lastModifiedTime

The date and time the distribution was last modified.

domainName

String domainName

The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.

s3Origin

S3Origin s3Origin

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

aliases

Aliases aliases

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

trustedSigners

TrustedSigners trustedSigners

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

comment

String comment

The comment originally specified when this distribution was created.

priceClass

String priceClass

enabled

Boolean enabled

Whether the distribution is enabled to accept end user requests for content.

Class com.amazonaws.services.cloudfront.model.StreamingLoggingConfig extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.

bucket

String bucket

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

prefix

String prefix

An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element.

Class com.amazonaws.services.cloudfront.model.TooManyCacheBehaviorsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.TooManyCloudFrontOriginAccessIdentitiesException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.TooManyCookieNamesInWhiteListException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.TooManyDistributionCNAMEsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.TooManyDistributionsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.TooManyInvalidationsInProgressException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.TooManyOriginsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.TooManyStreamingDistributionCNAMEsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.TooManyStreamingDistributionsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.TooManyTrustedSignersException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.TrustedSignerDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudfront.model.TrustedSigners extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId.

quantity

Integer quantity

The number of trusted signers for this cache behavior.

items

List<E> items

Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items.

Class com.amazonaws.services.cloudfront.model.UpdateCloudFrontOriginAccessIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cloudFrontOriginAccessIdentityConfig

CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig

The identity's configuration information.

id

String id

The identity's id.

ifMatch

String ifMatch

The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.

Class com.amazonaws.services.cloudfront.model.UpdateCloudFrontOriginAccessIdentityResult extends Object implements Serializable

Serialized Fields

cloudFrontOriginAccessIdentity

CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity

The origin access identity's information.

eTag

String eTag

The current version of the configuration. For example: E2QWRUHAPOMQZL.

Class com.amazonaws.services.cloudfront.model.UpdateDistributionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

distributionConfig

DistributionConfig distributionConfig

The distribution's configuration information.

id

String id

The distribution's id.

ifMatch

String ifMatch

The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.

Class com.amazonaws.services.cloudfront.model.UpdateDistributionResult extends Object implements Serializable

Serialized Fields

distribution

Distribution distribution

The distribution's information.

eTag

String eTag

The current version of the configuration. For example: E2QWRUHAPOMQZL.

Class com.amazonaws.services.cloudfront.model.UpdateStreamingDistributionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamingDistributionConfig

StreamingDistributionConfig streamingDistributionConfig

The streaming distribution's configuration information.

id

String id

The streaming distribution's id.

ifMatch

String ifMatch

The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.

Class com.amazonaws.services.cloudfront.model.UpdateStreamingDistributionResult extends Object implements Serializable

Serialized Fields

streamingDistribution

StreamingDistribution streamingDistribution

The streaming distribution's information.

eTag

String eTag

The current version of the configuration. For example: E2QWRUHAPOMQZL.

Package com.amazonaws.services.cloudsearch.model

Class com.amazonaws.services.cloudsearch.model.AccessPoliciesStatus extends Object implements Serializable

Serialized Fields

options

String options

An IAM access policy as described in The Access Policy Language in Using AWS Identity and Access Management. The maximum size of an access policy document is 100KB.

Example: {"Statement": [{"Effect":"Allow", "Action": "*", "Resource": "arn:aws:cs:us-east-1:1234567890:search/movies", "Condition": { "IpAddress": { aws:SourceIp": ["203.0.113.1/32"] } }}, {"Effect":"Allow", "Action": "*", "Resource": "arn:aws:cs:us-east-1:1234567890:documents/movies", "Condition": { "IpAddress": { aws:SourceIp": ["203.0.113.1/32"] } }} ] }

status

OptionStatus status

The status of an option, including when it was last updated and whether it is actively in use for searches.

Class com.amazonaws.services.cloudsearch.model.BaseException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

code

String code

Class com.amazonaws.services.cloudsearch.model.CreateDomainRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

Class com.amazonaws.services.cloudsearch.model.CreateDomainResult extends Object implements Serializable

Serialized Fields

domainStatus

DomainStatus domainStatus

The current status of the search domain.

Class com.amazonaws.services.cloudsearch.model.DefaultSearchFieldStatus extends Object implements Serializable

Serialized Fields

options

String options

The name of the IndexField to use as the default search field. The default is an empty string, which automatically searches all text fields.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

status

OptionStatus status

The status of an option, including when it was last updated and whether it is actively in use for searches.

Class com.amazonaws.services.cloudsearch.model.DefineIndexFieldRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

indexField

IndexField indexField

Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than the IndexFieldType.

Class com.amazonaws.services.cloudsearch.model.DefineIndexFieldResult extends Object implements Serializable

Serialized Fields

indexField

IndexFieldStatus indexField

The value of an IndexField and its current status.

Class com.amazonaws.services.cloudsearch.model.DefineRankExpressionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

rankExpression

NamedRankExpression rankExpression

A named expression that can be evaluated at search time and used for ranking or thresholding in a search query.

Class com.amazonaws.services.cloudsearch.model.DefineRankExpressionResult extends Object implements Serializable

Serialized Fields

rankExpression

RankExpressionStatus rankExpression

The value of a RankExpression and its current status.

Class com.amazonaws.services.cloudsearch.model.DeleteDomainRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

Class com.amazonaws.services.cloudsearch.model.DeleteDomainResult extends Object implements Serializable

Serialized Fields

domainStatus

DomainStatus domainStatus

The current status of the search domain.

Class com.amazonaws.services.cloudsearch.model.DeleteIndexFieldRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

indexFieldName

String indexFieldName

A string that represents the name of an index field. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

Class com.amazonaws.services.cloudsearch.model.DeleteIndexFieldResult extends Object implements Serializable

Serialized Fields

indexField

IndexFieldStatus indexField

The value of an IndexField and its current status.

Class com.amazonaws.services.cloudsearch.model.DeleteRankExpressionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

rankName

String rankName

The name of the RankExpression to delete.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

Class com.amazonaws.services.cloudsearch.model.DeleteRankExpressionResult extends Object implements Serializable

Serialized Fields

rankExpression

RankExpressionStatus rankExpression

The value of a RankExpression and its current status.

Class com.amazonaws.services.cloudsearch.model.DescribeDefaultSearchFieldRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

Class com.amazonaws.services.cloudsearch.model.DescribeDefaultSearchFieldResult extends Object implements Serializable

Serialized Fields

defaultSearchField

DefaultSearchFieldStatus defaultSearchField

The name of the IndexField to use for search requests issued with the q parameter. The default is the empty string, which automatically searches all text fields.

Class com.amazonaws.services.cloudsearch.model.DescribeDomainsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainNames

List<E> domainNames

Limits the DescribeDomains response to the specified search domains.

Class com.amazonaws.services.cloudsearch.model.DescribeDomainsResult extends Object implements Serializable

Serialized Fields

domainStatusList

List<E> domainStatusList

The current status of all of your search domains.

Class com.amazonaws.services.cloudsearch.model.DescribeIndexFieldsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

fieldNames

List<E> fieldNames

Limits the DescribeIndexFields response to the specified fields.

Class com.amazonaws.services.cloudsearch.model.DescribeIndexFieldsResult extends Object implements Serializable

Serialized Fields

indexFields

List<E> indexFields

The index fields configured for the domain.

Class com.amazonaws.services.cloudsearch.model.DescribeRankExpressionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

rankNames

List<E> rankNames

Limits the DescribeRankExpressions response to the specified fields.

Class com.amazonaws.services.cloudsearch.model.DescribeRankExpressionsResult extends Object implements Serializable

Serialized Fields

rankExpressions

List<E> rankExpressions

The rank expressions configured for the domain.

Class com.amazonaws.services.cloudsearch.model.DescribeServiceAccessPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

Class com.amazonaws.services.cloudsearch.model.DescribeServiceAccessPoliciesResult extends Object implements Serializable

Serialized Fields

accessPolicies

AccessPoliciesStatus accessPolicies

A PolicyDocument that specifies access policies for the search domain's services, and the current status of those policies.

Class com.amazonaws.services.cloudsearch.model.DescribeStemmingOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

Class com.amazonaws.services.cloudsearch.model.DescribeStemmingOptionsResult extends Object implements Serializable

Serialized Fields

stems

StemmingOptionsStatus stems

The stemming options configured for this search domain and the current status of those options.

Class com.amazonaws.services.cloudsearch.model.DescribeStopwordOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

Class com.amazonaws.services.cloudsearch.model.DescribeStopwordOptionsResult extends Object implements Serializable

Serialized Fields

stopwords

StopwordOptionsStatus stopwords

The stopword options configured for this search domain and the current status of those options.

Class com.amazonaws.services.cloudsearch.model.DescribeSynonymOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

Class com.amazonaws.services.cloudsearch.model.DescribeSynonymOptionsResult extends Object implements Serializable

Serialized Fields

synonyms

SynonymOptionsStatus synonyms

The synonym options configured for this search domain and the current status of those options.

Class com.amazonaws.services.cloudsearch.model.DomainStatus extends Object implements Serializable

Serialized Fields

domainId

String domainId

An internally generated unique identifier for a domain.

Constraints:
Length: 1 - 64

domainName

String domainName

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

created

Boolean created

True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.

deleted

Boolean deleted

True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.

numSearchableDocs

Integer numSearchableDocs

The number of documents that have been submitted to the domain and indexed.

Constraints:
Range: 0 -

docService

ServiceEndpoint docService

The service endpoint for updating documents in a search domain.

searchService

ServiceEndpoint searchService

The service endpoint for requesting search results from a search domain.

requiresIndexDocuments

Boolean requiresIndexDocuments

True if IndexDocuments needs to be called to activate the current domain configuration.

processing

Boolean processing

True if processing is being done to activate the current domain configuration.

searchInstanceType

String searchInstanceType

The instance type that is being used to process search requests.

Constraints:
Allowed Values: SearchInstance:t1.micro, SearchInstance:m1.small, SearchInstance:m1.large, SearchInstance:m2.xlarge

searchPartitionCount

Integer searchPartitionCount

The number of partitions across which the search index is spread.

Constraints:
Range: 1 -

searchInstanceCount

Integer searchInstanceCount

The number of search instances that are available to process search requests.

Constraints:
Range: 1 -

Class com.amazonaws.services.cloudsearch.model.IndexDocumentsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

Class com.amazonaws.services.cloudsearch.model.IndexDocumentsResult extends Object implements Serializable

Serialized Fields

fieldNames

List<E> fieldNames

The names of the fields that are currently being processed due to an IndexDocuments action.

Class com.amazonaws.services.cloudsearch.model.IndexField extends Object implements Serializable

Serialized Fields

indexFieldName

String indexFieldName

The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

indexFieldType

String indexFieldType

The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.

Constraints:
Allowed Values: uint, literal, text

uIntOptions

UIntOptions uIntOptions

Options for an unsigned integer field. Present if IndexFieldType specifies the field is of type unsigned integer.

literalOptions

LiteralOptions literalOptions

Options for literal field. Present if IndexFieldType specifies the field is of type literal.

textOptions

TextOptions textOptions

Options for text field. Present if IndexFieldType specifies the field is of type text.

sourceAttributes

List<E> sourceAttributes

An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this IndexField. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an IndexField.

Class com.amazonaws.services.cloudsearch.model.IndexFieldStatus extends Object implements Serializable

Serialized Fields

options

IndexField options

Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than the IndexFieldType.

status

OptionStatus status

The status of an option, including when it was last updated and whether it is actively in use for searches.

Class com.amazonaws.services.cloudsearch.model.InternalException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudsearch.model.InvalidTypeException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudsearch.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudsearch.model.LiteralOptions extends Object implements Serializable

Serialized Fields

defaultValue

String defaultValue

The default value for a literal field.

Constraints:
Length: 0 - 1024

searchEnabled

Boolean searchEnabled

Specifies whether search is enabled for this field.

facetEnabled

Boolean facetEnabled

Specifies whether facets are enabled for this field.

resultEnabled

Boolean resultEnabled

Specifies whether values of this field can be returned in search results and used for ranking.

Class com.amazonaws.services.cloudsearch.model.NamedRankExpression extends Object implements Serializable

Serialized Fields

rankName

String rankName

The name of a rank expression. Rank expression names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

rankExpression

String rankExpression

The expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:

• Integer, floating point, hex and octal literals
• Shortcut evaluation of logical operators such that an expression a || b evaluates to the value a if a is true without evaluting b at all
• JavaScript order of precendence for operators
• Arithmetic operators: + - * / %
• Boolean operators (including the ternary operator)
• Bitwise operators
• Comparison operators
• Common mathematic functions: abs ceil erf exp floor lgamma ln log2 log10 max min sqrt pow
• Trigonometric library functions: acosh acos asinh asin atanh atan cosh cos sinh sin tanh tan
• Random generation of a number between 0 and 1: rand
• Current time in epoch: time
• The min max functions that operate on a variable argument list

Intermediate results are calculated as double precision floating point values. The final return value of a RankExpression is automatically converted from floating point to a 32-bit unsigned integer by rounding to the nearest integer, with a natural floor of 0 and a ceiling of max(uint32_t), 4294967295. Mathematical errors such as dividing by 0 will fail during evaluation and return a value of 0.

The source data for a RankExpression can be the name of an IndexField of type uint, another RankExpression or the reserved name text_relevance. The text_relevance source is defined to return an integer from 0 to 1000 (inclusive) to indicate how relevant a document is to the search request, taking into account repetition of search terms in the document and proximity of search terms to each other in each matching IndexField in the document.

For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.

Constraints:
Length: 1 - 10240

Class com.amazonaws.services.cloudsearch.model.OptionStatus extends Object implements Serializable

Serialized Fields

creationDate

Date creationDate

A timestamp for when this option was created.

updateDate

Date updateDate

A timestamp for when this option was last updated.

updateVersion

Integer updateVersion

A unique integer that indicates when this option was last updated.

Constraints:
Range: 0 -

state

String state

The state of processing a change to an option. Possible values:

• RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
• Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
• Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.

Constraints:
Allowed Values: RequiresIndexDocuments, Processing, Active

Class com.amazonaws.services.cloudsearch.model.RankExpressionStatus extends Object implements Serializable

Serialized Fields

options

NamedRankExpression options

The expression that is evaluated for ranking or thresholding while processing a search request.

status

OptionStatus status

The status of an option, including when it was last updated and whether it is actively in use for searches.

Class com.amazonaws.services.cloudsearch.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudsearch.model.ServiceEndpoint extends Object implements Serializable

Serialized Fields

arn

String arn

An Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

endpoint

String endpoint

The URL (including /version/pathPrefix) to which service requests can be submitted.

Class com.amazonaws.services.cloudsearch.model.SourceAttribute extends Object implements Serializable

Serialized Fields

sourceDataFunction

String sourceDataFunction

Identifies the transformation to apply when copying data from a source attribute.

Constraints:
Allowed Values: Copy, TrimTitle, Map

sourceDataCopy

SourceData sourceDataCopy

Copies data from a source document attribute to an IndexField.

sourceDataTrimTitle

SourceDataTrimTitle sourceDataTrimTitle

Trims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.

sourceDataMap

SourceDataMap sourceDataMap

Maps source document attribute values to new values when populating the IndexField.

Class com.amazonaws.services.cloudsearch.model.SourceData extends Object implements Serializable

Serialized Fields

sourceName

String sourceName

The name of the document source field to add to this IndexField.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

defaultValue

String defaultValue

The value of a field or source document attribute.

Constraints:
Length: 0 - 1024

Class com.amazonaws.services.cloudsearch.model.SourceDataMap extends Object implements Serializable

Serialized Fields

sourceName

String sourceName

The name of the document source field to add to this IndexField.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

defaultValue

String defaultValue

The value of a field or source document attribute.

Constraints:
Length: 0 - 1024

cases

Map<K,V> cases

A map that translates source field values to custom values.

Class com.amazonaws.services.cloudsearch.model.SourceDataTrimTitle extends Object implements Serializable

Serialized Fields

sourceName

String sourceName

The name of the document source field to add to this IndexField.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

defaultValue

String defaultValue

The value of a field or source document attribute.

Constraints:
Length: 0 - 1024

separator

String separator

The separator that follows the text to trim.

language

String language

An IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.

Constraints:
Pattern: [a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*

Class com.amazonaws.services.cloudsearch.model.StemmingOptionsStatus extends Object implements Serializable

Serialized Fields

options

String options

Maps terms to their stems, serialized as a JSON document. The document has a single object with one property "stems" whose value is an object mapping terms to their stems. The maximum size of a stemming document is 500KB. Example: { "stems": {"people": "person", "walking": "walk"} }

status

OptionStatus status

The status of an option, including when it was last updated and whether it is actively in use for searches.

Class com.amazonaws.services.cloudsearch.model.StopwordOptionsStatus extends Object implements Serializable

Serialized Fields

options

String options

Lists stopwords serialized as a JSON document. The document has a single object with one property "stopwords" whose value is an array of strings. The maximum size of a stopwords document is 10KB. Example: { "stopwords": ["a", "an", "the", "of"] }

status

OptionStatus status

The status of an option, including when it was last updated and whether it is actively in use for searches.

Class com.amazonaws.services.cloudsearch.model.SynonymOptionsStatus extends Object implements Serializable

Serialized Fields

options

String options

Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property "synonyms" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100KB. Example: { "synonyms": {"cat": ["feline", "kitten"], "puppy": "dog"} }

status

OptionStatus status

The status of an option, including when it was last updated and whether it is actively in use for searches.

Class com.amazonaws.services.cloudsearch.model.TextOptions extends Object implements Serializable

Serialized Fields

defaultValue

String defaultValue

The default value for a text field.

Constraints:
Length: 0 - 1024

facetEnabled

Boolean facetEnabled

Specifies whether facets are enabled for this field.

resultEnabled

Boolean resultEnabled

Specifies whether values of this field can be returned in search results and used for ranking.

Class com.amazonaws.services.cloudsearch.model.UIntOptions extends Object implements Serializable

Serialized Fields

defaultValue

Integer defaultValue

The default value for an unsigned integer field.

Constraints:
Range: 0 -

Class com.amazonaws.services.cloudsearch.model.UpdateDefaultSearchFieldRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

defaultSearchField

String defaultSearchField

The IndexField to use for search requests issued with the q parameter. The default is an empty string, which automatically searches all text fields.

Class com.amazonaws.services.cloudsearch.model.UpdateDefaultSearchFieldResult extends Object implements Serializable

Serialized Fields

defaultSearchField

DefaultSearchFieldStatus defaultSearchField

The value of the DefaultSearchField configured for this search domain and its current status.

Class com.amazonaws.services.cloudsearch.model.UpdateServiceAccessPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

accessPolicies

String accessPolicies

An IAM access policy as described in The Access Policy Language in Using AWS Identity and Access Management. The maximum size of an access policy document is 100KB.

Example: {"Statement": [{"Effect":"Allow", "Action": "*", "Resource": "arn:aws:cs:us-east-1:1234567890:search/movies", "Condition": { "IpAddress": { aws:SourceIp": ["203.0.113.1/32"] } }}, {"Effect":"Allow", "Action": "*", "Resource": "arn:aws:cs:us-east-1:1234567890:documents/movies", "Condition": { "IpAddress": { aws:SourceIp": ["203.0.113.1/32"] } }} ] }

Class com.amazonaws.services.cloudsearch.model.UpdateServiceAccessPoliciesResult extends Object implements Serializable

Serialized Fields

accessPolicies

AccessPoliciesStatus accessPolicies

A PolicyDocument that specifies access policies for the search domain's services, and the current status of those policies.

Class com.amazonaws.services.cloudsearch.model.UpdateStemmingOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

stems

String stems

Maps terms to their stems, serialized as a JSON document. The document has a single object with one property "stems" whose value is an object mapping terms to their stems. The maximum size of a stemming document is 500KB. Example: { "stems": {"people": "person", "walking": "walk"} }

Class com.amazonaws.services.cloudsearch.model.UpdateStemmingOptionsResult extends Object implements Serializable

Serialized Fields

stems

StemmingOptionsStatus stems

The stemming options configured for this search domain and the current status of those options.

Class com.amazonaws.services.cloudsearch.model.UpdateStopwordOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

stopwords

String stopwords

Lists stopwords serialized as a JSON document. The document has a single object with one property "stopwords" whose value is an array of strings. The maximum size of a stopwords document is 10KB. Example: { "stopwords": ["a", "an", "the", "of"] }

Class com.amazonaws.services.cloudsearch.model.UpdateStopwordOptionsResult extends Object implements Serializable

Serialized Fields

stopwords

StopwordOptionsStatus stopwords

The stopword options configured for this search domain and the current status of those options.

Class com.amazonaws.services.cloudsearch.model.UpdateSynonymOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

synonyms

String synonyms

Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property "synonyms" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100KB. Example: { "synonyms": {"cat": ["feline", "kitten"], "puppy": "dog"} }

Class com.amazonaws.services.cloudsearch.model.UpdateSynonymOptionsResult extends Object implements Serializable

Serialized Fields

synonyms

SynonymOptionsStatus synonyms

The synonym options configured for this search domain and the current status of those options.

Package com.amazonaws.services.cloudwatch.model

Class com.amazonaws.services.cloudwatch.model.AlarmHistoryItem extends Object implements Serializable

Serialized Fields

alarmName

String alarmName

The descriptive name for the alarm.

Constraints:
Length: 1 - 255

timestamp

Date timestamp

The time stamp for the alarm history item.

historyItemType

String historyItemType

The type of alarm history item.

Constraints:
Allowed Values: ConfigurationUpdate, StateUpdate, Action

historySummary

String historySummary

A human-readable summary of the alarm history.

Constraints:
Length: 1 - 255

historyData

String historyData

Machine-readable data about the alarm in JSON format.

Constraints:
Length: 1 - 4095

Class com.amazonaws.services.cloudwatch.model.Datapoint extends Object implements Serializable

Serialized Fields

timestamp

Date timestamp

The time stamp used for the datapoint.

sampleCount

Double sampleCount

The number of metric values that contributed to the aggregate value of this datapoint.

average

Double average

The average of metric values that correspond to the datapoint.

sum

Double sum

The sum of metric values used for the datapoint.

minimum

Double minimum

The minimum metric value used for the datapoint.

maximum

Double maximum

The maximum of the metric value used for the datapoint.

unit

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

Class com.amazonaws.services.cloudwatch.model.DeleteAlarmsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

alarmNames

List<E> alarmNames

A list of alarms to be deleted.

Constraints:
Length: 0 - 100

Class com.amazonaws.services.cloudwatch.model.DescribeAlarmHistoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

alarmName

String alarmName

The name of the alarm.

Constraints:
Length: 1 - 255

historyItemType

String historyItemType

The type of alarm histories to retrieve.

Constraints:
Allowed Values: ConfigurationUpdate, StateUpdate, Action

startDate

Date startDate

The starting date to retrieve alarm history.

endDate

Date endDate

The ending date to retrieve alarm history.

maxRecords

Integer maxRecords

The maximum number of alarm history records to retrieve.

Constraints:
Range: 1 - 100

nextToken

String nextToken

The token returned by a previous call to indicate that there is more data available.

Class com.amazonaws.services.cloudwatch.model.DescribeAlarmHistoryResult extends Object implements Serializable

Serialized Fields

alarmHistoryItems

List<E> alarmHistoryItems

A list of alarm histories in JSON format.

nextToken

String nextToken

A string that marks the start of the next batch of returned results.

Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsForMetricRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

metricName

String metricName

The name of the metric.

Constraints:
Length: 1 - 255

namespace

String namespace

The namespace of the metric.

Constraints:
Length: 1 - 255
Pattern: [^:].*

statistic

String statistic

The statistic for the metric.

Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum

dimensions

List<E> dimensions

The list of dimensions associated with the metric.

Constraints:
Length: 0 - 10

period

Integer period

The period in seconds over which the statistic is applied.

Constraints:
Range: 60 -

unit

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

Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsForMetricResult extends Object implements Serializable

Serialized Fields

metricAlarms

List<E> metricAlarms

A list of information for each alarm with the specified metric.

Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

alarmNames

List<E> alarmNames

A list of alarm names to retrieve information for.

Constraints:
Length: 0 - 100

alarmNamePrefix

String alarmNamePrefix

The alarm name prefix. AlarmNames cannot be specified if this parameter is specified.

Constraints:
Length: 1 - 255

stateValue

String stateValue

The state value to be used in matching alarms.

Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA

actionPrefix

String actionPrefix

The action name prefix.

Constraints:
Length: 1 - 1024

maxRecords

Integer maxRecords

The maximum number of alarm descriptions to retrieve.

Constraints:
Range: 1 - 100

nextToken

String nextToken

The token returned by a previous call to indicate that there is more data available.

Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsResult extends Object implements Serializable

Serialized Fields

metricAlarms

List<E> metricAlarms

A list of information for the specified alarms.

nextToken

String nextToken

A string that marks the start of the next batch of returned results.

Class com.amazonaws.services.cloudwatch.model.Dimension extends Object implements Serializable

Serialized Fields

name

String name

The name of the dimension.

Constraints:
Length: 1 - 255

value

String value

The value representing the dimension measurement

Constraints:
Length: 1 - 255

Class com.amazonaws.services.cloudwatch.model.DimensionFilter extends Object implements Serializable

Serialized Fields

name

String name

The dimension name to be matched.

Constraints:
Length: 1 - 255

value

String value

The value of the dimension to be matched. Specifying a Name without specifying a Value returns all values associated with that Name.

Constraints:
Length: 1 - 255

Class com.amazonaws.services.cloudwatch.model.DisableAlarmActionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

alarmNames

List<E> alarmNames

The names of the alarms to disable actions for.

Constraints:
Length: 0 - 100

Class com.amazonaws.services.cloudwatch.model.EnableAlarmActionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

alarmNames

List<E> alarmNames

The names of the alarms to enable actions for.

Constraints:
Length: 0 - 100

Class com.amazonaws.services.cloudwatch.model.GetMetricStatisticsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

namespace

String namespace

The namespace of the metric.

Constraints:
Length: 1 - 255
Pattern: [^:].*

metricName

String metricName

The name of the metric.

Constraints:
Length: 1 - 255

dimensions

List<E> dimensions

A list of dimensions describing qualities of the metric.

Constraints:
Length: 0 - 10

startTime

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 specified start time is rounded down to the nearest value. Datapoints are returned for start times up to two weeks in the past. Specified start times that are more than two weeks in the past will not return datapoints for metrics that are older than two weeks.

endTime

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.

period

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 -

statistics

List<E> statistics

The metric statistics to return.

Constraints:
Length: 1 - 5

unit

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

Class com.amazonaws.services.cloudwatch.model.GetMetricStatisticsResult extends Object implements Serializable

Serialized Fields

label

String label

A label describing the specified metric.

datapoints

List<E> datapoints

The datapoints for the specified metric.

Class com.amazonaws.services.cloudwatch.model.InternalServiceException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudwatch.model.InvalidFormatException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudwatch.model.InvalidNextTokenException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudwatch.model.InvalidParameterCombinationException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudwatch.model.InvalidParameterValueException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudwatch.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudwatch.model.ListMetricsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

namespace

String namespace

The namespace to filter against.

Constraints:
Length: 1 - 255
Pattern: [^:].*

metricName

String metricName

The name of the metric to filter against.

Constraints:
Length: 1 - 255

dimensions

List<E> dimensions

A list of dimensions to filter against.

Constraints:
Length: 0 - 10

nextToken

String nextToken

The token returned by a previous call to indicate that there is more data available.

Class com.amazonaws.services.cloudwatch.model.ListMetricsResult extends Object implements Serializable

Serialized Fields

metrics

List<E> metrics

A list of metrics used to generate statistics for an AWS account.

nextToken

String nextToken

A string that marks the start of the next batch of returned results.

Class com.amazonaws.services.cloudwatch.model.Metric extends Object implements Serializable

Serialized Fields

namespace

String namespace

The namespace of the metric.

Constraints:
Length: 1 - 255
Pattern: [^:].*

metricName

String metricName

The name of the metric.

Constraints:
Length: 1 - 255

dimensions

List<E> dimensions

A list of dimensions associated with the metric.

Constraints:
Length: 0 - 10

Class com.amazonaws.services.cloudwatch.model.MetricAlarm extends Object implements Serializable

Serialized Fields

alarmName

String alarmName

The name of the alarm.

Constraints:
Length: 1 - 255

alarmArn

String alarmArn

The Amazon Resource Name (ARN) of the alarm.

Constraints:
Length: 1 - 1600

alarmDescription

String alarmDescription

The description for the alarm.

Constraints:
Length: 0 - 255

alarmConfigurationUpdatedTimestamp

Date alarmConfigurationUpdatedTimestamp

The time stamp of the last update to the alarm configuration.

actionsEnabled

Boolean actionsEnabled

Indicates whether actions should be executed during any changes to the alarm's state.

oKActions

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 Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.

Constraints:
Length: 0 - 5

alarmActions

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 Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.

Constraints:
Length: 0 - 5

insufficientDataActions

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 Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic or triggering an Auto Scaling policy.

Constraints:
Length: 0 - 5

stateValue

String stateValue

The state value for the alarm.

Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA

stateReason

String stateReason

A human-readable explanation for the alarm's state.

Constraints:
Length: 0 - 1023

stateReasonData

String stateReasonData

An explanation for the alarm's state in machine-readable JSON format

Constraints:
Length: 0 - 4000

stateUpdatedTimestamp

Date stateUpdatedTimestamp

The time stamp of the last update to the alarm's state.

metricName

String metricName

The name of the alarm's metric.

Constraints:
Length: 1 - 255

namespace

String namespace

The namespace of alarm's associated metric.

Constraints:
Length: 1 - 255
Pattern: [^:].*

statistic

String statistic

The statistic to apply to the alarm's associated metric.

Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum

dimensions

List<E> dimensions

The list of dimensions associated with the alarm's associated metric.

Constraints:
Length: 0 - 10

period

Integer period

The period in seconds over which the statistic is applied.

Constraints:
Range: 60 -

unit

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

evaluationPeriods

Integer evaluationPeriods

The number of periods over which data is compared to the specified threshold.

Constraints:
Range: 1 -

threshold

Double threshold

The value against which the specified statistic is compared.

comparisonOperator

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

Class com.amazonaws.services.cloudwatch.model.MetricDatum extends Object implements Serializable

Serialized Fields

metricName

String metricName

The name of the metric.

Constraints:
Length: 1 - 255

dimensions

List<E> dimensions

A list of dimensions associated with the metric.

Constraints:
Length: 0 - 10

timestamp

Date timestamp

The time stamp used for the metric. If not specified, the default value is set to the time the metric data was received.

value

Double value

The value for the metric. Although the Value parameter accepts numbers of type Double, Amazon CloudWatch truncates values with very large exponents. Values with base-10 exponents greater than 126 (1 x 10^126) are truncated. Likewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated.

statisticValues

StatisticSet statisticValues

A set of statistical values describing the metric.

unit

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

Class com.amazonaws.services.cloudwatch.model.MissingRequiredParameterException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudwatch.model.PutMetricAlarmRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

alarmName

String alarmName

The descriptive name for the alarm. This name must be unique within the user's AWS account

Constraints:
Length: 1 - 255

alarmDescription

String alarmDescription

The description for the alarm.

Constraints:
Length: 0 - 255

actionsEnabled

Boolean actionsEnabled

Indicates whether or not actions should be executed during any changes to the alarm's state.

oKActions

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 Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.

Constraints:
Length: 0 - 5

alarmActions

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 Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.

Constraints:
Length: 0 - 5

insufficientDataActions

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 Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.

Constraints:
Length: 0 - 5

metricName

String metricName

The name for the alarm's associated metric.

Constraints:
Length: 1 - 255

namespace

String namespace

The namespace for the alarm's associated metric.

Constraints:
Length: 1 - 255
Pattern: [^:].*

statistic

String statistic

The statistic to apply to the alarm's associated metric.

Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum

dimensions

List<E> dimensions

The dimensions for the alarm's associated metric.

Constraints:
Length: 0 - 10

period

Integer period

The period in seconds over which the specified statistic is applied.

Constraints:
Range: 60 -

unit

String unit

The unit for 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

evaluationPeriods

Integer evaluationPeriods

The number of periods over which data is compared to the specified threshold.

Constraints:
Range: 1 -

threshold

Double threshold

The value against which the specified statistic is compared.

comparisonOperator

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

Class com.amazonaws.services.cloudwatch.model.PutMetricDataRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

namespace

String namespace

The namespace for the metric data.

Constraints:
Length: 1 - 255
Pattern: [^:].*

metricData

List<E> metricData

A list of data describing the metric.

Class com.amazonaws.services.cloudwatch.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.cloudwatch.model.SetAlarmStateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

alarmName

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

stateValue

String stateValue

The value of the state.

Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA

stateReason

String stateReason

The reason that this alarm is set to this specific state (in human-readable text format)

Constraints:
Length: 0 - 1023

stateReasonData

String stateReasonData

The reason that this alarm is set to this specific state (in machine-readable JSON format)

Constraints:
Length: 0 - 4000

Class com.amazonaws.services.cloudwatch.model.StatisticSet extends Object implements Serializable

Serialized Fields

sampleCount

Double sampleCount

The number of samples used for the statistic set.

sum

Double sum

The sum of values for the sample set.

minimum

Double minimum

The minimum value of the sample set.

maximum

Double maximum

The maximum value of the sample set.

Package com.amazonaws.services.datapipeline.model

Class com.amazonaws.services.datapipeline.model.ActivatePipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The identifier of the pipeline to activate.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.datapipeline.model.ActivatePipelineResult extends Object implements Serializable

Class com.amazonaws.services.datapipeline.model.CreatePipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

The name of the new pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each new pipeline a unique pipeline identifier.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

uniqueId

String uniqueId

A unique identifier that you specify. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline. You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this parameter to ensure idempotency during repeated calls to CreatePipeline. For example, if the first call to CreatePipeline does not return a clear success, you can pass in the same unique identifier and pipeline name combination on a subsequent call to CreatePipeline. CreatePipeline ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline will not be created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique identifier combination is scoped to the AWS account or IAM user credentials.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

description

String description

The description of the new pipeline.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.datapipeline.model.CreatePipelineResult extends Object implements Serializable

Serialized Fields

pipelineId

String pipelineId

The ID that AWS Data Pipeline assigns the newly created pipeline. The ID is a string of the form: df-06372391ZG65EXAMPLE.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.datapipeline.model.DeletePipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The identifier of the pipeline to be deleted.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.datapipeline.model.DescribeObjectsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

Identifier of the pipeline that contains the object definitions.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

objectIds

List<E> objectIds

Identifiers of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

evaluateExpressions

Boolean evaluateExpressions

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

marker

String marker

The starting point for the results to be returned. The first time you call DescribeObjects, this value should be empty. As long as the action returns HasMoreResults as True, you can call DescribeObjects again and pass the marker value from the response to retrieve the next set of results.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.datapipeline.model.DescribeObjectsResult extends Object implements Serializable

Serialized Fields

pipelineObjects

List<E> pipelineObjects

An array of object definitions that are returned by the call to DescribeObjects.

marker

String marker

The starting point for the next page of results. To view the next page of results, call DescribeObjects again with this marker value.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

hasMoreResults

Boolean hasMoreResults

If True, there are more pages of results to return.

Class com.amazonaws.services.datapipeline.model.DescribePipelinesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineIds

List<E> pipelineIds

Identifiers of the pipelines to describe. You can pass as many as 25 identifiers in a single call to DescribePipelines. You can obtain pipeline identifiers by calling ListPipelines.

Class com.amazonaws.services.datapipeline.model.DescribePipelinesResult extends Object implements Serializable

Serialized Fields

pipelineDescriptionList

List<E> pipelineDescriptionList

An array of descriptions returned for the specified pipelines.

Class com.amazonaws.services.datapipeline.model.EvaluateExpressionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The identifier of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

objectId

String objectId

The identifier of the object.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

expression

String expression

The expression to evaluate.

Constraints:
Length: 0 - 20971520
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.datapipeline.model.EvaluateExpressionResult extends Object implements Serializable

Serialized Fields

evaluatedExpression

String evaluatedExpression

The evaluated expression.

Constraints:
Length: 0 - 20971520
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.datapipeline.model.Field extends Object implements Serializable

Serialized Fields

key

String key

The field identifier.

Constraints:
Length: 1 - 256
Pattern: [ -??-??-?\r\n\t]*

stringValue

String stringValue

The field value, expressed as a String.

Constraints:
Length: 0 - 10240
Pattern: [ -??-??-?\r\n\t]*

refValue

String refValue

The field value, expressed as the identifier of another object.

Constraints:
Length: 1 - 256
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.datapipeline.model.GetPipelineDefinitionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The identifier of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

version

String version

The version of the pipeline definition to retrieve. This parameter accepts the values latest (default) and active. Where latest indicates the last definition saved to the pipeline and active indicates the last definition of the pipeline that was activated.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.datapipeline.model.GetPipelineDefinitionResult extends Object implements Serializable

Serialized Fields

pipelineObjects

List<E> pipelineObjects

An array of objects defined in the pipeline.

Class com.amazonaws.services.datapipeline.model.InstanceIdentity extends Object implements Serializable

Serialized Fields

document

String document

A description of an Amazon EC2 instance that is generated when the instance is launched and exposed to the instance via the instance metadata service in the form of a JSON representation of an object.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

signature

String signature

A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.datapipeline.model.InternalServiceErrorException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.datapipeline.model.InvalidRequestException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.datapipeline.model.ListPipelinesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

marker

String marker

The starting point for the results to be returned. The first time you call ListPipelines, this value should be empty. As long as the action returns HasMoreResults as True, you can call ListPipelines again and pass the marker value from the response to retrieve the next set of results.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.datapipeline.model.ListPipelinesResult extends Object implements Serializable

Serialized Fields

pipelineIdList

List<E> pipelineIdList

A list of all the pipeline identifiers that your account has permission to access. If you require additional information about the pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition.

marker

String marker

If not null, indicates the starting point for the set of pipeline identifiers that the next call to ListPipelines will retrieve. If null, there are no more pipeline identifiers.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

hasMoreResults

Boolean hasMoreResults

If True, there are more results that can be obtained by a subsequent call to ListPipelines.

Class com.amazonaws.services.datapipeline.model.Operator extends Object implements Serializable

Serialized Fields

type

String type

The logical operation to be performed: equal (EQ), equal reference (REF_EQ), less than or equal (LE), greater than or equal (GE), or between (BETWEEN). Equal reference (REF_EQ) can be used only with reference fields. The other comparison types can be used only with String fields. The comparison types you can use apply only to certain object fields, as detailed below.

The comparison operators EQ and REF_EQ act on the following fields:

• name
• @sphere
• parent
• @componentParent
• @instanceParent
• @status
• @scheduledStartTime
• @scheduledEndTime
• @actualStartTime
• @actualEndTime

The comparison operators GE, LE, and BETWEEN act on the following fields:

• @scheduledStartTime
• @scheduledEndTime
• @actualStartTime
• @actualEndTime

Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string "my".

Constraints:
Allowed Values: EQ, REF_EQ, LE, GE, BETWEEN

values

List<E> values

The value that the actual field value will be compared with.

Class com.amazonaws.services.datapipeline.model.PipelineDeletedException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.datapipeline.model.PipelineDescription extends Object implements Serializable

Serialized Fields

pipelineId

String pipelineId

The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

name

String name

Name of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

fields

List<E> fields

A list of read-only fields that contain metadata about the pipeline:

description

String description

Description of the pipeline.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.datapipeline.model.PipelineIdName extends Object implements Serializable

Serialized Fields

id

String id

Identifier of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

name

String name

Name of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.datapipeline.model.PipelineNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.datapipeline.model.PipelineObject extends Object implements Serializable

Serialized Fields

id

String id

Identifier of the object.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

name

String name

Name of the object.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

fields

List<E> fields

Key-value pairs that define the properties of the object.

Class com.amazonaws.services.datapipeline.model.PollForTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

workerGroup

String workerGroup

Indicates the type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup in the call to PollForTask. There are no wildcard values permitted in workerGroup, the string must be an exact, case-sensitive, match.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

hostname

String hostname

The public DNS name of the calling task runner.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

instanceIdentity

InstanceIdentity instanceIdentity

Identity information for the Amazon EC2 instance that is hosting the task runner. You can get this value by calling the URI, http://169.254.169.254/latest/meta-data/instance-id, from the EC2 instance. For more information, go to Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.

Class com.amazonaws.services.datapipeline.model.PollForTaskResult extends Object implements Serializable

Serialized Fields

taskObject

TaskObject taskObject

An instance of PollForTaskResult, which contains an instance of TaskObject. The returned object contains all the information needed to complete the task that is being assigned to the task runner. One of the fields returned in this object is taskId, which contains an identifier for the task being assigned. The calling task runner uses taskId in subsequent calls to ReportTaskProgress and SetTaskStatus.

Class com.amazonaws.services.datapipeline.model.PutPipelineDefinitionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The identifier of the pipeline to be configured.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

pipelineObjects

List<E> pipelineObjects

The objects that define the pipeline. These will overwrite the existing pipeline definition.

Class com.amazonaws.services.datapipeline.model.PutPipelineDefinitionResult extends Object implements Serializable

Serialized Fields

validationErrors

List<E> validationErrors

A list of the validation errors that are associated with the objects defined in pipelineObjects.

validationWarnings

List<E> validationWarnings

A list of the validation warnings that are associated with the objects defined in pipelineObjects.

errored

Boolean errored

If True, there were validation errors. If errored is True, the pipeline definition is stored but cannot be activated until you correct the pipeline and call PutPipelineDefinition to commit the corrected pipeline.

Class com.amazonaws.services.datapipeline.model.Query extends Object implements Serializable

Serialized Fields

selectors

List<E> selectors

List of selectors that define the query. An object must satisfy all of the selectors to match the query.

Class com.amazonaws.services.datapipeline.model.QueryObjectsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

Identifier of the pipeline to be queried for object names.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

query

Query query

Query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

sphere

String sphere

Specifies whether the query applies to components or instances. Allowable values: COMPONENT, INSTANCE, ATTEMPT.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

marker

String marker

The starting point for the results to be returned. The first time you call QueryObjects, this value should be empty. As long as the action returns HasMoreResults as True, you can call QueryObjects again and pass the marker value from the response to retrieve the next set of results.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

limit

Integer limit

Specifies the maximum number of object names that QueryObjects will return in a single call. The default value is 100.

Class com.amazonaws.services.datapipeline.model.QueryObjectsResult extends Object implements Serializable

Serialized Fields

ids

List<E> ids

A list of identifiers that match the query selectors.

marker

String marker

The starting point for the results to be returned. As long as the action returns HasMoreResults as True, you can call QueryObjects again and pass the marker value from the response to retrieve the next set of results.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

hasMoreResults

Boolean hasMoreResults

If True, there are more results that can be obtained by a subsequent call to QueryObjects.

Class com.amazonaws.services.datapipeline.model.ReportTaskProgressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskId

String taskId

Identifier of the task assigned to the task runner. This value is provided in the TaskObject that the service returns with the response for the PollForTask action.

Constraints:
Length: 1 - 2048
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.datapipeline.model.ReportTaskProgressResult extends Object implements Serializable

Serialized Fields

canceled

Boolean canceled

If True, the calling task runner should cancel processing of the task. The task runner does not need to call SetTaskStatus for canceled tasks.

Class com.amazonaws.services.datapipeline.model.ReportTaskRunnerHeartbeatRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskrunnerId

String taskrunnerId

The identifier of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application. If you have written a custom task runner, you should assign a unique identifier for the task runner.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

workerGroup

String workerGroup

Indicates the type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup in the call to ReportTaskRunnerHeartbeat. There are no wildcard values permitted in workerGroup, the string must be an exact, case-sensitive, match.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

hostname

String hostname

The public DNS name of the calling task runner.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.datapipeline.model.ReportTaskRunnerHeartbeatResult extends Object implements Serializable

Serialized Fields

terminate

Boolean terminate

Indicates whether the calling task runner should terminate. If True, the task runner that called ReportTaskRunnerHeartbeat should terminate.

Class com.amazonaws.services.datapipeline.model.Selector extends Object implements Serializable

Serialized Fields

fieldName

String fieldName

The name of the field that the operator will be applied to. The field name is the "key" portion of the field definition in the pipeline definition syntax that is used by the AWS Data Pipeline API. If the field is not set on the object, the condition fails.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

operator

Operator operator

Contains a logical operation for comparing the value of a field with a specified value.

Class com.amazonaws.services.datapipeline.model.SetStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

Identifies the pipeline that contains the objects.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

objectIds

List<E> objectIds

Identifies an array of objects. The corresponding objects can be either physical or components, but not a mix of both types.

status

String status

Specifies the status to be set on all the objects in objectIds. For components, this can be either PAUSE or RESUME. For instances, this can be either CANCEL, RERUN, or MARK_FINISHED.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.datapipeline.model.SetTaskStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskId

String taskId

Identifies the task assigned to the task runner. This value is set in the TaskObject that is returned by the PollForTask action.

Constraints:
Length: 1 - 2048
Pattern: [ -??-??-?\r\n\t]*

taskStatus

String taskStatus

If FINISHED, the task successfully completed. If FAILED the task ended unsuccessfully. The FALSE value is used by preconditions.

Constraints:
Allowed Values: FINISHED, FAILED, FALSE

errorId

String errorId

If an error occurred during the task, this value specifies an id value that represents the error. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

errorMessage

String errorMessage

If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

errorStackTrace

String errorStackTrace

If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.datapipeline.model.SetTaskStatusResult extends Object implements Serializable

Class com.amazonaws.services.datapipeline.model.TaskNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.datapipeline.model.TaskObject extends Object implements Serializable

Serialized Fields

taskId

String taskId

An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.

Constraints:
Length: 1 - 2048
Pattern: [ -??-??-?\r\n\t]*

pipelineId

String pipelineId

Identifier of the pipeline that provided the task.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

attemptId

String attemptId

Identifier of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

objects

Map<K,V> objects

Connection information for the location where the task runner will publish the output of the task.

Class com.amazonaws.services.datapipeline.model.ValidatePipelineDefinitionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

Identifies the pipeline whose definition is to be validated.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

pipelineObjects

List<E> pipelineObjects

A list of objects that define the pipeline changes to validate against the pipeline.

Class com.amazonaws.services.datapipeline.model.ValidatePipelineDefinitionResult extends Object implements Serializable

Serialized Fields

validationErrors

List<E> validationErrors

Lists the validation errors that were found by ValidatePipelineDefinition.

validationWarnings

List<E> validationWarnings

Lists the validation warnings that were found by ValidatePipelineDefinition.

errored

Boolean errored

If True, there were validation errors.

Class com.amazonaws.services.datapipeline.model.ValidationError extends Object implements Serializable

Serialized Fields

id

String id

The identifier of the object that contains the validation error.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

errors

List<E> errors

A description of the validation error.

Class com.amazonaws.services.datapipeline.model.ValidationWarning extends Object implements Serializable

Serialized Fields

id

String id

The identifier of the object that contains the validation warning.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

warnings

List<E> warnings

A description of the validation warning.

Package com.amazonaws.services.directconnect.model

Class com.amazonaws.services.directconnect.model.Connection extends Object implements Serializable

Serialized Fields

connectionId

String connectionId

ID of the connection.

Example: dxcon-fg5678gh

Default: None

connectionName

String connectionName

The name of the connection.

Example: "1G Connection to AWS"

Default: None

connectionState

String connectionState

State of the connection.

• Requested: The initial state of connection immediately after creation. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
• Pending: A connection is pending after the customer receives the LOA and remains pending until the completion of the partner circuit.
• Available: A connection that has a completed partner circuit and is ready for use. A connection must be available before virtual interfaces can be created.
• Deleted: A connection that has been deleted.

Constraints:
Allowed Values: requested, pending, available, deleted

region

String region

The AWS region where the offering is located.

Example: us-east-1

Default: None

location

String location

Where the AWS Direct Connect offering is located.

Example: EqSV5

Default: None

Class com.amazonaws.services.directconnect.model.ConnectionCost extends Object implements Serializable

Serialized Fields

name

String name

The name of the cost item.

Example: Inbound data transfer

unit

String unit

The unit used in cost calculation.

Example: "Gbps," if the price is calculated based on Gbps.

currencyCode

String currencyCode

Currency code based on ISO 4217.

Example: "USD" for US dollar.

amount

String amount

The amount of charge per unit.

Example: 0.01

Class com.amazonaws.services.directconnect.model.ConnectionOrderStep extends Object implements Serializable

Serialized Fields

number

String number

Number of an order step.

Example: 1

name

String name

Name of the order step.

Example: Authorize cross connect

description

String description

More detailed description of the order step.

Example: "AWS will prepare your connection and send you an email with an LOA to provide to the colocation provider"

owner

String owner

The entity who owns the completion of the order step.

Example: AWS, Customer

sla

Integer sla

Time to complete the order step in minutes.

Example: 60

stepState

String stepState

State of the connection step.

• Pending: This step is not yet completed.
• Completed: This step has been completed

Constraints:
Allowed Values: pending, completed

Class com.amazonaws.services.directconnect.model.CreateConnectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

offeringId

String offeringId

The ID of the offering.

Example: us-west-1_EqSV5_1G

Default: None

connectionName

String connectionName

The name of the connection.

Example: "1G Connection to AWS"

Default: None

Class com.amazonaws.services.directconnect.model.CreateConnectionResult extends Object implements Serializable

Serialized Fields

connectionId

String connectionId

ID of the connection.

Example: dxcon-fg5678gh

Default: None

connectionName

String connectionName

The name of the connection.

Example: "1G Connection to AWS"

Default: None

connectionState

String connectionState

State of the connection.

• Requested: The initial state of connection immediately after creation. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
• Pending: A connection is pending after the customer receives the LOA and remains pending until the completion of the partner circuit.
• Available: A connection that has a completed partner circuit and is ready for use. A connection must be available before virtual interfaces can be created.
• Deleted: A connection that has been deleted.

Constraints:
Allowed Values: requested, pending, available, deleted

region

String region

The AWS region where the offering is located.

Example: us-east-1

Default: None

location

String location

Where the AWS Direct Connect offering is located.

Example: EqSV5

Default: None

Class com.amazonaws.services.directconnect.model.CreatePrivateVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

connectionId

String connectionId

ID of the connection.

Example: dxcon-fg5678gh

Default: None

newPrivateVirtualInterface

NewPrivateVirtualInterface newPrivateVirtualInterface

Detailed information of the private virtual interface to be created.

Default: None

Class com.amazonaws.services.directconnect.model.CreatePrivateVirtualInterfaceResult extends Object implements Serializable

Serialized Fields

virtualInterfaceId

String virtualInterfaceId

ID of the virtual interface.

Example: dxvif-123dfg56

Default: None

location

String location

Where the AWS Direct Connect offering is located.

Example: EqSV5

Default: None

connectionId

String connectionId

ID of the connection.

Example: dxcon-fg5678gh

Default: None

virtualInterfaceType

String virtualInterfaceType

The type of virtual interface

Example: Private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, etc.)

virtualInterfaceName

String virtualInterfaceName

The name of the virtual interface assigned by the customer

Example: "Dev VPC"

vlan

Integer vlan

VLAN ID

Example: 101

asn

Integer asn

Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration

Example: 65000

authKey

String authKey

Authentication key for BGP configuration

Example: asdf34example

amazonAddress

String amazonAddress

IP address assigned to the Amazon interface.

Example: 192.168.1.1

customerAddress

String customerAddress

IP address assigned to the customer interface.

Example: 192.168.1.2

virtualInterfaceState

String virtualInterfaceState

State of the virtual interface.

• Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
• Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
• Available: A virtual interface that is able to forward traffic.
• Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
• Deleted: A virtual interface that cannot forward traffic.

Constraints:
Allowed Values: verifying, pending, available, deleting, deleted

customerRouterConfig

String customerRouterConfig

Information for generating the customer router configuration.

virtualGatewayId

String virtualGatewayId

Virtual private gateway to a VPC.

Example: vgw-123er56

routeFilterPrefixes

List<E> routeFilterPrefixes

A list of route filter prefixes.

Class com.amazonaws.services.directconnect.model.CreatePublicVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

connectionId

String connectionId

ID of the connection.

Example: dxcon-fg5678gh

Default: None

newPublicVirtualInterface

NewPublicVirtualInterface newPublicVirtualInterface

Detailed information of the public virtual interface to be created.

Default: None

Class com.amazonaws.services.directconnect.model.CreatePublicVirtualInterfaceResult extends Object implements Serializable

Serialized Fields

virtualInterfaceId

String virtualInterfaceId

ID of the virtual interface.

Example: dxvif-123dfg56

Default: None

location

String location

Where the AWS Direct Connect offering is located.

Example: EqSV5

Default: None

connectionId

String connectionId

ID of the connection.

Example: dxcon-fg5678gh

Default: None

virtualInterfaceType

String virtualInterfaceType

The type of virtual interface

Example: Private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, etc.)

virtualInterfaceName

String virtualInterfaceName

The name of the virtual interface assigned by the customer

Example: "Dev VPC"

vlan

Integer vlan

VLAN ID

Example: 101

asn

Integer asn

Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration

Example: 65000

authKey

String authKey

Authentication key for BGP configuration

Example: asdf34example

amazonAddress

String amazonAddress

IP address assigned to the Amazon interface.

Example: 192.168.1.1

customerAddress

String customerAddress

IP address assigned to the customer interface.

Example: 192.168.1.2

virtualInterfaceState

String virtualInterfaceState

State of the virtual interface.

• Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
• Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
• Available: A virtual interface that is able to forward traffic.
• Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
• Deleted: A virtual interface that cannot forward traffic.

Constraints:
Allowed Values: verifying, pending, available, deleting, deleted

customerRouterConfig

String customerRouterConfig

Information for generating the customer router configuration.

virtualGatewayId

String virtualGatewayId

Virtual private gateway to a VPC.

Example: vgw-123er56

routeFilterPrefixes

List<E> routeFilterPrefixes

A list of route filter prefixes.

Class com.amazonaws.services.directconnect.model.DeleteConnectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

connectionId

String connectionId

ID of the connection.

Example: dxcon-fg5678gh

Default: None

Class com.amazonaws.services.directconnect.model.DeleteConnectionResult extends Object implements Serializable

Serialized Fields

connectionId

String connectionId

ID of the connection.

Example: dxcon-fg5678gh

Default: None

connectionName

String connectionName

The name of the connection.

Example: "1G Connection to AWS"

Default: None

connectionState

String connectionState

State of the connection.

• Requested: The initial state of connection immediately after creation. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
• Pending: A connection is pending after the customer receives the LOA and remains pending until the completion of the partner circuit.
• Available: A connection that has a completed partner circuit and is ready for use. A connection must be available before virtual interfaces can be created.
• Deleted: A connection that has been deleted.

Constraints:
Allowed Values: requested, pending, available, deleted

region

String region

The AWS region where the offering is located.

Example: us-east-1

Default: None

location

String location

Where the AWS Direct Connect offering is located.

Example: EqSV5

Default: None

Class com.amazonaws.services.directconnect.model.DeleteVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

virtualInterfaceId

String virtualInterfaceId

ID of the virtual interface.

Example: dxvif-123dfg56

Default: None

Class com.amazonaws.services.directconnect.model.DeleteVirtualInterfaceResult extends Object implements Serializable

Serialized Fields

virtualInterfaceState

String virtualInterfaceState

State of the virtual interface.

• Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
• Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
• Available: A virtual interface that is able to forward traffic.
• Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
• Deleted: A virtual interface that cannot forward traffic.

Constraints:
Allowed Values: verifying, pending, available, deleting, deleted

Class com.amazonaws.services.directconnect.model.DescribeConnectionDetailRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

connectionId

String connectionId

ID of the connection.

Example: dxcon-fg5678gh

Default: None

Class com.amazonaws.services.directconnect.model.DescribeConnectionDetailResult extends Object implements Serializable

Serialized Fields

connectionId

String connectionId

ID of the connection.

Example: dxcon-fg5678gh

Default: None

connectionName

String connectionName

The name of the connection.

Example: "1G Connection to AWS"

Default: None

connectionState

String connectionState

State of the connection.

• Requested: The initial state of connection immediately after creation. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
• Pending: A connection is pending after the customer receives the LOA and remains pending until the completion of the partner circuit.
• Available: A connection that has a completed partner circuit and is ready for use. A connection must be available before virtual interfaces can be created.
• Deleted: A connection that has been deleted.

Constraints:
Allowed Values: requested, pending, available, deleted

region

String region

The AWS region where the offering is located.

Example: us-east-1

Default: None

location

String location

Where the AWS Direct Connect offering is located.

Example: EqSV5

Default: None

bandwidth

String bandwidth

Bandwidth of the connection.

Example: 1Gbps

Default: None

connectionCosts

List<E> connectionCosts

A list of connection costs.

orderSteps

List<E> orderSteps

A list of connection order steps.

Class com.amazonaws.services.directconnect.model.DescribeConnectionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

connectionId

String connectionId

ID of the connection.

Example: dxcon-fg5678gh

Default: None

Class com.amazonaws.services.directconnect.model.DescribeConnectionsResult extends Object implements Serializable

Serialized Fields

connections

List<E> connections

A list of connections.

Class com.amazonaws.services.directconnect.model.DescribeOfferingDetailRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

offeringId

String offeringId

The ID of the offering.

Example: us-west-1_EqSV5_1G

Default: None

Class com.amazonaws.services.directconnect.model.DescribeOfferingDetailResult extends Object implements Serializable

Serialized Fields

offeringId

String offeringId

The ID of the offering.

Example: us-west-1_EqSV5_1G

Default: None

region

String region

The AWS region where the offering is located.

Example: us-east-1

Default: None

location

String location

Where the AWS Direct Connect offering is located.

Example: EqSV5

Default: None

offeringName

String offeringName

description

String description

Description of the offering.

Example: "1Gbps Cross Connect in us-east-1 via Equinix"

Default: None

bandwidth

String bandwidth

Bandwidth of the connection.

Example: 1Gbps

Default: None

connectionCosts

List<E> connectionCosts

A list of connection costs.

orderSteps

List<E> orderSteps

A list of offering order steps.

Class com.amazonaws.services.directconnect.model.DescribeOfferingsRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.directconnect.model.DescribeOfferingsResult extends Object implements Serializable

Serialized Fields

offerings

List<E> offerings

A list of offerings.

Class com.amazonaws.services.directconnect.model.DescribeVirtualGatewaysRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.directconnect.model.DescribeVirtualGatewaysResult extends Object implements Serializable

Serialized Fields

virtualGateways

List<E> virtualGateways

A list of virtual gateways.

Class com.amazonaws.services.directconnect.model.DescribeVirtualInterfacesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

connectionId

String connectionId

ID of the connection.

Example: dxcon-fg5678gh

Default: None

virtualInterfaceId

String virtualInterfaceId

ID of the virtual interface.

Example: dxvif-123dfg56

Default: None

Class com.amazonaws.services.directconnect.model.DescribeVirtualInterfacesResult extends Object implements Serializable

Serialized Fields

virtualInterfaces

List<E> virtualInterfaces

A list of virtual interfaces.

Class com.amazonaws.services.directconnect.model.DirectConnectClientException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.directconnect.model.DirectConnectServerException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.directconnect.model.NewPrivateVirtualInterface extends Object implements Serializable

Serialized Fields

virtualInterfaceName

String virtualInterfaceName

The name of the virtual interface assigned by the customer

Example: "Dev VPC"

vlan

Integer vlan

VLAN ID

Example: 101

asn

Integer asn

Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration

Example: 65000

authKey

String authKey

Authentication key for BGP configuration

Example: asdf34example

amazonAddress

String amazonAddress

IP address assigned to the Amazon interface.

Example: 192.168.1.1

customerAddress

String customerAddress

virtualGatewayId

String virtualGatewayId

Virtual private gateway to a VPC.

Example: vgw-123er56

Class com.amazonaws.services.directconnect.model.NewPublicVirtualInterface extends Object implements Serializable

Serialized Fields

virtualInterfaceName

String virtualInterfaceName

The name of the virtual interface assigned by the customer

Example: "Dev VPC"

vlan

Integer vlan

VLAN ID

Example: 101

asn

Integer asn

Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration

Example: 65000

authKey

String authKey

Authentication key for BGP configuration

Example: asdf34example

amazonAddress

String amazonAddress

IP address assigned to the Amazon interface.

Example: 192.168.1.1

customerAddress

String customerAddress

routeFilterPrefixes

List<E> routeFilterPrefixes

A list of route filter prefixes.

Class com.amazonaws.services.directconnect.model.Offering extends Object implements Serializable

Serialized Fields

offeringId

String offeringId

The ID of the offering.

Example: us-west-1_EqSV5_1G

Default: None

region

String region

The AWS region where the offering is located.

Example: us-east-1

Default: None

location

String location

Where the AWS Direct Connect offering is located.

Example: EqSV5

Default: None

offeringName

String offeringName

Name of the offering.

Example: "1Gbps Cross Connect in us-east-1 via Equinix"

Default: None

description

String description

Description of the offering.

Example: "1Gbps Cross Connect in us-east-1 via Equinix"

Default: None

bandwidth

String bandwidth

Bandwidth of the connection.

Example: 1Gbps

Default: None

connectionCosts

List<E> connectionCosts

A list of connection costs.

Class com.amazonaws.services.directconnect.model.OfferingOrderStep extends Object implements Serializable

Serialized Fields

number

String number

Number of an order step.

Example: 1

name

String name

Name of the order step.

Example: Authorize cross connect

description

String description

More detailed description of the order step.

Example: "AWS will prepare your connection and send you an email with an LOA to provide to the colocation provider"

owner

String owner

The entity who owns the completion of the order step.

Example: AWS

sla

Integer sla

Time to complete the order step in minutes.

Example: 60

Class com.amazonaws.services.directconnect.model.RouteFilterPrefix extends Object implements Serializable

Serialized Fields

cidr

String cidr

CIDR notation for the advertised route. Multiple routes are separated by commas

Example: 10.10.10.0/24,10.10.11.0/24

Class com.amazonaws.services.directconnect.model.VirtualGateway extends Object implements Serializable

Serialized Fields

virtualGatewayId

String virtualGatewayId

Virtual private gateway to a VPC.

Example: vgw-123er56

virtualGatewayState

String virtualGatewayState

State of the virtual private gateway.

• Pending: This is the initial state after calling CreateVpnGateway.
• Available: Ready for use by a private virtual interface.
• Deleting: This is the initial state after calling DeleteVpnGateway.
• Deleted: In this state, a private virtual interface is unable to send traffic over this gateway.

Class com.amazonaws.services.directconnect.model.VirtualInterface extends Object implements Serializable

Serialized Fields

virtualInterfaceId

String virtualInterfaceId

ID of the virtual interface.

Example: dxvif-123dfg56

Default: None

location

String location

Where the AWS Direct Connect offering is located.

Example: EqSV5

Default: None

connectionId

String connectionId

ID of the connection.

Example: dxcon-fg5678gh

Default: None

virtualInterfaceType

String virtualInterfaceType

The type of virtual interface

Example: Private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, etc.)

virtualInterfaceName

String virtualInterfaceName

The name of the virtual interface assigned by the customer

Example: "Dev VPC"

vlan

Integer vlan

VLAN ID

Example: 101

asn

Integer asn

Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration

Example: 65000

authKey

String authKey

Authentication key for BGP configuration

Example: asdf34example

amazonAddress

String amazonAddress

IP address assigned to the Amazon interface.

Example: 192.168.1.1

customerAddress

String customerAddress

IP address assigned to the customer interface.

Example: 192.168.1.2

virtualInterfaceState

String virtualInterfaceState

State of the virtual interface.

• Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
• Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
• Available: A virtual interface that is able to forward traffic.
• Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
• Deleted: A virtual interface that cannot forward traffic.

Constraints:
Allowed Values: verifying, pending, available, deleting, deleted

customerRouterConfig

String customerRouterConfig

Information for generating the customer router configuration.

virtualGatewayId

String virtualGatewayId

Virtual private gateway to a VPC.

Example: vgw-123er56

routeFilterPrefixes

List<E> routeFilterPrefixes

A list of route filter prefixes.

Package com.amazonaws.services.dynamodb.datamodeling

Class com.amazonaws.services.dynamodb.datamodeling.DynamoDBMappingException extends RuntimeException implements Serializable

serialVersionUID: -4883173289978517967L

Package com.amazonaws.services.dynamodb.model

Class com.amazonaws.services.dynamodb.model.AttributeValue extends Object implements Serializable

Serialized Fields

s

String s

Deprecated.

Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).

n

String n

Deprecated.

Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.

b

ByteBuffer b

Deprecated.

Binary attributes are sequences of unsigned bytes.

sS

List<E> sS

Deprecated.

A set of strings.

nS

List<E> nS

Deprecated.

A set of numbers.

bS

List<E> bS

Deprecated.

A set of binary attributes.

Class com.amazonaws.services.dynamodb.model.AttributeValueUpdate extends Object implements Serializable

Serialized Fields

value

AttributeValue value

Deprecated.

AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.

action

String action

Deprecated.

The type of action for an item update operation. Only use the add action for numbers or sets; the specified value is added to the existing value. If a set of values is specified, the values are added to the existing set. Adds the specified attribute. If the attribute exists, it is replaced by the new value. If no value is specified, this removes the attribute and its value. If a set of values is specified, then the values in the specified set are removed from the old set.

Constraints:
Allowed Values: ADD, PUT, DELETE

Class com.amazonaws.services.dynamodb.model.BatchGetItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

requestItems

Map<K,V> requestItems

Deprecated.

A map of the table name and corresponding items to get by primary key. While requesting items, each table name can be invoked only once per operation.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.dynamodb.model.BatchGetItemResult extends Object implements Serializable

Serialized Fields

responses

Map<K,V> responses

Deprecated.

Table names and the respective item attributes from the tables.

unprocessedKeys

Map<K,V> unprocessedKeys

Deprecated.

Contains a map of tables and their respective keys that were not processed with the current response, possibly due to reaching a limit on the response size. The UnprocessedKeys value is in the same form as a RequestItems parameter (so the value can be provided directly to a subsequent BatchGetItem operation). For more information, see the above RequestItems parameter.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.dynamodb.model.BatchResponse extends Object implements Serializable

Serialized Fields

items

List<E> items

Deprecated.

consumedCapacityUnits

Double consumedCapacityUnits

Deprecated.

The number of Capacity Units of the provisioned throughput of the table consumed during the operation. GetItem, BatchGetItem, BatchWriteItem, Query, and Scan operations consume ReadCapacityUnits, while PutItem, UpdateItem, and DeleteItem operations consume WriteCapacityUnits.

Class com.amazonaws.services.dynamodb.model.BatchWriteItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

requestItems

Map<K,V> requestItems

Deprecated.

A map of table name to list-of-write-requests. Used as input to the BatchWriteItem API call

Constraints:
Length: 1 - 25

Class com.amazonaws.services.dynamodb.model.BatchWriteItemResult extends Object implements Serializable

Serialized Fields

responses

Map<K,V> responses

Deprecated.

The response object as a result of BatchWriteItem call. This is essentially a map of table name to ConsumedCapacityUnits.

unprocessedItems

Map<K,V> unprocessedItems

Deprecated.

The Items which we could not successfully process in a BatchWriteItem call is returned as UnprocessedItems

Constraints:
Length: 1 - 25

Class com.amazonaws.services.dynamodb.model.BatchWriteResponse extends Object implements Serializable

Serialized Fields

consumedCapacityUnits

Double consumedCapacityUnits

Deprecated.

The number of Capacity Units of the provisioned throughput of the table consumed during the operation. GetItem, BatchGetItem, BatchWriteItem, Query, and Scan operations consume ReadCapacityUnits, while PutItem, UpdateItem, and DeleteItem operations consume WriteCapacityUnits.

Class com.amazonaws.services.dynamodb.model.Condition extends Object implements Serializable

Serialized Fields

attributeValueList

List<E> attributeValueList

Deprecated.

A list of attribute values to be used with a comparison operator for a scan or query operation. For comparisons that require more than one value, such as a BETWEEN comparison, the AttributeValueList contains two attribute values and the comparison operator.

comparisonOperator

String comparisonOperator

Deprecated.

A comparison operator is an enumeration of several operations:

• EQ for equal.
• NE for not equal.
• IN checks for exact matches.
• LE for less than or equal to.
• LT for less than.
• GE for greater than or equal to.
• GT for greater than.
• BETWEEN for between.
• NOT_NULL for exists.
• NULL for not exists.
• CONTAINS for substring or value in a set.
• NOT_CONTAINS for absence of a substring or absence of a value in a set.
• BEGINS_WITH for a substring prefix.

Scan operations support all available comparison operators.

Query operations support a subset of the available comparison operators: EQ, LE, LT, GE, GT, BETWEEN, and BEGINS_WITH.

Constraints:
Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH

Class com.amazonaws.services.dynamodb.model.ConditionalCheckFailedException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.dynamodb.model.CreateTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

String tableName

Deprecated.

The name of the table you want to create. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

keySchema

KeySchema keySchema

Deprecated.

The KeySchema identifies the primary key as a one attribute primary key (hash) or a composite two attribute (hash-and-range) primary key. Single attribute primary keys have one index value: a HashKeyElement. A composite hash-and-range primary key contains two attribute values: a HashKeyElement and a RangeKeyElement.

provisionedThroughput

ProvisionedThroughput provisionedThroughput

Deprecated.

Provisioned throughput reserves the required read and write resources for your table in terms of ReadCapacityUnits and WriteCapacityUnits. Values for provisioned throughput depend upon your expected read/write rates, item size, and consistency. Provide the expected number of read and write operations, assuming an item size of 1k and strictly consistent reads. For 2k item size, double the value. For 3k, triple the value, etc. Eventually-consistent reads consume half the resources of strictly consistent reads.

Class com.amazonaws.services.dynamodb.model.CreateTableResult extends Object implements Serializable

Serialized Fields

tableDescription

TableDescription tableDescription

Deprecated.

Class com.amazonaws.services.dynamodb.model.DeleteItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

String tableName

Deprecated.

The name of the table in which you want to delete an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

key

Key key

Deprecated.

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

expected

Map<K,V> expected

Deprecated.

Designates an attribute for a conditional modification. The Expected parameter allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value before modifying it.

returnValues

String returnValues

Deprecated.

Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For PUT operations, the possible parameter values are NONE (default) or ALL_OLD. For update operations, the possible parameter values are NONE (default) or ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW.

• NONE: Nothing is returned.
• ALL_OLD: Returns the attributes of the item as they were before the operation.
• UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.
• ALL_NEW: Returns all the attributes and their new values after the operation.
• UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

Class com.amazonaws.services.dynamodb.model.DeleteItemResult extends Object implements Serializable

Serialized Fields

attributes

Map<K,V> attributes

Deprecated.

If the ReturnValues parameter is provided as ALL_OLD in the request, Amazon DynamoDB returns an array of attribute name-value pairs (essentially, the deleted item). Otherwise, the response contains an empty set.

consumedCapacityUnits

Double consumedCapacityUnits

Deprecated.

The number of Capacity Units of the provisioned throughput of the table consumed during the operation. GetItem, BatchGetItem, BatchWriteItem, Query, and Scan operations consume ReadCapacityUnits, while PutItem, UpdateItem, and DeleteItem operations consume WriteCapacityUnits.

Class com.amazonaws.services.dynamodb.model.DeleteRequest extends Object implements Serializable

Serialized Fields

key

Key key

Deprecated.

The item's key to be delete

Class com.amazonaws.services.dynamodb.model.DeleteTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

String tableName

Deprecated.

The name of the table you want to delete. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodb.model.DeleteTableResult extends Object implements Serializable

Serialized Fields

tableDescription

TableDescription tableDescription

Deprecated.

Class com.amazonaws.services.dynamodb.model.DescribeTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

String tableName

Deprecated.

The name of the table you want to describe. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodb.model.DescribeTableResult extends Object implements Serializable

Serialized Fields

table

TableDescription table

Deprecated.

Class com.amazonaws.services.dynamodb.model.ExpectedAttributeValue extends Object implements Serializable

Serialized Fields

value

AttributeValue value

Deprecated.

Specify whether or not a value already exists and has a specific content for the attribute name-value pair.

exists

Boolean exists

Deprecated.

Specify whether or not a value already exists for the attribute name-value pair.

Class com.amazonaws.services.dynamodb.model.GetItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

String tableName

Deprecated.

The name of the table in which you want to get an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

key

Key key

Deprecated.

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

attributesToGet

List<E> attributesToGet

Deprecated.

List of Attribute names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result.

Constraints:
Length: 1 -

consistentRead

Boolean consistentRead

Deprecated.

If set to true, then a consistent read is issued. Otherwise eventually-consistent is used.

Class com.amazonaws.services.dynamodb.model.GetItemResult extends Object implements Serializable

Serialized Fields

item

Map<K,V> item

Deprecated.

Contains the requested attributes.

consumedCapacityUnits

Double consumedCapacityUnits

Deprecated.

The number of Capacity Units of the provisioned throughput of the table consumed during the operation. GetItem, BatchGetItem, BatchWriteItem, Query, and Scan operations consume ReadCapacityUnits, while PutItem, UpdateItem, and DeleteItem operations consume WriteCapacityUnits.

Class com.amazonaws.services.dynamodb.model.InternalServerErrorException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.dynamodb.model.Key extends Object implements Serializable

Serialized Fields

hashKeyElement

AttributeValue hashKeyElement

Deprecated.

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.

rangeKeyElement

AttributeValue rangeKeyElement

Deprecated.

A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.

Class com.amazonaws.services.dynamodb.model.KeysAndAttributes extends Object implements Serializable

Serialized Fields

keys

List<E> keys

Deprecated.

attributesToGet

List<E> attributesToGet

Deprecated.

List of Attribute names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result.

Constraints:
Length: 1 -

consistentRead

Boolean consistentRead

Deprecated.

If set to true, then a consistent read is issued. Otherwise eventually-consistent is used.

Class com.amazonaws.services.dynamodb.model.KeySchema extends Object implements Serializable

Serialized Fields

hashKeyElement

KeySchemaElement hashKeyElement

Deprecated.

A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.

rangeKeyElement

KeySchemaElement rangeKeyElement

Deprecated.

A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.

Class com.amazonaws.services.dynamodb.model.KeySchemaElement extends Object implements Serializable

Serialized Fields

attributeName

String attributeName

Deprecated.

The AttributeName of the KeySchemaElement.

Constraints:
Length: 1 - 255

attributeType

String attributeType

Deprecated.

The AttributeType of the KeySchemaElement which can be a String or a Number.

Constraints:
Allowed Values: S, N, B

Class com.amazonaws.services.dynamodb.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.dynamodb.model.ListTablesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

exclusiveStartTableName

String exclusiveStartTableName

Deprecated.

The name of the table that starts the list. If you already ran a ListTables operation and received a LastEvaluatedTableName value in the response, use that value here to continue the list.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

limit

Integer limit

Deprecated.

A number of maximum table names to return.

Constraints:
Range: 1 - 100

Class com.amazonaws.services.dynamodb.model.ListTablesResult extends Object implements Serializable

Serialized Fields

tableNames

List<E> tableNames

Deprecated.

lastEvaluatedTableName

String lastEvaluatedTableName

Deprecated.

The name of the last table in the current list. Use this value as the ExclusiveStartTableName in a new request to continue the list until all the table names are returned. If this value is null, all table names have been returned.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodb.model.ProvisionedThroughput extends Object implements Serializable

Serialized Fields

readCapacityUnits

Long readCapacityUnits

Deprecated.

ReadCapacityUnits are in terms of strictly consistent reads, assuming items of 1k. 2k items require twice the ReadCapacityUnits. Eventually-consistent reads only require half the ReadCapacityUnits of stirctly consistent reads.

Constraints:
Range: 1 -

writeCapacityUnits

Long writeCapacityUnits

Deprecated.

WriteCapacityUnits are in terms of strictly consistent reads, assuming items of 1k. 2k items require twice the WriteCapacityUnits.

Constraints:
Range: 1 -

Class com.amazonaws.services.dynamodb.model.ProvisionedThroughputDescription extends Object implements Serializable

Serialized Fields

lastIncreaseDateTime

Date lastIncreaseDateTime

Deprecated.

lastDecreaseDateTime

Date lastDecreaseDateTime

Deprecated.

numberOfDecreasesToday

Long numberOfDecreasesToday

Deprecated.

readCapacityUnits

Long readCapacityUnits

Deprecated.

writeCapacityUnits

Long writeCapacityUnits

Deprecated.

Class com.amazonaws.services.dynamodb.model.ProvisionedThroughputExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.dynamodb.model.PutItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

String tableName

Deprecated.

The name of the table in which you want to put an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

item

Map<K,V> item

Deprecated.

A map of the attributes for the item, and must include the primary key values that define the item. Other attribute name-value pairs can be provided for the item.

expected

Map<K,V> expected

Deprecated.

Designates an attribute for a conditional modification. The Expected parameter allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value before modifying it.

returnValues

String returnValues

Deprecated.

Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For PUT operations, the possible parameter values are NONE (default) or ALL_OLD. For update operations, the possible parameter values are NONE (default) or ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW.

• NONE: Nothing is returned.
• ALL_OLD: Returns the attributes of the item as they were before the operation.
• UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.
• ALL_NEW: Returns all the attributes and their new values after the operation.
• UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

Class com.amazonaws.services.dynamodb.model.PutItemResult extends Object implements Serializable

Serialized Fields

attributes

Map<K,V> attributes

Deprecated.

Attribute values before the put operation, but only if the ReturnValues parameter is specified as ALL_OLD in the request.

consumedCapacityUnits

Double consumedCapacityUnits

Deprecated.

The number of Capacity Units of the provisioned throughput of the table consumed during the operation. GetItem, BatchGetItem, BatchWriteItem, Query, and Scan operations consume ReadCapacityUnits, while PutItem, UpdateItem, and DeleteItem operations consume WriteCapacityUnits.

Class com.amazonaws.services.dynamodb.model.PutRequest extends Object implements Serializable

Serialized Fields

item

Map<K,V> item

Deprecated.

The item to put

Class com.amazonaws.services.dynamodb.model.QueryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

String tableName

Deprecated.

The name of the table in which you want to query. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

attributesToGet

List<E> attributesToGet

Deprecated.

List of Attribute names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result.

Constraints:
Length: 1 -

limit

Integer limit

Deprecated.

The maximum number of items to return. If Amazon DynamoDB hits this limit while querying the table, it stops the query and returns the matching values up to the limit, and a LastEvaluatedKey to apply in a subsequent operation to continue the query. Also, if the result set size exceeds 1MB before Amazon DynamoDB hits this limit, it stops the query and returns the matching values, and a LastEvaluatedKey to apply in a subsequent operation to continue the query.

Constraints:
Range: 1 -

consistentRead

Boolean consistentRead

Deprecated.

If set to true, then a consistent read is issued. Otherwise eventually-consistent is used.

count

Boolean count

Deprecated.

If set to true, Amazon DynamoDB returns a total number of items that match the query parameters, instead of a list of the matching items and their attributes. Do not set Count to true while providing a list of AttributesToGet, otherwise Amazon DynamoDB returns a validation error.

hashKeyValue

AttributeValue hashKeyValue

Deprecated.

Attribute value of the hash component of the composite primary key.

rangeKeyCondition

Condition rangeKeyCondition

Deprecated.

A container for the attribute values and comparison operators to use for the query.

scanIndexForward

Boolean scanIndexForward

Deprecated.

Specifies forward or backward traversal of the index. Amazon DynamoDB returns results reflecting the requested order, determined by the range key. The default value is true (forward).

exclusiveStartKey

Key exclusiveStartKey

Deprecated.

Primary key of the item from which to continue an earlier query. An earlier query might provide this value as the LastEvaluatedKey if that query operation was interrupted before completing the query; either because of the result set size or the Limit parameter. The LastEvaluatedKey can be passed back in a new query request to continue the operation from that point.

Class com.amazonaws.services.dynamodb.model.QueryResult extends Object implements Serializable

Serialized Fields

items

List<E> items

Deprecated.

count

Integer count

Deprecated.

Number of items in the response.

lastEvaluatedKey

Key lastEvaluatedKey

Deprecated.

Primary key of the item where the query operation stopped, inclusive of the previous result set. Use this value to start a new operation excluding this value in the new request. The LastEvaluatedKey is null when the entire query result set is complete (i.e. the operation processed the "last page").

consumedCapacityUnits

Double consumedCapacityUnits

Deprecated.

The number of Capacity Units of the provisioned throughput of the table consumed during the operation. GetItem, BatchGetItem, BatchWriteItem, Query, and Scan operations consume ReadCapacityUnits, while PutItem, UpdateItem, and DeleteItem operations consume WriteCapacityUnits.

Class com.amazonaws.services.dynamodb.model.ResourceInUseException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.dynamodb.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.dynamodb.model.ScanRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

String tableName

Deprecated.

The name of the table in which you want to scan. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

attributesToGet

List<E> attributesToGet

Deprecated.

List of Attribute names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result.

Constraints:
Length: 1 -

limit

Integer limit

Deprecated.

The maximum number of items to return. If Amazon DynamoDB hits this limit while scanning the table, it stops the scan and returns the matching values up to the limit, and a LastEvaluatedKey to apply in a subsequent operation to continue the scan. Also, if the scanned data set size exceeds 1 MB before Amazon DynamoDB hits this limit, it stops the scan and returns the matching values up to the limit, and a LastEvaluatedKey to apply in a subsequent operation to continue the scan.

Constraints:
Range: 1 -

count

Boolean count

Deprecated.

If set to true, Amazon DynamoDB returns a total number of items for the Scan operation, even if the operation has no matching items for the assigned filter. Do not set Count to true while providing a list of AttributesToGet, otherwise Amazon DynamoDB returns a validation error.

scanFilter

Map<K,V> scanFilter

Deprecated.

Evaluates the scan results and returns only the desired values.

exclusiveStartKey

Key exclusiveStartKey

Deprecated.

Primary key of the item from which to continue an earlier scan. An earlier scan might provide this value if that scan operation was interrupted before scanning the entire table; either because of the result set size or the Limit parameter. The LastEvaluatedKey can be passed back in a new scan request to continue the operation from that point.

Class com.amazonaws.services.dynamodb.model.ScanResult extends Object implements Serializable

Serialized Fields

items

List<E> items

Deprecated.

count

Integer count

Deprecated.

Number of items in the response.

scannedCount

Integer scannedCount

Deprecated.

Number of items in the complete scan before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation.

lastEvaluatedKey

Key lastEvaluatedKey

Deprecated.

Primary key of the item where the scan operation stopped. Provide this value in a subsequent scan operation to continue the operation from that point. The LastEvaluatedKey is null when the entire scan result set is complete (i.e. the operation processed the "last page").

consumedCapacityUnits

Double consumedCapacityUnits

Deprecated.

The number of Capacity Units of the provisioned throughput of the table consumed during the operation. GetItem, BatchGetItem, BatchWriteItem, Query, and Scan operations consume ReadCapacityUnits, while PutItem, UpdateItem, and DeleteItem operations consume WriteCapacityUnits.

Class com.amazonaws.services.dynamodb.model.TableDescription extends Object implements Serializable

Serialized Fields

tableName

String tableName

Deprecated.

The name of the table being described.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

keySchema

KeySchema keySchema

Deprecated.

The KeySchema identifies the primary key as a one attribute primary key (hash) or a composite two attribute (hash-and-range) primary key. Single attribute primary keys have one index value: a HashKeyElement. A composite hash-and-range primary key contains two attribute values: a HashKeyElement and a RangeKeyElement.

tableStatus

String tableStatus

Deprecated.

creationDateTime

Date creationDateTime

Deprecated.

provisionedThroughput

ProvisionedThroughputDescription provisionedThroughput

Deprecated.

tableSizeBytes

Long tableSizeBytes

Deprecated.

itemCount

Long itemCount

Deprecated.

Class com.amazonaws.services.dynamodb.model.UpdateItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

String tableName

Deprecated.

The name of the table in which you want to update an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

key

Key key

Deprecated.

The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

attributeUpdates

Map<K,V> attributeUpdates

Deprecated.

Map of attribute name to the new value and action for the update. The attribute names specify the attributes to modify, and cannot contain any primary key attributes.

expected

Map<K,V> expected

Deprecated.

Designates an attribute for a conditional modification. The Expected parameter allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value before modifying it.

returnValues

String returnValues

Deprecated.

Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For PUT operations, the possible parameter values are NONE (default) or ALL_OLD. For update operations, the possible parameter values are NONE (default) or ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW.

• NONE: Nothing is returned.
• ALL_OLD: Returns the attributes of the item as they were before the operation.
• UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.
• ALL_NEW: Returns all the attributes and their new values after the operation.
• UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

Class com.amazonaws.services.dynamodb.model.UpdateItemResult extends Object implements Serializable

Serialized Fields

attributes

Map<K,V> attributes

Deprecated.

A map of attribute name-value pairs, but only if the ReturnValues parameter is specified as something other than NONE in the request.

consumedCapacityUnits

Double consumedCapacityUnits

Deprecated.

The number of Capacity Units of the provisioned throughput of the table consumed during the operation. GetItem, BatchGetItem, BatchWriteItem, Query, and Scan operations consume ReadCapacityUnits, while PutItem, UpdateItem, and DeleteItem operations consume WriteCapacityUnits.

Class com.amazonaws.services.dynamodb.model.UpdateTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

String tableName

Deprecated.

The name of the table you want to update. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

provisionedThroughput

ProvisionedThroughput provisionedThroughput

Deprecated.

Provisioned throughput reserves the required read and write resources for your table in terms of ReadCapacityUnits and WriteCapacityUnits. Values for provisioned throughput depend upon your expected read/write rates, item size, and consistency. Provide the expected number of read and write operations, assuming an item size of 1k and strictly consistent reads. For 2k item size, double the value. For 3k, triple the value, etc. Eventually-consistent reads consume half the resources of strictly consistent reads.

Class com.amazonaws.services.dynamodb.model.UpdateTableResult extends Object implements Serializable

Serialized Fields

tableDescription

TableDescription tableDescription

Deprecated.

Class com.amazonaws.services.dynamodb.model.WriteRequest extends Object implements Serializable

Serialized Fields

putRequest

PutRequest putRequest

Deprecated.

A container for a Put BatchWrite request

deleteRequest

DeleteRequest deleteRequest

Deprecated.

A container for a Delete BatchWrite request

Package com.amazonaws.services.dynamodbv2.datamodeling

Class com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMappingException extends RuntimeException implements Serializable

serialVersionUID: -4883173289978517967L

Package com.amazonaws.services.dynamodbv2.model

Class com.amazonaws.services.dynamodbv2.model.AttributeDefinition extends Object implements Serializable

Serialized Fields

attributeName

String attributeName

A name for the attribute.

Constraints:
Length: 1 - 255

attributeType

String attributeType

The data type for the attribute.

Constraints:
Allowed Values: S, N, B

Class com.amazonaws.services.dynamodbv2.model.AttributeValue extends Object implements Serializable

Serialized Fields

s

String s

Represents a String data type

n

String n

Represents a Number data type

b

ByteBuffer b

Represents a Binary data type

sS

List<E> sS

Represents a String set data type

nS

List<E> nS

Represents a Number set data type

bS

List<E> bS

Represents a Binary set data type

Class com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate extends Object implements Serializable

Serialized Fields

value

AttributeValue value

Represents the data for an attribute. You can set one, and only one, of the elements.

action

String action

Specifies how to perform the update. Valid values are PUT, DELETE, and ADD. The behavior depends on whether the specified primary key already exists in the table.

If an item with the specified Key is found in the table:

• PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.

• DELETE - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.

  If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specified [a,c], then the final attribute value would be [b]. Specifying an empty set is an error.

• ADD - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:

  • If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

    If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, Amazon 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, Amazon 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. Amazon 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 - Amazon 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 - Amazon DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.

Constraints:
Allowed Values: ADD, PUT, DELETE

Class com.amazonaws.services.dynamodbv2.model.BatchGetItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

requestItems

Map<K,V> requestItems

A map of one or more table names and, for each table, the corresponding primary keys for the items to retrieve. Each table name can be invoked only once.

Each element in the map consists of the following:

• Keys - An array of primary key attribute values that define specific items in the table.

• AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.

• ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.

Constraints:
Length: 1 - 100

returnConsumedCapacity

String returnConsumedCapacity

If set to TOTAL, ConsumedCapacity is included in the response; if set to NONE (the default), ConsumedCapacity is not included.

Constraints:
Allowed Values: TOTAL, NONE

Class com.amazonaws.services.dynamodbv2.model.BatchGetItemResult extends Object implements Serializable

Serialized Fields

responses

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.

unprocessedKeys

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 specified attribute is not found, it does not appear in the result.

If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

• 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.

Constraints:
Length: 1 - 100

consumedCapacity

List<E> consumedCapacity

The write capacity units consumed by the operation.

Each element consists of:

• TableName - The table that consumed the provisioned throughput.

• CapacityUnits - The total number of capacity units consumed.

Class com.amazonaws.services.dynamodbv2.model.BatchWriteItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

requestItems

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.

• PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

  • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException.

    If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

Constraints:
Length: 1 - 25

returnConsumedCapacity

String returnConsumedCapacity

If set to TOTAL, ConsumedCapacity is included in the response; if set to NONE (the default), ConsumedCapacity is not included.

Constraints:
Allowed Values: TOTAL, NONE

returnItemCollectionMetrics

String returnItemCollectionMetrics

If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned..

Constraints:
Allowed Values: SIZE, NONE

Class com.amazonaws.services.dynamodbv2.model.BatchWriteItemResult extends Object implements Serializable

Serialized Fields

unprocessedItems

Map<K,V> unprocessedItems

A map of tables and requests against those tables that were not processed. The UnprocessedKeys 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.

    If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

Constraints:
Length: 1 - 25

itemCollectionMetrics

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 hash key value of the item collection. This is the same as the hash key of the item.

• SizeEstimateRange - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the secondary indexes on the table. Use this estimate to measure whether a secondary index is approaching its size limit.

  The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

consumedCapacity

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.

Class com.amazonaws.services.dynamodbv2.model.Condition extends Object implements Serializable

Serialized Fields

attributeValueList

List<E> attributeValueList

Represents one or more values to evaluate against the supplied attribute. This list contains exactly one value, except for a BETWEEN or IN comparison, in which case the list contains two values.

For type Number, value comparisons are numeric.

String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

For Binary, Amazon DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.

comparisonOperator

String comparisonOperator

Represents a comparator for evaluating attributes. For example, equals, greater than, less than, etc.

Valid comparison operators for Query:

EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN

Valid comparison operators for Scan:

EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.

The following are descriptions of each comparison operator.

• EQ : Equal.

  AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

• NE : Not equal.

  AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

• LE : Less than or equal.

  AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

• LT : Less than.

  AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

• GE : Greater than or equal.

  AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

• GT : Greater than.

  AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

• NOT_NULL : The attribute exists.

• NULL : The attribute does not exist.

• CONTAINS : checks for a subsequence, or value in a set.

  AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for a member of the set (not as a substring).

• NOT_CONTAINS : checks for absence of a subsequence, or absence of a value in a set.

  AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for the absence of a member of the set (not as a substring).

• BEGINS_WITH : checks for a prefix.

  AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).

• IN : checks for exact matches.

  AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.

• BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

  AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}

Constraints:
Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH

Class com.amazonaws.services.dynamodbv2.model.ConditionalCheckFailedException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.dynamodbv2.model.ConsumedCapacity extends Object implements Serializable

Serialized Fields

tableName

String tableName

The table that consumed the provisioned throughput.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

capacityUnits

Double capacityUnits

The total number of capacity units consumed.

Class com.amazonaws.services.dynamodbv2.model.CreateTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeDefinitions

List<E> attributeDefinitions

An array of attributes that describe the key schema for the table and indexes.

tableName

String tableName

The name of the table to create.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

keySchema

List<E> keySchema

Specifies the attributes that make up the primary key for the table. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.

Each KeySchemaElement in the array is composed of:

• AttributeName - The name of this key attribute.

• KeyType - Determines whether the key attribute is HASH or RANGE.

For a primary key that consists of a hash attribute, you must specify exactly one element with a KeyType of HASH.

For a primary key that consists of hash and range attributes, you must specify exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.

For more information, see Specifying the Primary Key in the Amazon DynamoDB Developer Guide.

Constraints:
Length: 1 - 2

localSecondaryIndexes

List<E> localSecondaryIndexes

One or more secondary indexes (the maximum is five) to be created on the table. Each index is scoped to a given hash key value. There is a 10 gigabyte size limit per hash key; otherwise, the size of a local secondary index is unconstrained.

Each secondary index in the array includes the following:

• IndexName - The name of the secondary index. Must be unique only for this table.

• KeySchema - Specifies the key schema for the index. The key schema must begin with the same hash key attribute as the table.

• Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

  • ProjectionType - One of the following:

    • KEYS_ONLY - Only the index and primary keys are projected into the index.

    • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

    • ALL - All of the table attributes are projected into the index.

  • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the index. The total count of attributes specified in 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.

provisionedThroughput

ProvisionedThroughput provisionedThroughput

The provisioned throughput settings for the specified table. 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.

Class com.amazonaws.services.dynamodbv2.model.CreateTableResult extends Object implements Serializable

Serialized Fields

tableDescription

TableDescription tableDescription

Contains the properties of a table.

Class com.amazonaws.services.dynamodbv2.model.DeleteItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

String tableName

The name of the table from which to delete the item.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

key

Map<K,V> key

A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

expected

Map<K,V> expected

A map of attribute/condition pairs. This is the conditional block for the DeleteItemoperation. All the conditions must be met for the operation to succeed.

Expected allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it.

Each item in Expected represents an attribute name for Amazon DynamoDB to check, along with the following:

• Value - The attribute value for Amazon DynamoDB to check.

• Exists - Causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:

  • If Exists is true, Amazon 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, Amazon 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, Amazon DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.

  Amazon DynamoDB returns a ValidationException if:

  • Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)

  • Exists is false but you also specify a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)

If you specify more than one condition for Exists, then all of the conditions must evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the conditional operation will fail.

returnValues

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 is the default for ReturnValues.)

• ALL_OLD - The content of the old item is returned.

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

returnConsumedCapacity

String returnConsumedCapacity

If set to TOTAL, ConsumedCapacity is included in the response; if set to NONE (the default), ConsumedCapacity is not included.

Constraints:
Allowed Values: TOTAL, NONE

returnItemCollectionMetrics

String returnItemCollectionMetrics

If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned..

Constraints:
Allowed Values: SIZE, NONE

Class com.amazonaws.services.dynamodbv2.model.DeleteItemResult extends Object implements Serializable

Serialized Fields

attributes

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 consumedCapacity

The table name that consumed provisioned throughput, and the number of capacity units consumed by it. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

itemCollectionMetrics

ItemCollectionMetrics itemCollectionMetrics

Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if it was asked for in the request. If the table does not have any secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

• ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.

• SizeEstimateRange - An estimate of item collection size, measured in gigabytes. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the secondary indexes on that table. Use this estimate to measure whether a secondary index is approaching its size limit.

  The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

Class com.amazonaws.services.dynamodbv2.model.DeleteRequest extends Object implements Serializable

Serialized Fields

key

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.

Class com.amazonaws.services.dynamodbv2.model.DeleteTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

String tableName

The name of the table to delete.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.DeleteTableResult extends Object implements Serializable

Serialized Fields

tableDescription

TableDescription tableDescription

Contains the properties of a table.

Class com.amazonaws.services.dynamodbv2.model.DescribeTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

String tableName

The name of the table to describe.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.DescribeTableResult extends Object implements Serializable

Serialized Fields

table

TableDescription table

Contains the properties of a table.

Class com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue extends Object implements Serializable

Serialized Fields

value

AttributeValue value

Represents the data for an attribute. You can set one, and only one, of the elements.

exists

Boolean exists

Causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:

• If Exists is true, Amazon 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, Amazon 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, Amazon DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.

Amazon DynamoDB returns a ValidationException if:

• Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)

• Exists is false but you also specify a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)

If you specify more than one condition for Exists, then all of the conditions must evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the conditional operation will fail.

Class com.amazonaws.services.dynamodbv2.model.GetItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

String tableName

The name of the table containing the requested item.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

key

Map<K,V> key

A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve.

attributesToGet

List<E> attributesToGet

The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

Constraints:
Length: 1 -

consistentRead

Boolean consistentRead

If set to true, then the operation uses strongly consistent reads; otherwise, eventually consistent reads are used.

returnConsumedCapacity

String returnConsumedCapacity

If set to TOTAL, ConsumedCapacity is included in the response; if set to NONE (the default), ConsumedCapacity is not included.

Constraints:
Allowed Values: TOTAL, NONE

Class com.amazonaws.services.dynamodbv2.model.GetItemResult extends Object implements Serializable

Serialized Fields

item

Map<K,V> item

A map of attribute names to AttributeValue objects, as specified by AttributesToGet.

consumedCapacity

ConsumedCapacity consumedCapacity

The table name that consumed provisioned throughput, and the number of capacity units consumed by it. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

Class com.amazonaws.services.dynamodbv2.model.InternalServerErrorException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.dynamodbv2.model.ItemCollectionMetrics extends Object implements Serializable

Serialized Fields

itemCollectionKey

Map<K,V> itemCollectionKey

The hash key value of the item collection. This is the same as the hash key of the item.

sizeEstimateRangeGB

List<E> sizeEstimateRangeGB

An estimate of item collection size, measured in gigabytes. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the secondary indexes on that table. Use this estimate to measure whether a secondary index is approaching its size limit.

The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

Class com.amazonaws.services.dynamodbv2.model.ItemCollectionSizeLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.dynamodbv2.model.KeysAndAttributes extends Object implements Serializable

Serialized Fields

keys

List<E> keys

Represents the primary key attribute values that define the items and the attributes associated with the items.

Constraints:
Length: 1 - 100

attributesToGet

List<E> attributesToGet

Represents 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.

If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

Constraints:
Length: 1 -

consistentRead

Boolean consistentRead

Represents the consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

Class com.amazonaws.services.dynamodbv2.model.KeySchemaElement extends Object implements Serializable

Serialized Fields

attributeName

String attributeName

Represents the name of a key attribute.

Constraints:
Length: 1 - 255

keyType

String keyType

Represents the attribute data, consisting of the data type and the attribute value itself.

Constraints:
Allowed Values: HASH, RANGE

Class com.amazonaws.services.dynamodbv2.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.dynamodbv2.model.ListTablesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

exclusiveStartTableName

String exclusiveStartTableName

The name of the table that starts the list. If you already ran a ListTables operation and received a LastEvaluatedTableName value in the response, use that value here to continue the list.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

limit

Integer limit

A maximum number of table names to return.

Constraints:
Range: 1 - 100

Class com.amazonaws.services.dynamodbv2.model.ListTablesResult extends Object implements Serializable

Serialized Fields

tableNames

List<E> tableNames

The names of the tables associated with the current account at the current endpoint.

lastEvaluatedTableName

String lastEvaluatedTableName

The name of the last table in the current list, only if some tables for the account and endpoint have not been returned. This value does not exist in a response if all table names are already returned. Use this value as the ExclusiveStartTableName in a new request to continue the list until all the table names are returned.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndex extends Object implements Serializable

Serialized Fields

indexName

String indexName

Represents the name of the secondary index. The name must be unique among all other indexes on this table.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

keySchema

List<E> keySchema

Represents the complete index key schema, which consists of one or more pairs of attribute names and key types (HASH or RANGE).

Constraints:
Length: 1 - 2

projection

Projection projection

Represents 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.

Class com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndexDescription extends Object implements Serializable

Serialized Fields

indexName

String indexName

Represents the name of the secondary index.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

keySchema

List<E> keySchema

Represents the complete index key schema, which consists of one or more pairs of attribute names and key types (HASH or RANGE).

Constraints:
Length: 1 - 2

projection

Projection projection

Represents 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.

indexSizeBytes

Long indexSizeBytes

Represents the total size of the index, in bytes. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

itemCount

Long itemCount

Represents the number of items in the index. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

Class com.amazonaws.services.dynamodbv2.model.Projection extends Object implements Serializable

Serialized Fields

projectionType

String projectionType

Represents 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

nonKeyAttributes

List<E> nonKeyAttributes

Represents the non-key attribute names which will be projected into the index.

The total count of attributes specified in NonKeyAttributes, summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

Constraints:
Length: 1 - 20

Class com.amazonaws.services.dynamodbv2.model.ProvisionedThroughput extends Object implements Serializable

Serialized Fields

readCapacityUnits

Long readCapacityUnits

The maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

Constraints:
Range: 1 -

writeCapacityUnits

Long writeCapacityUnits

The maximum number of writes consumed per second before Amazon DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

Constraints:
Range: 1 -

Class com.amazonaws.services.dynamodbv2.model.ProvisionedThroughputDescription extends Object implements Serializable

Serialized Fields

lastIncreaseDateTime

Date lastIncreaseDateTime

The date and time of the last provisioned throughput increase for this table.

lastDecreaseDateTime

Date lastDecreaseDateTime

The date and time of the last provisioned throughput decrease for this table.

numberOfDecreasesToday

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 -

readCapacityUnits

Long readCapacityUnits

The maximum number of strongly consistent reads consumed per second before Amazon 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 -

writeCapacityUnits

Long writeCapacityUnits

The maximum number of writes consumed per second before Amazon DynamoDB returns a ThrottlingException.

Constraints:
Range: 1 -

Class com.amazonaws.services.dynamodbv2.model.ProvisionedThroughputExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.dynamodbv2.model.PutItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

String tableName

The name of the table to contain the item.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

item

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.

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

expected

Map<K,V> expected

A map of attribute/condition pairs. This is the conditional block for the PutItem operation. All the conditions must be met for the operation to succeed.

Expected allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it.

Each item in Expected represents an attribute name for Amazon DynamoDB to check, along with the following:

• Value - The attribute value for Amazon DynamoDB to check.

• Exists - Causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:

  • If Exists is true, Amazon 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, Amazon 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, Amazon DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.

  Amazon DynamoDB returns a ValidationException if:

  • Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)

  • Exists is false but you also specify a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)

If you specify more than one condition for Exists, then all of the conditions must evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the conditional operation will fail.

returnValues

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 is the default for ReturnValues.)

• ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

returnConsumedCapacity

String returnConsumedCapacity

If set to TOTAL, ConsumedCapacity is included in the response; if set to NONE (the default), ConsumedCapacity is not included.

Constraints:
Allowed Values: TOTAL, NONE

returnItemCollectionMetrics

String returnItemCollectionMetrics

If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned..

Constraints:
Allowed Values: SIZE, NONE

Class com.amazonaws.services.dynamodbv2.model.PutItemResult extends Object implements Serializable

Serialized Fields

attributes

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 consumedCapacity

The table name that consumed provisioned throughput, and the number of capacity units consumed by it. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

itemCollectionMetrics

ItemCollectionMetrics itemCollectionMetrics

Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if it was asked for in the request. If the table does not have any secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

• ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.

• SizeEstimateRange - An estimate of item collection size, measured in gigabytes. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the secondary indexes on that table. Use this estimate to measure whether a secondary index is approaching its size limit.

  The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

Class com.amazonaws.services.dynamodbv2.model.PutRequest extends Object implements Serializable

Serialized Fields

item

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.

Class com.amazonaws.services.dynamodbv2.model.QueryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

String tableName

The name of the table containing the requested items.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

indexName

String indexName

The name of an index on the table to query.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

select

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. For a table, this is the default. For an index, this mode causes Amazon DynamoDB to fetch the full item from the table for each matching item in the index. If the index is configured to project all item attributes, the matching items will not be fetched from the table. Fetching items from the table incurs additional throughput cost and latency.

• ALL_PROJECTED_ATTRIBUTES: Allowed only when querying an index. Retrieves all attributes which have been projected into the index. If the index is configured to project all attributes, this is equivalent to specifying ALL_ATTRIBUTES.

• COUNT: Returns the number of matching items, rather than the matching items themselves.

• SPECIFIC_ATTRIBUTES : Returns only the attributes listed in AttributesToGet. This is equivalent to specifying AttributesToGet without specifying any value for Select.

  If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

When neither Select nor AttributesToGet are specified, Amazon DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)

Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT

attributesToGet

List<E> attributesToGet

The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

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.)

Constraints:
Length: 1 -

limit

Integer limit

The maximum number of items to evaluate (not necessarily the number of matching items). If Amazon 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 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 Amazon DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a 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 -

consistentRead

Boolean consistentRead

If set to true, then the operation uses strongly consistent reads; otherwise, eventually consistent reads are used.

keyConditions

Map<K,V> keyConditions

The selection criteria for the query.

For a query on a table, you can only have conditions on the table primary key attributes. you must specify the hash key attribute name and value as an EQ condition. You can optionally specify a second condition, referring to the range key attribute.

For a query on a secondary index, you can only have conditions on the index key attributes. You must specify the index hash attribute name and value as an EQ condition. You can optionally specify a second condition, referring to the index key range attribute.

Multiple conditions are evaluated using "AND"; in other words, all of the conditions must be met in order for an item to appear in the results results.

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. This list contains exactly one value, except for a BETWEEN or IN comparison, in which case the list contains two values.

  For type Number, value comparisons are numeric.

  String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

  For Binary, Amazon DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.

• ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.

  Valid comparison operators for Query:

  EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN

  For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.

  The following are descriptions of each comparison operator.

  • EQ : Equal.

    AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

  • LE : Less than or equal.

    AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

  • LT : Less than.

    AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

  • GE : Greater than or equal.

    AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

  • GT : Greater than.

    AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

  • BEGINS_WITH : checks for a prefix.

    AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).

  • BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

    AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}

scanIndexForward

Boolean scanIndexForward

Specifies ascending (true) or descending (false) traversal of the index. Amazon DynamoDB returns results reflecting the requested order determined by the range key. If the data type is Number, the results are returned in numeric order. For String, the results are returned in order of ASCII character code values. For Binary, Amazon DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

If ScanIndexForward is not specified, the results are returned in ascending order.

exclusiveStartKey

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.

returnConsumedCapacity

String returnConsumedCapacity

If set to TOTAL, ConsumedCapacity is included in the response; if set to NONE (the default), ConsumedCapacity is not included.

Constraints:
Allowed Values: TOTAL, NONE

Class com.amazonaws.services.dynamodbv2.model.QueryResult extends Object implements Serializable

Serialized Fields

items

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.

count

Integer count

The number of items in the response.

lastEvaluatedKey

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.

LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).

consumedCapacity

ConsumedCapacity consumedCapacity

The table name that consumed provisioned throughput, and the number of capacity units consumed by it. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

Class com.amazonaws.services.dynamodbv2.model.ResourceInUseException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.dynamodbv2.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.dynamodbv2.model.ScanRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

String tableName

The name of the table containing the requested items.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

attributesToGet

List<E> attributesToGet

The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

Constraints:
Length: 1 -

limit

Integer limit

The maximum number of items to evaluate (not necessarily the number of matching items). If Amazon 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 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 Amazon DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a 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 -

select

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. For a table, this is the default. For an index, this mode causes Amazon DynamoDB to fetch the full item from the table for each matching item in the index. If the index is configured to project all item attributes, the matching items will not be fetched from the table. Fetching items from the table incurs additional throughput cost and latency.

• ALL_PROJECTED_ATTRIBUTES: Retrieves all attributes which have been projected into the index. If the index is configured to project all attributes, this is equivalent to specifying ALL_ATTRIBUTES.

• COUNT: Returns the number of matching items, rather than the matching items themselves.

• SPECIFIC_ATTRIBUTES : Returns only the attributes listed in AttributesToGet. This is equivalent to specifying AttributesToGet without specifying any value for Select.

  If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

When neither Select nor AttributesToGet are specified, Amazon DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)

Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT

scanFilter

Map<K,V> scanFilter

Evaluates the scan results and returns only the desired values. Multiple conditions are treated as "AND" operations: all conditions must be met to be included in the results.

Each ScanConditions element consists of an attribute name to compare, along with the following:

• AttributeValueList - One or more values to evaluate against the supplied attribute. This list contains exactly one value, except for a BETWEEN or IN comparison, in which case the list contains two values.

  For type Number, value comparisons are numeric.

  String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

  For Binary, Amazon DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.

• ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.

  Valid comparison operators for Scan:

  EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

  For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.

  The following are descriptions of each comparison operator.

  • EQ : Equal.

    AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

  • NE : Not equal.

    AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

  • LE : Less than or equal.

    AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

  • LT : Less than.

    AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

  • GE : Greater than or equal.

    AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

  • GT : Greater than.

    AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

  • NOT_NULL : The attribute exists.

  • NULL : The attribute does not exist.

  • CONTAINS : checks for a subsequence, or value in a set.

    AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for a member of the set (not as a substring).

  • NOT_CONTAINS : checks for absence of a subsequence, or absence of a value in a set.

    AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for the absence of a member of the set (not as a substring).

  • BEGINS_WITH : checks for a prefix.

    AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).

  • IN : checks for exact matches.

    AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.

  • BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

    AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}

exclusiveStartKey

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.

returnConsumedCapacity

String returnConsumedCapacity

If set to TOTAL, ConsumedCapacity is included in the response; if set to NONE (the default), ConsumedCapacity is not included.

Constraints:
Allowed Values: TOTAL, NONE

totalSegments

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 scan a table using four application threads, you would specify a TotalSegments value of 4.

The value for TotalSegments must be greater than or equal to 1, and less than or equal to 4096. If you specify a TotalSegments value of 1, the Scan will be sequential rather than parallel.

If you specify TotalSegments, you must also specify Segment.

Constraints:
Range: 1 - 4096

segment

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 scan a table using four application threads, the first thread would specify a Segment value of 0, the second thread would specify 1, and so on.

The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same Segment ID in a subsequent Scan operation.

The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.

If you specify Segment, you must also specify TotalSegments.

Constraints:
Range: 0 - 4095

Class com.amazonaws.services.dynamodbv2.model.ScanResult extends Object implements Serializable

Serialized Fields

items

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.

count

Integer count

The number of items in the response.

scannedCount

Integer scannedCount

The number of items in the complete scan, before any filters are 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.

lastEvaluatedKey

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.

LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).

If there are no remaining table or segment items to be scanned, LastEvaluatedKey is returned as null.

consumedCapacity

ConsumedCapacity consumedCapacity

The table name that consumed provisioned throughput, and the number of capacity units consumed by it. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

Class com.amazonaws.services.dynamodbv2.model.TableDescription extends Object implements Serializable

Serialized Fields

attributeDefinitions

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.

tableName

String tableName

The name of the table.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

keySchema

List<E> keySchema

The primary key structure for the table. Each KeySchemaElement consists of:

• AttributeName - The name of the attribute.

• KeyType - The key type for the attribute. Can be either HASH or RANGE.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Constraints:
Length: 1 - 2

tableStatus

String tableStatus

Represents the current state of the table:

• CREATING - The table is being created, as the result of a CreateTable operation.

• UPDATING - The table is being updated, as the result of an UpdateTable operation.

• DELETING - The table is being deleted, as the result of a DeleteTable operation.

• ACTIVE - The table is ready for use.

Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE

creationDateTime

Date creationDateTime

Represents the date and time when the table was created, in UNIX epoch time format.

provisionedThroughput

ProvisionedThroughputDescription provisionedThroughput

Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

tableSizeBytes

Long tableSizeBytes

Represents the total size of the specified table, in bytes. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

itemCount

Long itemCount

Represents the number of items in the specified table. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

localSecondaryIndexes

List<E> localSecondaryIndexes

Represents one or more secondary indexes on the table. Each index is scoped to a given hash key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

• IndexName - The name of the secondary index.

• KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table.

• Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

  • ProjectionType - One of the following:

    • KEYS_ONLY - Only the index and primary keys are projected into the index.

    • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

    • ALL - All of the table attributes are projected into the index.

  • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the index. The total count of attributes specified in 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.

• IndexSizeBytes - Represents the total size of the index, in bytes. Amazon 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. Amazon 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.

Class com.amazonaws.services.dynamodbv2.model.UpdateItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

String tableName

The name of the table containing the item to update.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

key

Map<K,V> key

The primary key that defines the item. Each element consists of an attribute name and a value for that attribute.

attributeUpdates

Map<K,V> attributeUpdates

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.

Each AttributeUpdates element consists of an attribute name to modify, along with the following:

• Value - The new value, if applicable, for this attribute.

• Action - Specifies how to perform the update. Valid values for Action are PUT, DELETE, and ADD. The behavior depends on whether the specified primary key already exists in the table.

  If an item with the specified Key is found in the table:

  • PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.

  • DELETE - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.

    If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specified [a,c], then the final attribute value would be [b]. Specifying an empty set is an error.

  • ADD - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:

    • If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

      If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, Amazon 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, Amazon 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. Amazon 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 - Amazon 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 - Amazon DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

expected

Map<K,V> expected

A map of attribute/condition pairs. This is the conditional block for the UpdateItem operation. All the conditions must be met for the operation to succeed.

Expected allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it.

Each item in Expected represents an attribute name for Amazon DynamoDB to check, along with the following:

• Value - The attribute value for Amazon DynamoDB to check.

• Exists - Causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:

  • If Exists is true, Amazon 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, Amazon 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, Amazon DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.

  Amazon DynamoDB returns a ValidationException if:

  • Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)

  • Exists is false but you also specify a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)

If you specify more than one condition for Exists, then all of the conditions must evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the conditional operation will fail.

returnValues

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 is the default for ReturnValues.)

• ALL_OLD - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.

• UPDATED_OLD - The old versions of only the updated attributes are returned.

• ALL_NEW - All of the attributes of the new version of the item are returned.

• UPDATED_NEW - The new versions of only the updated attributes are returned.

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

returnConsumedCapacity

String returnConsumedCapacity

If set to TOTAL, ConsumedCapacity is included in the response; if set to NONE (the default), ConsumedCapacity is not included.

Constraints:
Allowed Values: TOTAL, NONE

returnItemCollectionMetrics

String returnItemCollectionMetrics

If set to SIZE, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned..

Constraints:
Allowed Values: SIZE, NONE

Class com.amazonaws.services.dynamodbv2.model.UpdateItemResult extends Object implements Serializable

Serialized Fields

attributes

Map<K,V> attributes

A map of attribute values as they appeared before the UpdateItem operation, but only if ReturnValues was specified as something other than NONE in the request. Each element represents one attribute.

consumedCapacity

ConsumedCapacity consumedCapacity

The table name that consumed provisioned throughput, and the number of capacity units consumed by it. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

itemCollectionMetrics

ItemCollectionMetrics itemCollectionMetrics

Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if it was asked for in the request. If the table does not have any secondary indexes, this information is not returned in the response.

Class com.amazonaws.services.dynamodbv2.model.UpdateTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

String tableName

The name of the table to be updated.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

provisionedThroughput

ProvisionedThroughput provisionedThroughput

The provisioned throughput settings for the specified table. 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.

Class com.amazonaws.services.dynamodbv2.model.UpdateTableResult extends Object implements Serializable

Serialized Fields

tableDescription

TableDescription tableDescription

Contains the properties of a table.

Class com.amazonaws.services.dynamodbv2.model.WriteRequest extends Object implements Serializable

Serialized Fields

putRequest

PutRequest putRequest

Represents a request to perform a DeleteItem operation.

deleteRequest

DeleteRequest deleteRequest

Represents a request to perform a PutItem operation.

Package com.amazonaws.services.ec2.model

Class com.amazonaws.services.ec2.model.AccountAttribute extends Object implements Serializable

Serialized Fields

attributeName

String attributeName

attributeValues

List<E> attributeValues

Class com.amazonaws.services.ec2.model.AccountAttributeValue extends Object implements Serializable

Serialized Fields

attributeValue

String attributeValue

Class com.amazonaws.services.ec2.model.ActivateLicenseRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

licenseId

String licenseId

Specifies the ID for the specific license to activate against.

capacity

Integer capacity

Specifies the additional number of licenses to activate.

Class com.amazonaws.services.ec2.model.Address extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

publicIp

String publicIp

allocationId

String allocationId

associationId

String associationId

domain

String domain

networkInterfaceId

String networkInterfaceId

networkInterfaceOwnerId

String networkInterfaceOwnerId

privateIpAddress

String privateIpAddress

Class com.amazonaws.services.ec2.model.AllocateAddressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

Set to vpc to allocate the address to your VPC. By default, will allocate to EC2.

Constraints:
Allowed Values: vpc, standard

Class com.amazonaws.services.ec2.model.AllocateAddressResult extends Object implements Serializable

Serialized Fields

publicIp

String publicIp

IP address for use with your account.

domain

String domain

allocationId

String allocationId

Class com.amazonaws.services.ec2.model.AssignPrivateIpAddressesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

networkInterfaceId

String networkInterfaceId

privateIpAddresses

List<E> privateIpAddresses

secondaryPrivateIpAddressCount

Integer secondaryPrivateIpAddressCount

allowReassignment

Boolean allowReassignment

Class com.amazonaws.services.ec2.model.AssociateAddressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The instance to associate with the IP address.

publicIp

String publicIp

IP address that you are assigning to the instance.

allocationId

String allocationId

The allocation ID that AWS returned when you allocated the elastic IP address for use with Amazon VPC.

networkInterfaceId

String networkInterfaceId

privateIpAddress

String privateIpAddress

allowReassociation

Boolean allowReassociation

Class com.amazonaws.services.ec2.model.AssociateAddressResult extends Object implements Serializable

Serialized Fields

associationId

String associationId

Class com.amazonaws.services.ec2.model.AssociateDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dhcpOptionsId

String dhcpOptionsId

The ID of the DHCP options to associate with the VPC. Specify "default" to associate the default DHCP options with the VPC.

vpcId

String vpcId

The ID of the VPC to associate the DHCP options with.

Class com.amazonaws.services.ec2.model.AssociateRouteTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

subnetId

String subnetId

The ID of the subnet.

routeTableId

String routeTableId

The ID of the route table.

Class com.amazonaws.services.ec2.model.AssociateRouteTableResult extends Object implements Serializable

Serialized Fields

associationId

String associationId

Class com.amazonaws.services.ec2.model.AttachInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

internetGatewayId

String internetGatewayId

The ID of the Internet gateway to attach.

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.AttachNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

networkInterfaceId

String networkInterfaceId

instanceId

String instanceId

deviceIndex

Integer deviceIndex

Class com.amazonaws.services.ec2.model.AttachNetworkInterfaceResult extends Object implements Serializable

Serialized Fields

attachmentId

String attachmentId

Class com.amazonaws.services.ec2.model.AttachVolumeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeId

String volumeId

The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone and the instance must be running.

instanceId

String instanceId

The ID of the instance to which the volume attaches. The volume and instance must be within the same Availability Zone and the instance must be running.

device

String device

Specifies how the device is exposed to the instance (e.g., /dev/sdh).

Class com.amazonaws.services.ec2.model.AttachVolumeResult extends Object implements Serializable

Serialized Fields

attachment

VolumeAttachment attachment

Class com.amazonaws.services.ec2.model.AttachVpnGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpnGatewayId

String vpnGatewayId

The ID of the VPN gateway to attach to the VPC.

vpcId

String vpcId

The ID of the VPC to attach to the VPN gateway.

Class com.amazonaws.services.ec2.model.AttachVpnGatewayResult extends Object implements Serializable

Serialized Fields

vpcAttachement

VpcAttachment vpcAttachement

Class com.amazonaws.services.ec2.model.AuthorizeSecurityGroupEgressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupId

String groupId

ID of the VPC security group to modify.

sourceSecurityGroupName

String sourceSecurityGroupName

Deprecated.

sourceSecurityGroupOwnerId

String sourceSecurityGroupOwnerId

Deprecated.

ipProtocol

String ipProtocol

Deprecated.

fromPort

Integer fromPort

Deprecated.

toPort

Integer toPort

Deprecated.

cidrIp

String cidrIp

Deprecated.

ipPermissions

List<E> ipPermissions

List of IP permissions to authorize on the specified security group. Specifying permissions through IP permissions is the preferred way of authorizing permissions since it offers more flexibility and control.

Class com.amazonaws.services.ec2.model.AuthorizeSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

Name of the standard (EC2) security group to modify. The group must belong to your account. Can be used instead of GroupID for standard (EC2) security groups.

groupId

String groupId

ID of the standard (EC2) or VPC security group to modify. The group must belong to your account. Required for VPC security groups; can be used instead of GroupName for standard (EC2) security groups.

sourceSecurityGroupName

String sourceSecurityGroupName

Deprecated

sourceSecurityGroupOwnerId

String sourceSecurityGroupOwnerId

Deprecated

ipProtocol

String ipProtocol

Deprecated

fromPort

Integer fromPort

Deprecated

toPort

Integer toPort

Deprecated

cidrIp

String cidrIp

Deprecated

ipPermissions

List<E> ipPermissions

List of IP permissions to authorize on the specified security group. Specifying permissions through IP permissions is the preferred way of authorizing permissions since it offers more flexibility and control.

Class com.amazonaws.services.ec2.model.AvailabilityZone extends Object implements Serializable

Serialized Fields

zoneName

String zoneName

Name of the Availability Zone.

state

String state

State of the Availability Zone.

regionName

String regionName

Name of the region in which this zone resides.

messages

List<E> messages

A list of messages about the Availability Zone.

Class com.amazonaws.services.ec2.model.AvailabilityZoneMessage extends Object implements Serializable

Serialized Fields

message

String message

Class com.amazonaws.services.ec2.model.BlockDeviceMapping extends Object implements Serializable

Serialized Fields

virtualName

String virtualName

Specifies the virtual device name.

deviceName

String deviceName

Specifies the device name (e.g., /dev/sdh).

ebs

EbsBlockDevice ebs

Specifies parameters used to automatically setup Amazon EBS volumes when the instance is launched.

noDevice

String noDevice

Specifies the device name to suppress during instance launch.

Class com.amazonaws.services.ec2.model.BundleInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The ID of the instance to bundle.

storage

Storage storage

Class com.amazonaws.services.ec2.model.BundleInstanceResult extends Object implements Serializable

Serialized Fields

bundleTask

BundleTask bundleTask

Class com.amazonaws.services.ec2.model.BundleTask extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

Instance associated with this bundle task.

bundleId

String bundleId

Unique identifier for this task.

state

String state

The state of this task.

startTime

Date startTime

The time this task started.

updateTime

Date updateTime

The time of the most recent update for the task.

storage

Storage storage

Amazon S3 storage locations.

progress

String progress

The level of task completion, in percent (e.g., 20%).

bundleTaskError

BundleTaskError bundleTaskError

If the task fails, a description of the error.

Class com.amazonaws.services.ec2.model.BundleTaskError extends Object implements Serializable

Serialized Fields

code

String code

Error code.

message

String message

Error message.

Class com.amazonaws.services.ec2.model.CancelBundleTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bundleId

String bundleId

The ID of the bundle task to cancel.

Class com.amazonaws.services.ec2.model.CancelBundleTaskResult extends Object implements Serializable

Serialized Fields

bundleTask

BundleTask bundleTask

The canceled bundle task.

Class com.amazonaws.services.ec2.model.CancelConversionTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

conversionTaskId

String conversionTaskId

reasonMessage

String reasonMessage

Class com.amazonaws.services.ec2.model.CancelExportTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

exportTaskId

String exportTaskId

Class com.amazonaws.services.ec2.model.CancelledSpotInstanceRequest extends Object implements Serializable

Serialized Fields

spotInstanceRequestId

String spotInstanceRequestId

state

String state

Class com.amazonaws.services.ec2.model.CancelReservedInstancesListingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

reservedInstancesListingId

String reservedInstancesListingId

Class com.amazonaws.services.ec2.model.CancelReservedInstancesListingResult extends Object implements Serializable

Serialized Fields

reservedInstancesListings

List<E> reservedInstancesListings

Class com.amazonaws.services.ec2.model.CancelSpotInstanceRequestsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

spotInstanceRequestIds

List<E> spotInstanceRequestIds

Specifies the ID of the Spot Instance request.

Class com.amazonaws.services.ec2.model.CancelSpotInstanceRequestsResult extends Object implements Serializable

Serialized Fields

cancelledSpotInstanceRequests

List<E> cancelledSpotInstanceRequests

Class com.amazonaws.services.ec2.model.ConfirmProductInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

productCode

String productCode

The product code to confirm.

instanceId

String instanceId

The ID of the instance to confirm.

Class com.amazonaws.services.ec2.model.ConfirmProductInstanceResult extends Object implements Serializable

Serialized Fields

ownerId

String ownerId

The instance owner's account ID. Only present if the product code is attached to the instance.

Class com.amazonaws.services.ec2.model.ConversionTask extends Object implements Serializable

Serialized Fields

conversionTaskId

String conversionTaskId

expirationTime

String expirationTime

importInstance

ImportInstanceTaskDetails importInstance

importVolume

ImportVolumeTaskDetails importVolume

state

String state

statusMessage

String statusMessage

tags

List<E> tags

Class com.amazonaws.services.ec2.model.CopyImageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sourceRegion

String sourceRegion

sourceImageId

String sourceImageId

name

String name

description

String description

clientToken

String clientToken

Class com.amazonaws.services.ec2.model.CopyImageResult extends Object implements Serializable

Serialized Fields

imageId

String imageId

Class com.amazonaws.services.ec2.model.CopySnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sourceRegion

String sourceRegion

sourceSnapshotId

String sourceSnapshotId

description

String description

Class com.amazonaws.services.ec2.model.CopySnapshotResult extends Object implements Serializable

Serialized Fields

snapshotId

String snapshotId

Class com.amazonaws.services.ec2.model.CreateCustomerGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

type

String type

The type of VPN connection this customer gateway supports.

publicIp

String publicIp

The Internet-routable IP address for the customer gateway's outside interface. The address must be static

bgpAsn

Integer bgpAsn

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

Class com.amazonaws.services.ec2.model.CreateCustomerGatewayResult extends Object implements Serializable

Serialized Fields

customerGateway

CustomerGateway customerGateway

Information about the customer gateway.

Class com.amazonaws.services.ec2.model.CreateDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dhcpConfigurations

List<E> dhcpConfigurations

A set of one or more DHCP configurations.

Class com.amazonaws.services.ec2.model.CreateDhcpOptionsResult extends Object implements Serializable

Serialized Fields

dhcpOptions

DhcpOptions dhcpOptions

A set of one or more DHCP options.

Class com.amazonaws.services.ec2.model.CreateImageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The ID of the instance from which to create the new image.

name

String name

The name for the new AMI being created.

description

String description

The description for the new AMI being created.

noReboot

Boolean noReboot

By default this property is set to false, which means Amazon EC2 attempts to cleanly shut down the instance before image creation and reboots the instance afterwards. When set to true, Amazon EC2 will not shut down the instance before creating the image. When this option is used, file system integrity on the created image cannot be guaranteed.

blockDeviceMappings

List<E> blockDeviceMappings

Class com.amazonaws.services.ec2.model.CreateImageResult extends Object implements Serializable

Serialized Fields

imageId

String imageId

The ID of the new AMI.

Class com.amazonaws.services.ec2.model.CreateInstanceExportTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

String description

instanceId

String instanceId

targetEnvironment

String targetEnvironment

exportToS3Task

ExportToS3TaskSpecification exportToS3Task

Class com.amazonaws.services.ec2.model.CreateInstanceExportTaskResult extends Object implements Serializable

Serialized Fields

exportTask

ExportTask exportTask

Class com.amazonaws.services.ec2.model.CreateInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.ec2.model.CreateInternetGatewayResult extends Object implements Serializable

Serialized Fields

internetGateway

InternetGateway internetGateway

Class com.amazonaws.services.ec2.model.CreateKeyPairRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyName

String keyName

The unique name for the new key pair.

Class com.amazonaws.services.ec2.model.CreateKeyPairResult extends Object implements Serializable

Serialized Fields

keyPair

KeyPair keyPair

The newly created EC2 key pair.

Class com.amazonaws.services.ec2.model.CreateNetworkAclEntryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

networkAclId

String networkAclId

ID of the ACL where the entry will be created.

ruleNumber

Integer ruleNumber

Rule number to assign to the entry (e.g., 100). ACL entries are processed in ascending order by rule number.

protocol

String protocol

IP protocol the rule applies to. Valid Values: tcp, udp, icmp or an IP protocol number.

ruleAction

String ruleAction

Whether to allow or deny traffic that matches the rule.

Constraints:
Allowed Values: allow, deny

egress

Boolean egress

Whether this rule applies to egress traffic from the subnet (true) or ingress traffic to the subnet (false).

cidrBlock

String cidrBlock

The CIDR range to allow or deny, in CIDR notation (e.g., 172.16.0.0/24).

icmpTypeCode

IcmpTypeCode icmpTypeCode

ICMP values.

portRange

PortRange portRange

Port ranges.

Class com.amazonaws.services.ec2.model.CreateNetworkAclRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

String vpcId

The ID of the VPC where the network ACL will be created.

Class com.amazonaws.services.ec2.model.CreateNetworkAclResult extends Object implements Serializable

Serialized Fields

networkAcl

NetworkAcl networkAcl

Class com.amazonaws.services.ec2.model.CreateNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

subnetId

String subnetId

description

String description

privateIpAddress

String privateIpAddress

groups

List<E> groups

privateIpAddresses

List<E> privateIpAddresses

secondaryPrivateIpAddressCount

Integer secondaryPrivateIpAddressCount

Class com.amazonaws.services.ec2.model.CreateNetworkInterfaceResult extends Object implements Serializable

Serialized Fields

networkInterface

NetworkInterface networkInterface

Class com.amazonaws.services.ec2.model.CreatePlacementGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

The name of the PlacementGroup.

strategy

String strategy

The PlacementGroup strategy.

Constraints:
Allowed Values: cluster

Class com.amazonaws.services.ec2.model.CreateReservedInstancesListingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

reservedInstancesId

String reservedInstancesId

instanceCount

Integer instanceCount

priceSchedules

List<E> priceSchedules

clientToken

String clientToken

Class com.amazonaws.services.ec2.model.CreateReservedInstancesListingResult extends Object implements Serializable

Serialized Fields

reservedInstancesListings

List<E> reservedInstancesListings

Class com.amazonaws.services.ec2.model.CreateRouteRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

routeTableId

String routeTableId

The ID of the route table where the route will be added.

destinationCidrBlock

String destinationCidrBlock

The CIDR address block used for the destination match. For example: 0.0.0.0/0. Routing decisions are based on the most specific match.

gatewayId

String gatewayId

The ID of a VPN or Internet gateway attached to your VPC. You must provide either GatewayId or InstanceId, but not both.

instanceId

String instanceId

The ID of a NAT instance in your VPC. You must provide either GatewayId or InstanceId, but not both.

networkInterfaceId

String networkInterfaceId

Class com.amazonaws.services.ec2.model.CreateRouteTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

String vpcId

The ID of the VPC where the route table will be created.

Class com.amazonaws.services.ec2.model.CreateRouteTableResult extends Object implements Serializable

Serialized Fields

routeTable

RouteTable routeTable

Class com.amazonaws.services.ec2.model.CreateSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

Name of the security group.

description

String description

Description of the group. This is informational only.

vpcId

String vpcId

ID of the VPC.

Class com.amazonaws.services.ec2.model.CreateSecurityGroupResult extends Object implements Serializable

Serialized Fields

groupId

String groupId

Class com.amazonaws.services.ec2.model.CreateSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeId

String volumeId

The ID of the volume from which to create the snapshot.

description

String description

The description for the new snapshot.

Class com.amazonaws.services.ec2.model.CreateSnapshotResult extends Object implements Serializable

Serialized Fields

snapshot

Snapshot snapshot

The new snapshot.

Class com.amazonaws.services.ec2.model.CreateSpotDatafeedSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucket

String bucket

The Amazon S3 bucket in which to store the Spot Instance datafeed.

prefix

String prefix

The prefix that is prepended to datafeed files.

Class com.amazonaws.services.ec2.model.CreateSpotDatafeedSubscriptionResult extends Object implements Serializable

Serialized Fields

spotDatafeedSubscription

SpotDatafeedSubscription spotDatafeedSubscription

The SpotDatafeedSubscriptionType data type.

Class com.amazonaws.services.ec2.model.CreateSubnetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

String vpcId

The ID of the VPC to create the subnet in.

cidrBlock

String cidrBlock

The CIDR block the subnet is to cover.

availabilityZone

String availabilityZone

The Availability Zone to create the subnet in.

Class com.amazonaws.services.ec2.model.CreateSubnetResult extends Object implements Serializable

Serialized Fields

subnet

Subnet subnet

Class com.amazonaws.services.ec2.model.CreateTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resources

List<E> resources

One or more IDs of resources to tag. This could be the ID of an AMI, an instance, an EBS volume, or snapshot, etc.

tags

List<E> tags

The tags to add or overwrite for the specified resources. Each tag item consists of a key-value pair.

Class com.amazonaws.services.ec2.model.CreateVolumePermission extends Object implements Serializable

Serialized Fields

userId

String userId

The user ID of the user that can create volumes from the snapshot.

group

String group

The group that is allowed to create volumes from the snapshot (currently supports "all").

Class com.amazonaws.services.ec2.model.CreateVolumePermissionModifications extends Object implements Serializable

Serialized Fields

add

List<E> add

remove

List<E> remove

Class com.amazonaws.services.ec2.model.CreateVolumeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

size

Integer size

The size of the volume, in gigabytes. Required if you are not creating a volume from a snapshot.

snapshotId

String snapshotId

The ID of the snapshot from which to create the new volume.

availabilityZone

String availabilityZone

The Availability Zone in which to create the new volume.

volumeType

String volumeType

iops

Integer iops

Class com.amazonaws.services.ec2.model.CreateVolumeResult extends Object implements Serializable

Serialized Fields

volume

Volume volume

The newly created EBS volume.

Class com.amazonaws.services.ec2.model.CreateVpcRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cidrBlock

String cidrBlock

A valid CIDR block.

instanceTenancy

String instanceTenancy

The allowed tenancy of instances launched into the VPC. A value of default means instances can be launched with any tenancy; a value of dedicated means instances must be launched with tenancy as dedicated.

Class com.amazonaws.services.ec2.model.CreateVpcResult extends Object implements Serializable

Serialized Fields

vpc

Vpc vpc

Information about the VPC.

Class com.amazonaws.services.ec2.model.CreateVpnConnectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

type

String type

The type of VPN connection.

customerGatewayId

String customerGatewayId

The ID of the customer gateway.

vpnGatewayId

String vpnGatewayId

The ID of the VPN gateway.

options

VpnConnectionOptionsSpecification options

Class com.amazonaws.services.ec2.model.CreateVpnConnectionResult extends Object implements Serializable

Serialized Fields

vpnConnection

VpnConnection vpnConnection

Class com.amazonaws.services.ec2.model.CreateVpnConnectionRouteRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpnConnectionId

String vpnConnectionId

destinationCidrBlock

String destinationCidrBlock

Class com.amazonaws.services.ec2.model.CreateVpnGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

type

String type

The type of VPN connection this VPN gateway supports.

availabilityZone

String availabilityZone

The Availability Zone in which to create the VPN gateway.

Class com.amazonaws.services.ec2.model.CreateVpnGatewayResult extends Object implements Serializable

Serialized Fields

vpnGateway

VpnGateway vpnGateway

Class com.amazonaws.services.ec2.model.CustomerGateway extends Object implements Serializable

Serialized Fields

customerGatewayId

String customerGatewayId

Specifies the ID of the customer gateway.

state

String state

Describes the current state of the customer gateway. Valid values are pending, available, deleting, and deleted.

type

String type

Specifies the type of VPN connection the customer gateway supports.

ipAddress

String ipAddress

Contains the Internet-routable IP address of the customer gateway's outside interface.

bgpAsn

String bgpAsn

Specifies the customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

tags

List<E> tags

A list of tags for the CustomerGateway.

Class com.amazonaws.services.ec2.model.DeactivateLicenseRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

licenseId

String licenseId

Specifies the ID for the specific license to deactivate against.

capacity

Integer capacity

Specifies the amount of capacity to deactivate against the license.

Class com.amazonaws.services.ec2.model.DeleteCustomerGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

customerGatewayId

String customerGatewayId

The ID of the customer gateway to delete.

Class com.amazonaws.services.ec2.model.DeleteDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dhcpOptionsId

String dhcpOptionsId

The ID of the DHCP options set to delete.

Class com.amazonaws.services.ec2.model.DeleteInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

internetGatewayId

String internetGatewayId

The ID of the Internet gateway to be deleted.

Class com.amazonaws.services.ec2.model.DeleteKeyPairRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyName

String keyName

The name of the Amazon EC2 key pair to delete.

Class com.amazonaws.services.ec2.model.DeleteNetworkAclEntryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

networkAclId

String networkAclId

ID of the network ACL.

ruleNumber

Integer ruleNumber

Rule number for the entry to delete.

egress

Boolean egress

Whether the rule to delete is an egress rule (true) or ingress rule (false).

Class com.amazonaws.services.ec2.model.DeleteNetworkAclRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

networkAclId

String networkAclId

The ID of the network ACL to be deleted.

Class com.amazonaws.services.ec2.model.DeleteNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

networkInterfaceId

String networkInterfaceId

Class com.amazonaws.services.ec2.model.DeletePlacementGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

The name of the PlacementGroup to delete.

Class com.amazonaws.services.ec2.model.DeleteRouteRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

routeTableId

String routeTableId

The ID of the route table where the route will be deleted.

destinationCidrBlock

String destinationCidrBlock

The CIDR range for the route you want to delete. The value you specify must exactly match the CIDR for the route you want to delete.

Class com.amazonaws.services.ec2.model.DeleteRouteTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

routeTableId

String routeTableId

The ID of the route table to be deleted.

Class com.amazonaws.services.ec2.model.DeleteSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

The name of the Amazon EC2 security group to delete.

groupId

String groupId

The ID of the Amazon EC2 security group to delete.

Class com.amazonaws.services.ec2.model.DeleteSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

snapshotId

String snapshotId

The ID of the snapshot to delete.

Class com.amazonaws.services.ec2.model.DeleteSpotDatafeedSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.ec2.model.DeleteSubnetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

subnetId

String subnetId

The ID of the subnet you want to delete.

Class com.amazonaws.services.ec2.model.DeleteTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resources

List<E> resources

A list of one or more resource IDs. This could be the ID of an AMI, an instance, an EBS volume, or snapshot, etc.

tags

List<E> tags

The tags to delete from the specified resources. Each tag item consists of a key-value pair.

If a tag is specified without a value, the tag and all of its values are deleted.

Class com.amazonaws.services.ec2.model.DeleteVolumeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeId

String volumeId

The ID of the EBS volume to delete.

Class com.amazonaws.services.ec2.model.DeleteVpcRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

String vpcId

The ID of the VPC you want to delete.

Class com.amazonaws.services.ec2.model.DeleteVpnConnectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpnConnectionId

String vpnConnectionId

The ID of the VPN connection to delete

Class com.amazonaws.services.ec2.model.DeleteVpnConnectionRouteRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpnConnectionId

String vpnConnectionId

destinationCidrBlock

String destinationCidrBlock

Class com.amazonaws.services.ec2.model.DeleteVpnGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpnGatewayId

String vpnGatewayId

The ID of the VPN gateway to delete.

Class com.amazonaws.services.ec2.model.DeregisterImageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

imageId

String imageId

The ID of the AMI to deregister.

Class com.amazonaws.services.ec2.model.DescribeAccountAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeNames

List<E> attributeNames

Class com.amazonaws.services.ec2.model.DescribeAccountAttributesResult extends Object implements Serializable

Serialized Fields

accountAttributes

List<E> accountAttributes

Class com.amazonaws.services.ec2.model.DescribeAddressesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

publicIps

List<E> publicIps

The optional list of Elastic IP addresses to describe.

filters

List<E> filters

A list of filters used to match properties for Addresses. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

allocationIds

List<E> allocationIds

Class com.amazonaws.services.ec2.model.DescribeAddressesResult extends Object implements Serializable

Serialized Fields

addresses

List<E> addresses

The list of Elastic IPs.

Class com.amazonaws.services.ec2.model.DescribeAvailabilityZonesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

zoneNames

List<E> zoneNames

A list of the availability zone names to describe.

filters

List<E> filters

A list of filters used to match properties for AvailabilityZones. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Class com.amazonaws.services.ec2.model.DescribeAvailabilityZonesResult extends Object implements Serializable

Serialized Fields

availabilityZones

List<E> availabilityZones

The list of described Amazon EC2 availability zones.

Class com.amazonaws.services.ec2.model.DescribeBundleTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bundleIds

List<E> bundleIds

The list of bundle task IDs to describe.

filters

List<E> filters

A list of filters used to match properties for BundleTasks. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Class com.amazonaws.services.ec2.model.DescribeBundleTasksResult extends Object implements Serializable

Serialized Fields

bundleTasks

List<E> bundleTasks

The list of described bundle tasks.

Class com.amazonaws.services.ec2.model.DescribeConversionTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

List<E> filters

conversionTaskIds

List<E> conversionTaskIds

Class com.amazonaws.services.ec2.model.DescribeConversionTasksResult extends Object implements Serializable

Serialized Fields

conversionTasks

List<E> conversionTasks

Class com.amazonaws.services.ec2.model.DescribeCustomerGatewaysRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

customerGatewayIds

List<E> customerGatewayIds

A set of one or more customer gateway IDs.

filters

List<E> filters

A list of filters used to match properties for Customer Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Class com.amazonaws.services.ec2.model.DescribeCustomerGatewaysResult extends Object implements Serializable

Serialized Fields

customerGateways

List<E> customerGateways

Class com.amazonaws.services.ec2.model.DescribeDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dhcpOptionsIds

List<E> dhcpOptionsIds

filters

List<E> filters

A list of filters used to match properties for DhcpOptions. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Class com.amazonaws.services.ec2.model.DescribeDhcpOptionsResult extends Object implements Serializable

Serialized Fields

dhcpOptions

List<E> dhcpOptions

Class com.amazonaws.services.ec2.model.DescribeExportTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

exportTaskIds

List<E> exportTaskIds

Class com.amazonaws.services.ec2.model.DescribeExportTasksResult extends Object implements Serializable

Serialized Fields

exportTasks

List<E> exportTasks

Class com.amazonaws.services.ec2.model.DescribeImageAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

imageId

String imageId

The ID of the AMI whose attribute is to be described.

attribute

String attribute

The name of the attribute to describe.

Available attribute names: productCodes, kernel, ramdisk, launchPermisson, blockDeviceMapping

Class com.amazonaws.services.ec2.model.DescribeImageAttributeResult extends Object implements Serializable

Serialized Fields

imageAttribute

ImageAttribute imageAttribute

The described image attribute of the associated AMI.

Class com.amazonaws.services.ec2.model.DescribeImagesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

imageIds

List<E> imageIds

An optional list of the AMI IDs to describe. If not specified, all AMIs will be described.

owners

List<E> owners

The optional list of owners for the described AMIs. The IDs amazon, self, and explicit can be used to include AMIs owned by Amazon, AMIs owned by the user, and AMIs for which the user has explicit launch permissions, respectively.

executableUsers

List<E> executableUsers

The optional list of users with explicit launch permissions for the described AMIs. The user ID can be a user's account ID, 'self' to return AMIs for which the sender of the request has explicit launch permissions, or 'all' to return AMIs with public launch permissions.

filters

List<E> filters

A list of filters used to match properties for Images. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Class com.amazonaws.services.ec2.model.DescribeImagesResult extends Object implements Serializable

Serialized Fields

images

List<E> images

The list of the described AMIs.

Class com.amazonaws.services.ec2.model.DescribeInstanceAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The ID of the instance whose instance attribute is being described.

attribute

String attribute

The name of the attribute to describe.

Available attribute names: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping

Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized

Class com.amazonaws.services.ec2.model.DescribeInstanceAttributeResult extends Object implements Serializable

Serialized Fields

instanceAttribute

InstanceAttribute instanceAttribute

The described instance attribute.

Class com.amazonaws.services.ec2.model.DescribeInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceIds

List<E> instanceIds

An optional list of the instances to describe.

filters

List<E> filters

A list of filters used to match properties for Instances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Class com.amazonaws.services.ec2.model.DescribeInstancesResult extends Object implements Serializable

Serialized Fields

reservations

List<E> reservations

The list of reservations containing the describes instances.

Class com.amazonaws.services.ec2.model.DescribeInstanceStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceIds

List<E> instanceIds

The list of instance IDs. If not specified, all instances are described.

filters

List<E> filters

The list of filters to limit returned results.

nextToken

String nextToken

A string specifying the next paginated set of results to return.

maxResults

Integer maxResults

The maximum number of paginated instance items per response.

includeAllInstances

Boolean includeAllInstances

Class com.amazonaws.services.ec2.model.DescribeInstanceStatusResult extends Object implements Serializable

Serialized Fields

instanceStatuses

List<E> instanceStatuses

Collection of instance statuses describing the state of the requested instances.

nextToken

String nextToken

A string specifying the next paginated set of results to return.

Class com.amazonaws.services.ec2.model.DescribeInternetGatewaysRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

internetGatewayIds

List<E> internetGatewayIds

One or more Internet gateway IDs.

filters

List<E> filters

A list of filters used to match properties for Internet Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Class com.amazonaws.services.ec2.model.DescribeInternetGatewaysResult extends Object implements Serializable

Serialized Fields

internetGateways

List<E> internetGateways

Class com.amazonaws.services.ec2.model.DescribeKeyPairsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyNames

List<E> keyNames

The optional list of key pair names to describe.

filters

List<E> filters

A list of filters used to match properties for KeyPairs. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Class com.amazonaws.services.ec2.model.DescribeKeyPairsResult extends Object implements Serializable

Serialized Fields

keyPairs

List<E> keyPairs

The list of described key pairs.

Class com.amazonaws.services.ec2.model.DescribeLicensesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

licenseIds

List<E> licenseIds

Specifies the license registration for which details are to be returned.

filters

List<E> filters

A list of filters used to match properties for Licenses. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Class com.amazonaws.services.ec2.model.DescribeLicensesResult extends Object implements Serializable

Serialized Fields

licenses

List<E> licenses

Specifies active licenses in use and attached to an Amazon EC2 instance.

Class com.amazonaws.services.ec2.model.DescribeNetworkAclsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

networkAclIds

List<E> networkAclIds

One or more network ACL IDs.

filters

List<E> filters

A list of filters used to match properties for Network ACLs. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Class com.amazonaws.services.ec2.model.DescribeNetworkAclsResult extends Object implements Serializable

Serialized Fields

networkAcls

List<E> networkAcls

Class com.amazonaws.services.ec2.model.DescribeNetworkInterfaceAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

networkInterfaceId

String networkInterfaceId

description

String description

sourceDestCheck

String sourceDestCheck

groups

String groups

attachment

String attachment

Class com.amazonaws.services.ec2.model.DescribeNetworkInterfaceAttributeResult extends Object implements Serializable

Serialized Fields

networkInterfaceId

String networkInterfaceId

description

String description

String value

sourceDestCheck

Boolean sourceDestCheck

Boolean value

groups

List<E> groups

attachment

NetworkInterfaceAttachment attachment

Class com.amazonaws.services.ec2.model.DescribeNetworkInterfacesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

networkInterfaceIds

List<E> networkInterfaceIds

filters

List<E> filters

Class com.amazonaws.services.ec2.model.DescribeNetworkInterfacesResult extends Object implements Serializable

Serialized Fields

networkInterfaces

List<E> networkInterfaces

Class com.amazonaws.services.ec2.model.DescribePlacementGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupNames

List<E> groupNames

The name of the PlacementGroup.

filters

List<E> filters

A list of filters used to match properties for Placement Groups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Class com.amazonaws.services.ec2.model.DescribePlacementGroupsResult extends Object implements Serializable

Serialized Fields

placementGroups

List<E> placementGroups

Contains information about the specified PlacementGroups.

Class com.amazonaws.services.ec2.model.DescribeRegionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

regionNames

List<E> regionNames

The optional list of regions to describe.

filters

List<E> filters

A list of filters used to match properties for Regions. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Class com.amazonaws.services.ec2.model.DescribeRegionsResult extends Object implements Serializable

Serialized Fields

regions

List<E> regions

The list of described Amazon EC2 regions.

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesListingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

reservedInstancesId

String reservedInstancesId

reservedInstancesListingId

String reservedInstancesListingId

filters

List<E> filters

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesListingsResult extends Object implements Serializable

Serialized Fields

reservedInstancesListings

List<E> reservedInstancesListings

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesOfferingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

reservedInstancesOfferingIds

List<E> reservedInstancesOfferingIds

An optional list of the unique IDs of the Reserved Instance offerings to describe.

instanceType

String instanceType

The instance type on which the Reserved Instance can be used.

Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.xlarge, m3.2xlarge, c1.medium, c1.xlarge, hi1.4xlarge, hs1.8xlarge, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge

availabilityZone

String availabilityZone

The Availability Zone in which the Reserved Instance can be used.

productDescription

String productDescription

The Reserved Instance product description.

filters

List<E> filters

A list of filters used to match properties for ReservedInstancesOfferings. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

instanceTenancy

String instanceTenancy

The tenancy of the Reserved Instance offering. A Reserved Instance with tenancy of dedicated will run on single-tenant hardware and can only be launched within a VPC.

offeringType

String offeringType

The Reserved Instance offering type.

nextToken

String nextToken

maxResults

Integer maxResults

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesOfferingsResult extends Object implements Serializable

Serialized Fields

reservedInstancesOfferings

List<E> reservedInstancesOfferings

The list of described Reserved Instance offerings.

nextToken

String nextToken

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

reservedInstancesIds

List<E> reservedInstancesIds

The optional list of Reserved Instance IDs to describe.

filters

List<E> filters

A list of filters used to match properties for ReservedInstances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

offeringType

String offeringType

The Reserved Instance offering type.

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesResult extends Object implements Serializable

Serialized Fields

reservedInstances

List<E> reservedInstances

The list of described Reserved Instances.

Class com.amazonaws.services.ec2.model.DescribeRouteTablesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

routeTableIds

List<E> routeTableIds

One or more route table IDs.

filters

List<E> filters

A list of filters used to match properties for Route Tables. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Class com.amazonaws.services.ec2.model.DescribeRouteTablesResult extends Object implements Serializable

Serialized Fields

routeTables

List<E> routeTables

Class com.amazonaws.services.ec2.model.DescribeSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupNames

List<E> groupNames

The optional list of Amazon EC2 security groups to describe.

groupIds

List<E> groupIds

filters

List<E> filters

A list of filters used to match properties for SecurityGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Class com.amazonaws.services.ec2.model.DescribeSecurityGroupsResult extends Object implements Serializable

Serialized Fields

securityGroups

List<E> securityGroups

The list of described Amazon EC2 security groups.

Class com.amazonaws.services.ec2.model.DescribeSnapshotAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

snapshotId

String snapshotId

The ID of the EBS snapshot whose attribute is being described.

attribute

String attribute

The name of the EBS attribute to describe.

Available attribute names: createVolumePermission

Constraints:
Allowed Values: productCodes, createVolumePermission

Class com.amazonaws.services.ec2.model.DescribeSnapshotAttributeResult extends Object implements Serializable

Serialized Fields

snapshotId

String snapshotId

The ID of the snapshot whose attribute is being described.

createVolumePermissions

List<E> createVolumePermissions

The list of permissions describing who can create a volume from the associated EBS snapshot.

Only available if the createVolumePermission attribute is requested.

productCodes

List<E> productCodes

Class com.amazonaws.services.ec2.model.DescribeSnapshotsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

snapshotIds

List<E> snapshotIds

The optional list of EBS snapshot IDs to describe.

ownerIds

List<E> ownerIds

The optional list of EBS snapshot owners.

restorableByUserIds

List<E> restorableByUserIds

The optional list of users who have permission to create volumes from the described EBS snapshots.

filters

List<E> filters

A list of filters used to match properties for Snapshots. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Class com.amazonaws.services.ec2.model.DescribeSnapshotsResult extends Object implements Serializable

Serialized Fields

snapshots

List<E> snapshots

The list of described EBS snapshots.

Class com.amazonaws.services.ec2.model.DescribeSpotDatafeedSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.ec2.model.DescribeSpotDatafeedSubscriptionResult extends Object implements Serializable

Serialized Fields

spotDatafeedSubscription

SpotDatafeedSubscription spotDatafeedSubscription

The Spot Instance datafeed subscription.

Class com.amazonaws.services.ec2.model.DescribeSpotInstanceRequestsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

spotInstanceRequestIds

List<E> spotInstanceRequestIds

The ID of the request.

filters

List<E> filters

A list of filters used to match properties for SpotInstances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Class com.amazonaws.services.ec2.model.DescribeSpotInstanceRequestsResult extends Object implements Serializable

Serialized Fields

spotInstanceRequests

List<E> spotInstanceRequests

Class com.amazonaws.services.ec2.model.DescribeSpotPriceHistoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

startTime

Date startTime

The start date and time of the Spot Instance price history data.

endTime

Date endTime

The end date and time of the Spot Instance price history data.

instanceTypes

List<E> instanceTypes

Specifies the instance type to return.

productDescriptions

List<E> productDescriptions

The description of the AMI.

filters

List<E> filters

A list of filters used to match properties for SpotPriceHistory. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

availabilityZone

String availabilityZone

Filters the results by availability zone (ex: 'us-east-1a').

maxResults

Integer maxResults

Specifies the number of rows to return.

nextToken

String nextToken

Specifies the next set of rows to return.

Class com.amazonaws.services.ec2.model.DescribeSpotPriceHistoryResult extends Object implements Serializable

Serialized Fields

spotPriceHistory

List<E> spotPriceHistory

nextToken

String nextToken

The string marking the next set of results returned. Displays empty if there are no more results to be returned.

Class com.amazonaws.services.ec2.model.DescribeSubnetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

subnetIds

List<E> subnetIds

A set of one or more subnet IDs.

filters

List<E> filters

A list of filters used to match properties for Subnets. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Class com.amazonaws.services.ec2.model.DescribeSubnetsResult extends Object implements Serializable

Serialized Fields

subnets

List<E> subnets

Contains a set of one or more Subnet instances.

Class com.amazonaws.services.ec2.model.DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

List<E> filters

A list of filters used to match properties for tags.

Class com.amazonaws.services.ec2.model.DescribeTagsResult extends Object implements Serializable

Serialized Fields

tags

List<E> tags

A list of the tags for the specified resources.

Class com.amazonaws.services.ec2.model.DescribeVolumeAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeId

String volumeId

attribute

String attribute

Class com.amazonaws.services.ec2.model.DescribeVolumeAttributeResult extends Object implements Serializable

Serialized Fields

volumeId

String volumeId

autoEnableIO

Boolean autoEnableIO

Boolean value

productCodes

List<E> productCodes

Class com.amazonaws.services.ec2.model.DescribeVolumesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeIds

List<E> volumeIds

The optional list of EBS volumes to describe.

filters

List<E> filters

A list of filters used to match properties for Volumes. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Class com.amazonaws.services.ec2.model.DescribeVolumesResult extends Object implements Serializable

Serialized Fields

volumes

List<E> volumes

The list of described EBS volumes.

Class com.amazonaws.services.ec2.model.DescribeVolumeStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeIds

List<E> volumeIds

filters

List<E> filters

nextToken

String nextToken

maxResults

Integer maxResults

Class com.amazonaws.services.ec2.model.DescribeVolumeStatusResult extends Object implements Serializable

Serialized Fields

volumeStatuses

List<E> volumeStatuses

nextToken

String nextToken

Class com.amazonaws.services.ec2.model.DescribeVpcAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

String vpcId

attribute

String attribute

Class com.amazonaws.services.ec2.model.DescribeVpcAttributeResult extends Object implements Serializable

Serialized Fields

vpcId

String vpcId

enableDnsSupport

Boolean enableDnsSupport

Boolean value

enableDnsHostnames

Boolean enableDnsHostnames

Boolean value

Class com.amazonaws.services.ec2.model.DescribeVpcsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcIds

List<E> vpcIds

The ID of a VPC you want information about.

filters

List<E> filters

A list of filters used to match properties for VPCs. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Class com.amazonaws.services.ec2.model.DescribeVpcsResult extends Object implements Serializable

Serialized Fields

vpcs

List<E> vpcs

Class com.amazonaws.services.ec2.model.DescribeVpnConnectionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpnConnectionIds

List<E> vpnConnectionIds

A VPN connection ID. More than one may be specified per request.

filters

List<E> filters

A list of filters used to match properties for VPN Connections. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Class com.amazonaws.services.ec2.model.DescribeVpnConnectionsResult extends Object implements Serializable

Serialized Fields

vpnConnections

List<E> vpnConnections

Class com.amazonaws.services.ec2.model.DescribeVpnGatewaysRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpnGatewayIds

List<E> vpnGatewayIds

A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

filters

List<E> filters

A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Class com.amazonaws.services.ec2.model.DescribeVpnGatewaysResult extends Object implements Serializable

Serialized Fields

vpnGateways

List<E> vpnGateways

Class com.amazonaws.services.ec2.model.DetachInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

internetGatewayId

String internetGatewayId

The ID of the Internet gateway to detach.

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.DetachNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attachmentId

String attachmentId

force

Boolean force

Class com.amazonaws.services.ec2.model.DetachVolumeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeId

String volumeId

The ID of the volume to detach.

instanceId

String instanceId

The ID of the instance from which to detach the the specified volume.

device

String device

The device name to which the volume is attached on the specified instance.

force

Boolean force

Forces detachment if the previous detachment attempt did not occur cleanly (logging into an instance, unmounting the volume, and detaching normally).

This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance will not have an opportunity to flush file system caches nor file system meta data. If you use this option, you must perform file system check and repair procedures.

Class com.amazonaws.services.ec2.model.DetachVolumeResult extends Object implements Serializable

Serialized Fields

attachment

VolumeAttachment attachment

The updated EBS volume attachment information after trying to detach the volume from the specified instance.

Class com.amazonaws.services.ec2.model.DetachVpnGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpnGatewayId

String vpnGatewayId

The ID of the VPN gateway to detach from the VPC.

vpcId

String vpcId

The ID of the VPC to detach the VPN gateway from.

Class com.amazonaws.services.ec2.model.DhcpConfiguration extends Object implements Serializable

Serialized Fields

key

String key

Contains the name of a DHCP option.

values

List<E> values

Contains a set of values for a DHCP option.

Class com.amazonaws.services.ec2.model.DhcpOptions extends Object implements Serializable

Serialized Fields

dhcpOptionsId

String dhcpOptionsId

Specifies the ID of the set of DHCP options.

dhcpConfigurations

List<E> dhcpConfigurations

Contains information about the set of DHCP options.

tags

List<E> tags

A list of tags for the DhcpOptions.

Class com.amazonaws.services.ec2.model.DisableVgwRoutePropagationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

routeTableId

String routeTableId

gatewayId

String gatewayId

Class com.amazonaws.services.ec2.model.DisassociateAddressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

publicIp

String publicIp

The elastic IP address that you are disassociating from the instance.

associationId

String associationId

Association ID corresponding to the VPC elastic IP address you want to disassociate.

Class com.amazonaws.services.ec2.model.DisassociateRouteTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

associationId

String associationId

The association ID representing the current association between the route table and subnet.

Class com.amazonaws.services.ec2.model.DiskImage extends Object implements Serializable

Serialized Fields

image

DiskImageDetail image

description

String description

volume

VolumeDetail volume

Class com.amazonaws.services.ec2.model.DiskImageDescription extends Object implements Serializable

Serialized Fields

format

String format

size

Long size

importManifestUrl

String importManifestUrl

checksum

String checksum

Class com.amazonaws.services.ec2.model.DiskImageDetail extends Object implements Serializable

Serialized Fields

format

String format

bytes

Long bytes

importManifestUrl

String importManifestUrl

Class com.amazonaws.services.ec2.model.DiskImageVolumeDescription extends Object implements Serializable

Serialized Fields

size

Long size

id

String id

Class com.amazonaws.services.ec2.model.EbsBlockDevice extends Object implements Serializable

Serialized Fields

snapshotId

String snapshotId

The ID of the snapshot from which the volume will be created.

volumeSize

Integer volumeSize

The size of the volume, in gigabytes.

deleteOnTermination

Boolean deleteOnTermination

Specifies whether the Amazon EBS volume is deleted on instance termination.

volumeType

String volumeType

iops

Integer iops

Class com.amazonaws.services.ec2.model.EbsInstanceBlockDevice extends Object implements Serializable

Serialized Fields

volumeId

String volumeId

The ID of the EBS volume.

status

String status

The status of the EBS volume.

attachTime

Date attachTime

The time at which the EBS volume was attached to the associated instance.

deleteOnTermination

Boolean deleteOnTermination

Specifies whether the Amazon EBS volume is deleted on instance termination.

Class com.amazonaws.services.ec2.model.EbsInstanceBlockDeviceSpecification extends Object implements Serializable

Serialized Fields

volumeId

String volumeId

The ID of the EBS volume that should be mounted as a block device on an Amazon EC2 instance.

deleteOnTermination

Boolean deleteOnTermination

Specifies whether the Amazon EBS volume is deleted on instance termination.

Class com.amazonaws.services.ec2.model.EnableVgwRoutePropagationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

routeTableId

String routeTableId

gatewayId

String gatewayId

Class com.amazonaws.services.ec2.model.EnableVolumeIORequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeId

String volumeId

Class com.amazonaws.services.ec2.model.ExportTask extends Object implements Serializable

Serialized Fields

exportTaskId

String exportTaskId

description

String description

state

String state

statusMessage

String statusMessage

instanceExportDetails

InstanceExportDetails instanceExportDetails

exportToS3Task

ExportToS3Task exportToS3Task

Class com.amazonaws.services.ec2.model.ExportToS3Task extends Object implements Serializable

Serialized Fields

diskImageFormat

String diskImageFormat

containerFormat

String containerFormat

s3Bucket

String s3Bucket

s3Key

String s3Key

Class com.amazonaws.services.ec2.model.ExportToS3TaskSpecification extends Object implements Serializable

Serialized Fields

diskImageFormat

String diskImageFormat

containerFormat

String containerFormat

s3Bucket

String s3Bucket

s3Prefix

String s3Prefix

Class com.amazonaws.services.ec2.model.Filter extends Object implements Serializable

Serialized Fields

name

String name

Specifies the name of the filter.

values

List<E> values

Contains one or more values for the filter.

Class com.amazonaws.services.ec2.model.GetConsoleOutputRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The ID of the instance for which you want console output.

Class com.amazonaws.services.ec2.model.GetConsoleOutputResult extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

The ID of the instance whose console output was requested.

timestamp

Date timestamp

The time the output was last updated.

output

String output

The console output, Base64 encoded.

Class com.amazonaws.services.ec2.model.GetPasswordDataRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The ID of the instance for which you want the Windows administrator password.

Class com.amazonaws.services.ec2.model.GetPasswordDataResult extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

The ID of the instance whose Windows administrator password was requested.

timestamp

Date timestamp

The time the data was last updated.

passwordData

String passwordData

The Windows administrator password of the specified instance.

Class com.amazonaws.services.ec2.model.GroupIdentifier extends Object implements Serializable

Serialized Fields

groupName

String groupName

groupId

String groupId

Class com.amazonaws.services.ec2.model.IamInstanceProfile extends Object implements Serializable

Serialized Fields

arn

String arn

id

String id

Class com.amazonaws.services.ec2.model.IamInstanceProfileSpecification extends Object implements Serializable

Serialized Fields

arn

String arn

name

String name

Class com.amazonaws.services.ec2.model.IcmpTypeCode extends Object implements Serializable

Serialized Fields

type

Integer type

For the ICMP protocol, the ICMP type. A value of -1 is a wildcard meaning all types. Required if specifying icmp for the protocol.

code

Integer code

For the ICMP protocol, the ICMP code. A value of -1 is a wildcard meaning all codes. Required if specifying icmp for the protocol.

Class com.amazonaws.services.ec2.model.Image extends Object implements Serializable

Serialized Fields

imageId

String imageId

The unique ID of the AMI.

imageLocation

String imageLocation

The location of the AMI.

state

String state

Current state of the AMI. If the operation returns available, the image is successfully registered and available for launching. If the operation returns deregistered, the image is deregistered and no longer available for launching.

Constraints:
Allowed Values: available, deregistered

ownerId

String ownerId

AWS Access Key ID of the image owner.

publicValue

Boolean publicValue

True if this image has public launch permissions. False if it only has implicit and explicit launch permissions.

productCodes

List<E> productCodes

Product codes of the AMI.

architecture

String architecture

The architecture of the image.

imageType

String imageType

The type of image (machine, kernel, or ramdisk).

kernelId

String kernelId

The kernel associated with the image, if any. Only applicable for machine images.

ramdiskId

String ramdiskId

The RAM disk associated with the image, if any. Only applicable for machine images.

platform

String platform

The operating platform of the AMI.

stateReason

StateReason stateReason

The reason for the state change.

imageOwnerAlias

String imageOwnerAlias

The AWS account alias (e.g., "amazon", "redhat", "self", etc.) or AWS account ID that owns the AMI.

name

String name

The name of the AMI that was provided during image creation.

description

String description

The description of the AMI that was provided during image creation.

rootDeviceType

String rootDeviceType

The root device type used by the AMI. The AMI can use an Amazon EBS or instance store root device.

rootDeviceName

String rootDeviceName

The root device name (e.g., /dev/sda1).

blockDeviceMappings

List<E> blockDeviceMappings

Specifies how block devices are exposed to the instance.

virtualizationType

String virtualizationType

tags

List<E> tags

A list of tags for the Image.

hypervisor

String hypervisor

Class com.amazonaws.services.ec2.model.ImageAttribute extends Object implements Serializable

Serialized Fields

imageId

String imageId

The ID of the associated AMI.

launchPermissions

List<E> launchPermissions

Launch permissions for the associated AMI.

productCodes

List<E> productCodes

Product codes for the associated AMI.

kernelId

String kernelId

Kernel ID of the associated AMI.

ramdiskId

String ramdiskId

Ramdisk ID of the associated AMI.

description

String description

User-created description of the associated AMI.

blockDeviceMappings

List<E> blockDeviceMappings

Block device mappings for the associated AMI.

Class com.amazonaws.services.ec2.model.ImportInstanceLaunchSpecification extends Object implements Serializable

Serialized Fields

architecture

String architecture

securityGroups

List<E> securityGroups

additionalInfo

String additionalInfo

userData

String userData

instanceType

String instanceType

placement

Placement placement

Describes where an Amazon EC2 instance is running within an Amazon EC2 region.

blockDeviceMappings

List<E> blockDeviceMappings

monitoring

Boolean monitoring

subnetId

String subnetId

disableApiTermination

Boolean disableApiTermination

instanceInitiatedShutdownBehavior

String instanceInitiatedShutdownBehavior

privateIpAddress

String privateIpAddress

Class com.amazonaws.services.ec2.model.ImportInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

String description

launchSpecification

ImportInstanceLaunchSpecification launchSpecification

diskImages

List<E> diskImages

platform

String platform

Class com.amazonaws.services.ec2.model.ImportInstanceResult extends Object implements Serializable

Serialized Fields

conversionTask

ConversionTask conversionTask

Class com.amazonaws.services.ec2.model.ImportInstanceTaskDetails extends Object implements Serializable

Serialized Fields

volumes

List<E> volumes

instanceId

String instanceId

platform

String platform

description

String description

Class com.amazonaws.services.ec2.model.ImportInstanceVolumeDetailItem extends Object implements Serializable

Serialized Fields

bytesConverted

Long bytesConverted

availabilityZone

String availabilityZone

image

DiskImageDescription image

volume

DiskImageVolumeDescription volume

status

String status

statusMessage

String statusMessage

description

String description

Class com.amazonaws.services.ec2.model.ImportKeyPairRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyName

String keyName

The unique name for the key pair.

publicKeyMaterial

String publicKeyMaterial

The public key portion of the key pair being imported.

Class com.amazonaws.services.ec2.model.ImportKeyPairResult extends Object implements Serializable

Serialized Fields

keyName

String keyName

The specified unique key pair name.

keyFingerprint

String keyFingerprint

The MD5 public key fingerprint as specified in section 4 of RFC4716 .

Class com.amazonaws.services.ec2.model.ImportVolumeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

image

DiskImageDetail image

description

String description

volume

VolumeDetail volume

Class com.amazonaws.services.ec2.model.ImportVolumeResult extends Object implements Serializable

Serialized Fields

conversionTask

ConversionTask conversionTask

Class com.amazonaws.services.ec2.model.ImportVolumeTaskDetails extends Object implements Serializable

Serialized Fields

bytesConverted

Long bytesConverted

availabilityZone

String availabilityZone

description

String description

image

DiskImageDescription image

volume

DiskImageVolumeDescription volume

Class com.amazonaws.services.ec2.model.Instance extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

Unique ID of the instance launched.

imageId

String imageId

Image ID of the AMI used to launch the instance.

state

InstanceState state

The current state of the instance.

privateDnsName

String privateDnsName

The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This element remains empty until the instance enters a running state.

publicDnsName

String publicDnsName

The public DNS name assigned to the instance. This DNS name is contactable from outside the Amazon EC2 network. This element remains empty until the instance enters a running state.

stateTransitionReason

String stateTransitionReason

Reason for the most recent state transition. This might be an empty string.

keyName

String keyName

If this instance was launched with an associated key pair, this displays the key pair name.

amiLaunchIndex

Integer amiLaunchIndex

The AMI launch index, which can be used to find this instance within the launch group.

productCodes

List<E> productCodes

Product codes attached to this instance.

instanceType

String instanceType

The instance type. For more information on instance types, please see the Amazon Elastic Compute Cloud Developer Guide.

Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.xlarge, m3.2xlarge, c1.medium, c1.xlarge, hi1.4xlarge, hs1.8xlarge, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge

launchTime

Date launchTime

The time this instance launched.

placement

Placement placement

The location where this instance launched.

kernelId

String kernelId

Kernel associated with this instance.

ramdiskId

String ramdiskId

RAM disk associated with this instance.

platform

String platform

Platform of the instance (e.g., Windows).

monitoring

Monitoring monitoring

Monitoring status for this instance.

subnetId

String subnetId

Specifies the Amazon VPC subnet ID in which the instance is running.

vpcId

String vpcId

Specifies the Amazon VPC in which the instance is running.

privateIpAddress

String privateIpAddress

Specifies the private IP address that is assigned to the instance (Amazon VPC).

publicIpAddress

String publicIpAddress

Specifies the IP address of the instance.

stateReason

StateReason stateReason

The reason for the state change.

architecture

String architecture

The architecture of this instance.

rootDeviceType

String rootDeviceType

The root device type used by the AMI. The AMI can use an Amazon EBS or instance store root device.

rootDeviceName

String rootDeviceName

The root device name (e.g., /dev/sda1).

blockDeviceMappings

List<E> blockDeviceMappings

Block device mapping set.

virtualizationType

String virtualizationType

instanceLifecycle

String instanceLifecycle

spotInstanceRequestId

String spotInstanceRequestId

license

InstanceLicense license

Represents an active license in use and attached to an Amazon EC2 instance.

clientToken

String clientToken

tags

List<E> tags

A list of tags for the Instance.

securityGroups

List<E> securityGroups

sourceDestCheck

Boolean sourceDestCheck

hypervisor

String hypervisor

networkInterfaces

List<E> networkInterfaces

iamInstanceProfile

IamInstanceProfile iamInstanceProfile

ebsOptimized

Boolean ebsOptimized

Class com.amazonaws.services.ec2.model.InstanceAttribute extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

The ID of the associated instance.

instanceType

String instanceType

The instance type (e.g., m1.small, c1.medium, m2.2xlarge, and so on).

kernelId

String kernelId

The kernel ID of the associated instance.

ramdiskId

String ramdiskId

The ramdisk ID of the associated instance.

userData

String userData

MIME, Base64-encoded user data.

disableApiTermination

Boolean disableApiTermination

Whether this instance can be terminated. You must modify this attribute before you can terminate any "locked" instances.

instanceInitiatedShutdownBehavior

String instanceInitiatedShutdownBehavior

Whether this instance's Amazon EBS volumes are deleted when the instance is shut down.

rootDeviceName

String rootDeviceName

The root device name (e.g., /dev/sda1).

blockDeviceMappings

List<E> blockDeviceMappings

How block devices are exposed to this instance. Each mapping is made up of a virtualName and a deviceName.

productCodes

List<E> productCodes

ebsOptimized

Boolean ebsOptimized

Boolean value

Class com.amazonaws.services.ec2.model.InstanceBlockDeviceMapping extends Object implements Serializable

Serialized Fields

deviceName

String deviceName

The device name (e.g., /dev/sdh) at which the block device is exposed on the instance.

ebs

EbsInstanceBlockDevice ebs

The optional EBS device mapped to the specified device name.

Class com.amazonaws.services.ec2.model.InstanceBlockDeviceMappingSpecification extends Object implements Serializable

Serialized Fields

deviceName

String deviceName

The device name (e.g., /dev/sdh) at which the block device is exposed on the instance.

ebs

EbsInstanceBlockDeviceSpecification ebs

The EBS instance block device specification describing the EBS block device to map to the specified device name on a running instance.

virtualName

String virtualName

The virtual device name.

noDevice

String noDevice

When set to the empty string, specifies that the device name in this object should not be mapped to any real device.

Class com.amazonaws.services.ec2.model.InstanceCount extends Object implements Serializable

Serialized Fields

state

String state

instanceCount

Integer instanceCount

Class com.amazonaws.services.ec2.model.InstanceExportDetails extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

targetEnvironment

String targetEnvironment

Class com.amazonaws.services.ec2.model.InstanceLicense extends Object implements Serializable

Serialized Fields

pool

String pool

The license pool from which this license was used (ex: 'windows').

Class com.amazonaws.services.ec2.model.InstanceLicenseSpecification extends Object implements Serializable

Serialized Fields

pool

String pool

The license pool from which to take a license when starting Amazon EC2 instances in the associated RunInstances request.

Class com.amazonaws.services.ec2.model.InstanceMonitoring extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

Instance ID.

monitoring

Monitoring monitoring

Monitoring state for the associated instance.

Class com.amazonaws.services.ec2.model.InstanceNetworkInterface extends Object implements Serializable

Serialized Fields

networkInterfaceId

String networkInterfaceId

subnetId

String subnetId

vpcId

String vpcId

description

String description

ownerId

String ownerId

status

String status

privateIpAddress

String privateIpAddress

privateDnsName

String privateDnsName

sourceDestCheck

Boolean sourceDestCheck

groups

List<E> groups

attachment

InstanceNetworkInterfaceAttachment attachment

association

InstanceNetworkInterfaceAssociation association

privateIpAddresses

List<E> privateIpAddresses

Class com.amazonaws.services.ec2.model.InstanceNetworkInterfaceAssociation extends Object implements Serializable

Serialized Fields

publicIp

String publicIp

publicDnsName

String publicDnsName

ipOwnerId

String ipOwnerId

Class com.amazonaws.services.ec2.model.InstanceNetworkInterfaceAttachment extends Object implements Serializable

Serialized Fields

attachmentId

String attachmentId

deviceIndex

Integer deviceIndex

status

String status

attachTime

Date attachTime

deleteOnTermination

Boolean deleteOnTermination

Class com.amazonaws.services.ec2.model.InstanceNetworkInterfaceSpecification extends Object implements Serializable

Serialized Fields

networkInterfaceId

String networkInterfaceId

deviceIndex

Integer deviceIndex

subnetId

String subnetId

description

String description

privateIpAddress

String privateIpAddress

groups

List<E> groups

deleteOnTermination

Boolean deleteOnTermination

privateIpAddresses

List<E> privateIpAddresses

secondaryPrivateIpAddressCount

Integer secondaryPrivateIpAddressCount

Class com.amazonaws.services.ec2.model.InstancePrivateIpAddress extends Object implements Serializable

Serialized Fields

privateIpAddress

String privateIpAddress

privateDnsName

String privateDnsName

primary

Boolean primary

association

InstanceNetworkInterfaceAssociation association

Class com.amazonaws.services.ec2.model.InstanceState extends Object implements Serializable

Serialized Fields

code

Integer code

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.

name

String name

The current state of the instance.

Constraints:
Allowed Values: pending, running, shutting-down, terminated, stopping, stopped

Class com.amazonaws.services.ec2.model.InstanceStateChange extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

The ID of the instance whose state changed.

currentState

InstanceState currentState

The current state of the specified instance.

previousState

InstanceState previousState

The previous state of the specified instance.

Class com.amazonaws.services.ec2.model.InstanceStatus extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

The ID of the Amazon EC2 instance.

availabilityZone

String availabilityZone

The Amazon EC2 instance's availability zone.

events

List<E> events

Events that affect the status of the associated Amazon EC2 instance.

instanceState

InstanceState instanceState

Represents the state of an Amazon EC2 instance.

systemStatus

InstanceStatusSummary systemStatus

instanceStatus

InstanceStatusSummary instanceStatus

Class com.amazonaws.services.ec2.model.InstanceStatusDetails extends Object implements Serializable

Serialized Fields

name

String name

status

String status

impairedSince

Date impairedSince

Class com.amazonaws.services.ec2.model.InstanceStatusEvent extends Object implements Serializable

Serialized Fields

code

String code

The associated code of the event. Valid values: instance-reboot, system-reboot, instance-retirement

description

String description

A description of the event.

notBefore

Date notBefore

The earliest scheduled start time for the event.

notAfter

Date notAfter

The latest scheduled end time for the event.

Class com.amazonaws.services.ec2.model.InstanceStatusSummary extends Object implements Serializable

Serialized Fields

status

String status

details

List<E> details

Class com.amazonaws.services.ec2.model.InternetGateway extends Object implements Serializable

Serialized Fields

internetGatewayId

String internetGatewayId

attachments

List<E> attachments

tags

List<E> tags

Class com.amazonaws.services.ec2.model.InternetGatewayAttachment extends Object implements Serializable

Serialized Fields

vpcId

String vpcId

state

String state

Class com.amazonaws.services.ec2.model.IpPermission extends Object implements Serializable

Serialized Fields

ipProtocol

String ipProtocol

The IP protocol of this permission.

Valid protocol values: tcp, udp, icmp

fromPort

Integer fromPort

Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP type number of -1 indicates a wildcard (i.e., any ICMP type number).

toPort

Integer toPort

End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1 indicates a wildcard (i.e., any ICMP code).

userIdGroupPairs

List<E> userIdGroupPairs

The list of AWS user IDs and groups included in this permission.

ipRanges

List<E> ipRanges

The list of CIDR IP ranges included in this permission.

Class com.amazonaws.services.ec2.model.KeyPair extends Object implements Serializable

Serialized Fields

keyName

String keyName

The name of the key pair.

keyFingerprint

String keyFingerprint

The SHA-1 digest of the DER encoded private key.

keyMaterial

String keyMaterial

The unencrypted PEM encoded RSA private key.

Class com.amazonaws.services.ec2.model.KeyPairInfo extends Object implements Serializable

Serialized Fields

keyName

String keyName

The name of the key pair.

keyFingerprint

String keyFingerprint

The SHA-1 digest of the DER encoded private key.

Class com.amazonaws.services.ec2.model.LaunchPermission extends Object implements Serializable

Serialized Fields

userId

String userId

The AWS user ID of the user involved in this launch permission.

group

String group

The AWS group of the user involved in this launch permission.

Available groups: all

Class com.amazonaws.services.ec2.model.LaunchPermissionModifications extends Object implements Serializable

Serialized Fields

add

List<E> add

remove

List<E> remove

Class com.amazonaws.services.ec2.model.LaunchSpecification extends Object implements Serializable

Serialized Fields

imageId

String imageId

The AMI ID.

keyName

String keyName

The name of the key pair.

allSecurityGroups

List<E> allSecurityGroups

securityGroups

List<E> securityGroups

userData

String userData

Optional data, specific to a user's application, to provide in the launch request. All instances that collectively comprise the launch request have access to this data. User data is never returned through API responses.

addressingType

String addressingType

Deprecated.

instanceType

String instanceType

Specifies the instance type.

Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.xlarge, m3.2xlarge, c1.medium, c1.xlarge, hi1.4xlarge, hs1.8xlarge, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge

placement

SpotPlacement placement

Defines a placement item.

kernelId

String kernelId

Specifies the ID of the kernel to select.

ramdiskId

String ramdiskId

Specifies the ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information on whether or not you need to specify a RAM disk and search for the kernel ID.

blockDeviceMappings

List<E> blockDeviceMappings

Specifies how block devices are exposed to the instance. Each mapping is made up of a virtualName and a deviceName.

monitoringEnabled

Boolean monitoringEnabled

Enables monitoring for the instance.

subnetId

String subnetId

Specifies the Amazon VPC subnet ID within which to launch the instance(s) for Amazon Virtual Private Cloud.

networkInterfaces

List<E> networkInterfaces

iamInstanceProfile

IamInstanceProfileSpecification iamInstanceProfile

ebsOptimized

Boolean ebsOptimized

Class com.amazonaws.services.ec2.model.License extends Object implements Serializable

Serialized Fields

licenseId

String licenseId

The unique ID identifying the license.

type

String type

The license type (ex. "Microsoft/Windows/Standard").

pool

String pool

The name of the pool in which the license is kept.

capacities

List<E> capacities

The capacities available for this license, indicating how many licenses are in use, how many are available, how many Amazon EC2 instances can be supported, etc.

tags

List<E> tags

A list of tags for the License.

Class com.amazonaws.services.ec2.model.LicenseCapacity extends Object implements Serializable

Serialized Fields

capacity

Integer capacity

The number of licenses available.

instanceCapacity

Integer instanceCapacity

The number of Amazon EC2 instances that can be supported with the license's capacity.

state

String state

The state of this license capacity, indicating whether the license is actively being used or not.

earliestAllowedDeactivationTime

Date earliestAllowedDeactivationTime

The earliest allowed time at which a license can be deactivated. Some licenses have time restrictions on when they can be activated and reactivated.

Class com.amazonaws.services.ec2.model.ModifyImageAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

imageId

String imageId

The ID of the AMI whose attribute you want to modify.

attribute

String attribute

The name of the AMI attribute you want to modify.

Available attributes: launchPermission, productCodes

operationType

String operationType

The type of operation being requested.

Available operation types: add, remove

userIds

List<E> userIds

The AWS user ID being added to or removed from the list of users with launch permissions for this AMI. Only valid when the launchPermission attribute is being modified.

userGroups

List<E> userGroups

The user group being added to or removed from the list of user groups with launch permissions for this AMI. Only valid when the launchPermission attribute is being modified.

Available user groups: all

productCodes

List<E> productCodes

The list of product codes being added to or removed from the specified AMI. Only valid when the productCodes attribute is being modified.

value

String value

The value of the attribute being modified. Only valid when the description attribute is being modified.

launchPermission

LaunchPermissionModifications launchPermission

description

String description

String value

Class com.amazonaws.services.ec2.model.ModifyInstanceAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The ID of the instance whose attribute is being modified.

attribute

String attribute

The name of the attribute being modified.

Available attribute names: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDevice, blockDeviceMapping

Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized

value

String value

The new value of the instance attribute being modified.

Only valid when kernel, ramdisk, userData, disableApiTermination or instanceInitiateShutdownBehavior is specified as the attribute being modified.

blockDeviceMappings

List<E> blockDeviceMappings

The new block device mappings for the instance whose attributes are being modified.

Only valid when blockDeviceMapping is specified as the attribute being modified.

sourceDestCheck

Boolean sourceDestCheck

Boolean value

disableApiTermination

Boolean disableApiTermination

Boolean value

instanceType

String instanceType

String value

kernel

String kernel

String value

ramdisk

String ramdisk

String value

userData

String userData

String value

instanceInitiatedShutdownBehavior

String instanceInitiatedShutdownBehavior

String value

groups

List<E> groups

ebsOptimized

Boolean ebsOptimized

Boolean value

Class com.amazonaws.services.ec2.model.ModifyNetworkInterfaceAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

networkInterfaceId

String networkInterfaceId

description

String description

String value

sourceDestCheck

Boolean sourceDestCheck

Boolean value

groups

List<E> groups

attachment

NetworkInterfaceAttachmentChanges attachment

Class com.amazonaws.services.ec2.model.ModifySnapshotAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

snapshotId

String snapshotId

The ID of the EBS snapshot whose attributes are being modified.

attribute

String attribute

The name of the attribute being modified.

Available attribute names: createVolumePermission

Constraints:
Allowed Values: productCodes, createVolumePermission

operationType

String operationType

The operation to perform on the attribute.

Available operation names: add, remove

userIds

List<E> userIds

The AWS user IDs to add to or remove from the list of users that have permission to create EBS volumes from the specified snapshot. Currently supports "all". Only valid when the createVolumePermission attribute is being modified.

groupNames

List<E> groupNames

The AWS group names to add to or remove from the list of groups that have permission to create EBS volumes from the specified snapshot. Currently supports "all". Only valid when the createVolumePermission attribute is being modified.

createVolumePermission

CreateVolumePermissionModifications createVolumePermission

Class com.amazonaws.services.ec2.model.ModifyVolumeAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeId

String volumeId

autoEnableIO

Boolean autoEnableIO

Class com.amazonaws.services.ec2.model.ModifyVpcAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

String vpcId

enableDnsSupport

Boolean enableDnsSupport

Boolean value

enableDnsHostnames

Boolean enableDnsHostnames

Boolean value

Class com.amazonaws.services.ec2.model.Monitoring extends Object implements Serializable

Serialized Fields

state

String state

The state of monitoring on an Amazon EC2 instance (ex: enabled, disabled).

Class com.amazonaws.services.ec2.model.MonitorInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceIds

List<E> instanceIds

The list of Amazon EC2 instances on which to enable monitoring.

Class com.amazonaws.services.ec2.model.MonitorInstancesResult extends Object implements Serializable

Serialized Fields

instanceMonitorings

List<E> instanceMonitorings

A list of updated monitoring information for the instances specified in the request.

Class com.amazonaws.services.ec2.model.NetworkAcl extends Object implements Serializable

Serialized Fields

networkAclId

String networkAclId

vpcId

String vpcId

isDefault

Boolean isDefault

entries

List<E> entries

associations

List<E> associations

tags

List<E> tags

Class com.amazonaws.services.ec2.model.NetworkAclAssociation extends Object implements Serializable

Serialized Fields

networkAclAssociationId

String networkAclAssociationId

networkAclId

String networkAclId

subnetId

String subnetId

Class com.amazonaws.services.ec2.model.NetworkAclEntry extends Object implements Serializable

Serialized Fields

ruleNumber

Integer ruleNumber

protocol

String protocol

ruleAction

String ruleAction

egress

Boolean egress

cidrBlock

String cidrBlock

icmpTypeCode

IcmpTypeCode icmpTypeCode

portRange

PortRange portRange

Class com.amazonaws.services.ec2.model.NetworkInterface extends Object implements Serializable

Serialized Fields

networkInterfaceId

String networkInterfaceId

subnetId

String subnetId

vpcId

String vpcId

availabilityZone

String availabilityZone

description

String description

ownerId

String ownerId

requesterId

String requesterId

requesterManaged

Boolean requesterManaged

status

String status

macAddress

String macAddress

privateIpAddress

String privateIpAddress

privateDnsName

String privateDnsName

sourceDestCheck

Boolean sourceDestCheck

groups

List<E> groups

attachment

NetworkInterfaceAttachment attachment

association

NetworkInterfaceAssociation association

tagSet

List<E> tagSet

privateIpAddresses

List<E> privateIpAddresses

Class com.amazonaws.services.ec2.model.NetworkInterfaceAssociation extends Object implements Serializable

Serialized Fields

publicIp

String publicIp

ipOwnerId

String ipOwnerId

allocationId

String allocationId

associationId

String associationId

Class com.amazonaws.services.ec2.model.NetworkInterfaceAttachment extends Object implements Serializable

Serialized Fields

attachmentId

String attachmentId

instanceId

String instanceId

instanceOwnerId

String instanceOwnerId

deviceIndex

Integer deviceIndex

status

String status

attachTime

Date attachTime

deleteOnTermination

Boolean deleteOnTermination

Class com.amazonaws.services.ec2.model.NetworkInterfaceAttachmentChanges extends Object implements Serializable

Serialized Fields

attachmentId

String attachmentId

deleteOnTermination

Boolean deleteOnTermination

Class com.amazonaws.services.ec2.model.NetworkInterfacePrivateIpAddress extends Object implements Serializable

Serialized Fields

privateIpAddress

String privateIpAddress

privateDnsName

String privateDnsName

primary

Boolean primary

association

NetworkInterfaceAssociation association

Class com.amazonaws.services.ec2.model.Placement extends Object implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The availability zone in which an Amazon EC2 instance runs.

groupName

String groupName

The name of the PlacementGroup in which an Amazon EC2 instance runs. Placement groups are primarily used for launching High Performance Computing instances in the same group to ensure fast connection speeds.

tenancy

String tenancy

The allowed tenancy of instances launched into the VPC. A value of default means instances can be launched with any tenancy; a value of dedicated means all instances launched into the VPC will be launched as dedicated tenancy regardless of the tenancy assigned to the instance at launch.

Class com.amazonaws.services.ec2.model.PlacementGroup extends Object implements Serializable

Serialized Fields

groupName

String groupName

The name of this PlacementGroup.

strategy

String strategy

The strategy to use when allocating Amazon EC2 instances for the PlacementGroup.

Constraints:
Allowed Values: cluster

state

String state

The state of this PlacementGroup.

Constraints:
Allowed Values: pending, available, deleting, deleted

Class com.amazonaws.services.ec2.model.PortRange extends Object implements Serializable

Serialized Fields

from

Integer from

The first port in the range. Required if specifying tcp or udp for the protocol.

to

Integer to

The last port in the range. Required if specifying tcp or udp for the protocol.

Class com.amazonaws.services.ec2.model.PriceSchedule extends Object implements Serializable

Serialized Fields

term

Long term

price

Double price

currencyCode

String currencyCode

active

Boolean active

Class com.amazonaws.services.ec2.model.PriceScheduleSpecification extends Object implements Serializable

Serialized Fields

term

Long term

price

Double price

currencyCode

String currencyCode

Class com.amazonaws.services.ec2.model.PricingDetail extends Object implements Serializable

Serialized Fields

price

Double price

count

Integer count

Class com.amazonaws.services.ec2.model.PrivateIpAddressSpecification extends Object implements Serializable

Serialized Fields

privateIpAddress

String privateIpAddress

primary

Boolean primary

Class com.amazonaws.services.ec2.model.ProductCode extends Object implements Serializable

Serialized Fields

productCodeId

String productCodeId

The unique ID of an AWS DevPay product code.

productCodeType

String productCodeType

Class com.amazonaws.services.ec2.model.PropagatingVgw extends Object implements Serializable

Serialized Fields

gatewayId

String gatewayId

Class com.amazonaws.services.ec2.model.PurchaseReservedInstancesOfferingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

reservedInstancesOfferingId

String reservedInstancesOfferingId

The unique ID of the Reserved Instances offering being purchased.

instanceCount

Integer instanceCount

The number of Reserved Instances to purchase.

limitPrice

ReservedInstanceLimitPrice limitPrice

Class com.amazonaws.services.ec2.model.PurchaseReservedInstancesOfferingResult extends Object implements Serializable

Serialized Fields

reservedInstancesId

String reservedInstancesId

The unique ID of the Reserved Instances purchased for your account.

Class com.amazonaws.services.ec2.model.RebootInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceIds

List<E> instanceIds

The list of instances to terminate.

Class com.amazonaws.services.ec2.model.RecurringCharge extends Object implements Serializable

Serialized Fields

frequency

String frequency

The frequency of the recurring charge.

amount

Double amount

The amount of the recurring charge.

Class com.amazonaws.services.ec2.model.Region extends Object implements Serializable

Serialized Fields

regionName

String regionName

Name of the region.

endpoint

String endpoint

Region service endpoint.

Class com.amazonaws.services.ec2.model.RegisterImageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

imageLocation

String imageLocation

The full path to your AMI manifest in Amazon S3 storage.

name

String name

The name to give the new Amazon Machine Image.

Constraints: 3-128 alphanumeric characters, parenthesis (()), commas (,), slashes (/), dashes (-), or underscores(_)

description

String description

The description describing the new AMI.

architecture

String architecture

The architecture of the image.

Valid Values: i386, x86_64

kernelId

String kernelId

The optional ID of a specific kernel to register with the new AMI.

ramdiskId

String ramdiskId

The optional ID of a specific ramdisk to register with the new AMI.

Some kernels require additional drivers at launch. Check the kernel requirements for information on whether you need to specify a RAM disk.

rootDeviceName

String rootDeviceName

The root device name (e.g., /dev/sda1).

blockDeviceMappings

List<E> blockDeviceMappings

The block device mappings for the new AMI, which specify how different block devices (ex: EBS volumes and ephemeral drives) will be exposed on instances launched from the new image.

Class com.amazonaws.services.ec2.model.RegisterImageResult extends Object implements Serializable

Serialized Fields

imageId

String imageId

The ID of the new Amazon Machine Image (AMI).

Class com.amazonaws.services.ec2.model.ReleaseAddressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

publicIp

String publicIp

The elastic IP address that you are releasing from your account.

allocationId

String allocationId

The allocation ID that AWS provided when you allocated the address for use with Amazon VPC.

Class com.amazonaws.services.ec2.model.ReplaceNetworkAclAssociationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

associationId

String associationId

The ID representing the current association between the original network ACL and the subnet.

networkAclId

String networkAclId

The ID of the new ACL to associate with the subnet.

Class com.amazonaws.services.ec2.model.ReplaceNetworkAclAssociationResult extends Object implements Serializable

Serialized Fields

newAssociationId

String newAssociationId

Class com.amazonaws.services.ec2.model.ReplaceNetworkAclEntryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

networkAclId

String networkAclId

ID of the ACL where the entry will be replaced.

ruleNumber

Integer ruleNumber

Rule number of the entry to replace.

protocol

String protocol

IP protocol the rule applies to. Valid Values: tcp, udp, icmp or an IP protocol number.

ruleAction

String ruleAction

Whether to allow or deny traffic that matches the rule.

Constraints:
Allowed Values: allow, deny

egress

Boolean egress

Whether this rule applies to egress traffic from the subnet (true) or ingress traffic (false).

cidrBlock

String cidrBlock

The CIDR range to allow or deny, in CIDR notation (e.g., 172.16.0.0/24).

icmpTypeCode

IcmpTypeCode icmpTypeCode

ICMP values.

portRange

PortRange portRange

Port ranges.

Class com.amazonaws.services.ec2.model.ReplaceRouteRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

routeTableId

String routeTableId

The ID of the route table where the route will be replaced.

destinationCidrBlock

String destinationCidrBlock

The CIDR address block used for the destination match. For example: 0.0.0.0/0. The value you provide must match the CIDR of an existing route in the table.

gatewayId

String gatewayId

The ID of a VPN or Internet gateway attached to your VPC.

instanceId

String instanceId

The ID of a NAT instance in your VPC.

networkInterfaceId

String networkInterfaceId

Class com.amazonaws.services.ec2.model.ReplaceRouteTableAssociationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

associationId

String associationId

The ID representing the current association between the original route table and the subnet.

routeTableId

String routeTableId

The ID of the new route table to associate with the subnet.

Class com.amazonaws.services.ec2.model.ReplaceRouteTableAssociationResult extends Object implements Serializable

Serialized Fields

newAssociationId

String newAssociationId

Class com.amazonaws.services.ec2.model.ReportInstanceStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instances

List<E> instances

status

String status

startTime

Date startTime

endTime

Date endTime

reasonCodes

List<E> reasonCodes

description

String description

Class com.amazonaws.services.ec2.model.RequestSpotInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

spotPrice

String spotPrice

Specifies the maximum hourly price for any Spot Instance launched to fulfill the request.

instanceCount

Integer instanceCount

Specifies the maximum number of Spot Instances to launch.

type

String type

Specifies the Spot Instance type.

Constraints:
Allowed Values: one-time, persistent

validFrom

Date validFrom

Defines the start date of the request.

If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

validUntil

Date validUntil

End date of the request.

If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

launchGroup

String launchGroup

Specifies the instance launch group. Launch groups are Spot Instances that launch and terminate together.

availabilityZoneGroup

String availabilityZoneGroup

Specifies the Availability Zone group.

When specifying the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.

launchSpecification

LaunchSpecification launchSpecification

Specifies additional launch instance information.

Class com.amazonaws.services.ec2.model.RequestSpotInstancesResult extends Object implements Serializable

Serialized Fields

spotInstanceRequests

List<E> spotInstanceRequests

Contains a list of Spot Instance requests.

Class com.amazonaws.services.ec2.model.Reservation extends Object implements Serializable

Serialized Fields

reservationId

String reservationId

The unique ID of this reservation.

ownerId

String ownerId

The AWS Access Key ID of the user who owns the reservation.

requesterId

String requesterId

The unique ID of the user who requested the instances in this reservation.

groups

List<E> groups

The list of security groups requested for the instances in this reservation.

groupNames

List<E> groupNames

The list of security groups requested for the instances in this reservation.

instances

List<E> instances

The list of Amazon EC2 instances included in this reservation.

Class com.amazonaws.services.ec2.model.ReservedInstanceLimitPrice extends Object implements Serializable

Serialized Fields

amount

Double amount

currencyCode

String currencyCode

Class com.amazonaws.services.ec2.model.ReservedInstances extends Object implements Serializable

Serialized Fields

reservedInstancesId

String reservedInstancesId

The unique ID of the Reserved Instances purchase.

instanceType

String instanceType

The instance type on which the Reserved Instances can be used.

Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.xlarge, m3.2xlarge, c1.medium, c1.xlarge, hi1.4xlarge, hs1.8xlarge, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge

availabilityZone

String availabilityZone

The Availability Zone in which the Reserved Instances can be used.

start

Date start

The date and time the Reserved Instances started.

duration

Long duration

The duration of the Reserved Instances, in seconds.

usagePrice

Float usagePrice

The usage price of the Reserved Instances, per hour.

fixedPrice

Float fixedPrice

The purchase price of the Reserved Instances.

instanceCount

Integer instanceCount

The number of Reserved Instances purchased.

productDescription

String productDescription

The Reserved Instances product description (ex: Windows or Unix/Linux).

state

String state

The state of the Reserved Instances purchase.

tags

List<E> tags

A list of tags for the ReservedInstances.

instanceTenancy

String instanceTenancy

The tenancy of the reserved instance (ex: default or dedicated).

currencyCode

String currencyCode

The currency of the reserved instance. Specified using ISO 4217 standard (e.g., USD, JPY).

offeringType

String offeringType

The Reserved Instance offering type.

recurringCharges

List<E> recurringCharges

The recurring charge tag assigned to the resource.

Class com.amazonaws.services.ec2.model.ReservedInstancesListing extends Object implements Serializable

Serialized Fields

reservedInstancesListingId

String reservedInstancesListingId

reservedInstancesId

String reservedInstancesId

createDate

Date createDate

updateDate

Date updateDate

status

String status

statusMessage

String statusMessage

instanceCounts

List<E> instanceCounts

priceSchedules

List<E> priceSchedules

tags

List<E> tags

clientToken

String clientToken

Class com.amazonaws.services.ec2.model.ReservedInstancesOffering extends Object implements Serializable

Serialized Fields

reservedInstancesOfferingId

String reservedInstancesOfferingId

The unique ID of this Reserved Instances offering.

instanceType

String instanceType

The instance type on which the Reserved Instances can be used.

Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.xlarge, m3.2xlarge, c1.medium, c1.xlarge, hi1.4xlarge, hs1.8xlarge, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge

availabilityZone

String availabilityZone

The Availability Zone in which the Reserved Instances can be used.

duration

Long duration

The duration of the Reserved Instance, in seconds.

usagePrice

Float usagePrice

The usage price of the Reserved Instance, per hour.

fixedPrice

Float fixedPrice

The purchase price of the Reserved Instance.

productDescription

String productDescription

The Reserved Instances description (ex: Windows or Unix/Linux).

instanceTenancy

String instanceTenancy

The tenancy of the reserved instance (ex: default or dedicated).

currencyCode

String currencyCode

The currency of the reserved instance. Specified using ISO 4217 standard (e.g., USD, JPY).

offeringType

String offeringType

The Reserved Instance offering type.

recurringCharges

List<E> recurringCharges

The recurring charge tag assigned to the resource.

marketplace

Boolean marketplace

pricingDetails

List<E> pricingDetails

Class com.amazonaws.services.ec2.model.ResetImageAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

imageId

String imageId

The ID of the AMI whose attribute is being reset.

attribute

String attribute

The name of the attribute being reset.

Available attribute names: launchPermission

Class com.amazonaws.services.ec2.model.ResetInstanceAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The ID of the Amazon EC2 instance whose attribute is being reset.

attribute

String attribute

The name of the attribute being reset.

Available attribute names: kernel, ramdisk

Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized

Class com.amazonaws.services.ec2.model.ResetNetworkInterfaceAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

networkInterfaceId

String networkInterfaceId

sourceDestCheck

String sourceDestCheck

Class com.amazonaws.services.ec2.model.ResetSnapshotAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

snapshotId

String snapshotId

The ID of the snapshot whose attribute is being reset.

attribute

String attribute

The name of the attribute being reset.

Available attribute names: createVolumePermission

Constraints:
Allowed Values: productCodes, createVolumePermission

Class com.amazonaws.services.ec2.model.RevokeSecurityGroupEgressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupId

String groupId

ID of the VPC security group to modify.

sourceSecurityGroupName

String sourceSecurityGroupName

Deprecated.

sourceSecurityGroupOwnerId

String sourceSecurityGroupOwnerId

Deprecated.

ipProtocol

String ipProtocol

Deprecated.

fromPort

Integer fromPort

Deprecated.

toPort

Integer toPort

Deprecated.

cidrIp

String cidrIp

Deprecated.

ipPermissions

List<E> ipPermissions

List of IP permissions to authorize on the specified security group. Specifying permissions through IP permissions is the preferred way of authorizing permissions since it offers more flexibility and control.

Class com.amazonaws.services.ec2.model.RevokeSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

Name of the standard (EC2) security group to modify. The group must belong to your account. Can be used instead of GroupID for standard (EC2) security groups.

groupId

String groupId

ID of the standard (EC2) or VPC security group to modify. The group must belong to your account. Required for VPC security groups; can be used instead of GroupName for standard (EC2) security groups.

sourceSecurityGroupName

String sourceSecurityGroupName

Deprecated

sourceSecurityGroupOwnerId

String sourceSecurityGroupOwnerId

Deprecated

ipProtocol

String ipProtocol

Deprecated

fromPort

Integer fromPort

Deprecated

toPort

Integer toPort

Deprecated

cidrIp

String cidrIp

Deprecated

ipPermissions

List<E> ipPermissions

List of IP permissions to revoke on the specified security group. For an IP permission to be removed, it must exactly match one of the IP permissions you specify in this list. Specifying permissions through IP permissions is the preferred way of revoking permissions since it offers more flexibility and control.

Class com.amazonaws.services.ec2.model.Route extends Object implements Serializable

Serialized Fields

destinationCidrBlock

String destinationCidrBlock

gatewayId

String gatewayId

instanceId

String instanceId

instanceOwnerId

String instanceOwnerId

networkInterfaceId

String networkInterfaceId

state

String state

Class com.amazonaws.services.ec2.model.RouteTable extends Object implements Serializable

Serialized Fields

routeTableId

String routeTableId

vpcId

String vpcId

routes

List<E> routes

associations

List<E> associations

tags

List<E> tags

propagatingVgws

List<E> propagatingVgws

Class com.amazonaws.services.ec2.model.RouteTableAssociation extends Object implements Serializable

Serialized Fields

routeTableAssociationId

String routeTableAssociationId

routeTableId

String routeTableId

subnetId

String subnetId

main

Boolean main

Class com.amazonaws.services.ec2.model.RunInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

imageId

String imageId

Unique ID of a machine image, returned by a call to DescribeImages.

minCount

Integer minCount

Minimum number of instances to launch. If the value is more than Amazon EC2 can launch, no instances are launched at all.

maxCount

Integer maxCount

Maximum number of instances to launch. If the value is more than Amazon EC2 can launch, the largest possible number above minCount will be launched instead.

Between 1 and the maximum number allowed for your account (default: 20).

keyName

String keyName

The name of the key pair.

securityGroups

List<E> securityGroups

The names of the security groups into which the instances will be launched.

securityGroupIds

List<E> securityGroupIds

userData

String userData

Specifies additional information to make available to the instance(s).

instanceType

String instanceType

Specifies the instance type for the launched instances.

Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.xlarge, m3.2xlarge, c1.medium, c1.xlarge, hi1.4xlarge, hs1.8xlarge, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge

placement

Placement placement

Specifies the placement constraints (Availability Zones) for launching the instances.

kernelId

String kernelId

The ID of the kernel with which to launch the instance.

ramdiskId

String ramdiskId

The ID of the RAM disk with which to launch the instance. Some kernels require additional drivers at launch. Check the kernel requirements for information on whether you need to specify a RAM disk. To find kernel requirements, go to the Resource Center and search for the kernel ID.

blockDeviceMappings

List<E> blockDeviceMappings

Specifies how block devices are exposed to the instance. Each mapping is made up of a virtualName and a deviceName.

monitoring

Boolean monitoring

Enables monitoring for the instance.

subnetId

String subnetId

Specifies the subnet ID within which to launch the instance(s) for Amazon Virtual Private Cloud.

disableApiTermination

Boolean disableApiTermination

Specifies whether the instance can be terminated using the APIs. You must modify this attribute before you can terminate any "locked" instances from the APIs.

instanceInitiatedShutdownBehavior

String instanceInitiatedShutdownBehavior

Specifies whether the instance's Amazon EBS volumes are stopped or terminated when the instance is shut down.

license

InstanceLicenseSpecification license

Specifies active licenses in use and attached to an Amazon EC2 instance.

privateIpAddress

String privateIpAddress

If you're using Amazon Virtual Private Cloud, you can optionally use this parameter to assign the instance a specific available IP address from the subnet.

clientToken

String clientToken

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, go to How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

additionalInfo

String additionalInfo

networkInterfaces

List<E> networkInterfaces

iamInstanceProfile

IamInstanceProfileSpecification iamInstanceProfile

ebsOptimized

Boolean ebsOptimized

Class com.amazonaws.services.ec2.model.RunInstancesResult extends Object implements Serializable

Serialized Fields

reservation

Reservation reservation

The newly created reservation, containing the new instances.

Class com.amazonaws.services.ec2.model.S3Storage extends Object implements Serializable

Serialized Fields

bucket

String bucket

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf.

If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

prefix

String prefix

The prefix to use when storing the AMI in S3.

aWSAccessKeyId

String aWSAccessKeyId

The Access Key ID of the owner of the Amazon S3 bucket.

uploadPolicy

String uploadPolicy

A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on the user's behalf.

uploadPolicySignature

String uploadPolicySignature

The signature of the Base64 encoded JSON document.

Class com.amazonaws.services.ec2.model.SecurityGroup extends Object implements Serializable

Serialized Fields

ownerId

String ownerId

The AWS Access Key ID of the owner of the security group.

groupName

String groupName

The name of this security group.

groupId

String groupId

description

String description

The description of this security group.

ipPermissions

List<E> ipPermissions

The permissions enabled for this security group.

ipPermissionsEgress

List<E> ipPermissionsEgress

vpcId

String vpcId

tags

List<E> tags

Class com.amazonaws.services.ec2.model.Snapshot extends Object implements Serializable

Serialized Fields

snapshotId

String snapshotId

The unique ID of this snapshot.

volumeId

String volumeId

The ID of the volume from which this snapshot was created.

state

String state

Snapshot state (e.g., pending, completed, or error).

Constraints:
Allowed Values: pending, completed, error

startTime

Date startTime

Time stamp when the snapshot was initiated.

progress

String progress

The progress of the snapshot, in percentage.

ownerId

String ownerId

AWS Access Key ID of the user who owns the snapshot.

description

String description

Description of the snapshot.

volumeSize

Integer volumeSize

The size of the volume, in gigabytes.

ownerAlias

String ownerAlias

The AWS account alias (e.g., "amazon", "redhat", "self", etc.) or AWS account ID that owns the AMI.

tags

List<E> tags

A list of tags for the Snapshot.

Class com.amazonaws.services.ec2.model.SpotDatafeedSubscription extends Object implements Serializable

Serialized Fields

ownerId

String ownerId

Specifies the AWS account ID of the account.

bucket

String bucket

Specifies the Amazon S3 bucket where the Spot Instance data feed is located.

prefix

String prefix

Contains the prefix that is prepended to data feed files.

state

String state

Specifies the state of the Spot Instance request.

fault

SpotInstanceStateFault fault

Specifies a fault code for the Spot Instance request, if present.

Class com.amazonaws.services.ec2.model.SpotInstanceRequest extends Object implements Serializable

Serialized Fields

spotInstanceRequestId

String spotInstanceRequestId

spotPrice

String spotPrice

type

String type

state

String state

fault

SpotInstanceStateFault fault

status

SpotInstanceStatus status

validFrom

Date validFrom

validUntil

Date validUntil

launchGroup

String launchGroup

availabilityZoneGroup

String availabilityZoneGroup

launchSpecification

LaunchSpecification launchSpecification

The LaunchSpecificationType data type.

instanceId

String instanceId

createTime

Date createTime

productDescription

String productDescription

tags

List<E> tags

A list of tags for this spot instance request.

launchedAvailabilityZone

String launchedAvailabilityZone

The Availability Zone in which the bid is launched.

Class com.amazonaws.services.ec2.model.SpotInstanceStateFault extends Object implements Serializable

Serialized Fields

code

String code

message

String message

Class com.amazonaws.services.ec2.model.SpotInstanceStatus extends Object implements Serializable

Serialized Fields

code

String code

updateTime

Date updateTime

message

String message

Class com.amazonaws.services.ec2.model.SpotPlacement extends Object implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The availability zone in which an Amazon EC2 instance runs.

groupName

String groupName

The name of the PlacementGroup in which an Amazon EC2 instance runs. Placement groups are primarily used for launching High Performance Computing instances in the same group to ensure fast connection speeds.

Class com.amazonaws.services.ec2.model.SpotPrice extends Object implements Serializable

Serialized Fields

instanceType

String instanceType

productDescription

String productDescription

spotPrice

String spotPrice

timestamp

Date timestamp

availabilityZone

String availabilityZone

Class com.amazonaws.services.ec2.model.StartInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceIds

List<E> instanceIds

The list of Amazon EC2 instances to start.

additionalInfo

String additionalInfo

Class com.amazonaws.services.ec2.model.StartInstancesResult extends Object implements Serializable

Serialized Fields

startingInstances

List<E> startingInstances

The list of the starting instances and details on how their state has changed.

Class com.amazonaws.services.ec2.model.StateReason extends Object implements Serializable

Serialized Fields

code

String code

Reason code for the state change.

message

String message

Descriptive message for the state change.

Class com.amazonaws.services.ec2.model.StopInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceIds

List<E> instanceIds

The list of Amazon EC2 instances to stop.

force

Boolean force

Forces the instance to stop. The instance will not have an opportunity to flush file system caches nor file system meta data. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Class com.amazonaws.services.ec2.model.StopInstancesResult extends Object implements Serializable

Serialized Fields

stoppingInstances

List<E> stoppingInstances

The list of the stopping instances and details on how their state has changed.

Class com.amazonaws.services.ec2.model.Storage extends Object implements Serializable

Serialized Fields

s3

S3Storage s3

The details of S3 storage for bundling a Windows instance.

Class com.amazonaws.services.ec2.model.Subnet extends Object implements Serializable

Serialized Fields

subnetId

String subnetId

Specifies the ID of the subnet.

state

String state

Describes the current state of the subnet. The state of the subnet may be either pending or available.

vpcId

String vpcId

Contains the ID of the VPC the subnet is in.

cidrBlock

String cidrBlock

Specifies the CIDR block assigned to the subnet.

availableIpAddressCount

Integer availableIpAddressCount

Specifies the number of unused IP addresses in the subnet.

The IP addresses for any stopped instances are considered unavailable.

availabilityZone

String availabilityZone

Specifies the Availability Zone the subnet is in.

defaultForAz

Boolean defaultForAz

mapPublicIpOnLaunch

Boolean mapPublicIpOnLaunch

tags

List<E> tags

A list of tags for the Subnet.

Class com.amazonaws.services.ec2.model.Tag extends Object implements Serializable

Serialized Fields

key

String key

The tag's key.

value

String value

The tag's value.

Class com.amazonaws.services.ec2.model.TagDescription extends Object implements Serializable

Serialized Fields

resourceId

String resourceId

The resource ID for the tag.

resourceType

String resourceType

The type of resource identified by the associated resource ID (ex: instance, AMI, EBS volume, etc).

Constraints:
Allowed Values: customer-gateway, dhcp-options, image, instance, snapshot, spot-instances-request, subnet, volume, vpc, vpn-connection, vpn-gateway

key

String key

The tag's key.

value

String value

The tag's value.

Class com.amazonaws.services.ec2.model.TerminateInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceIds

List<E> instanceIds

The list of instances to terminate.

Class com.amazonaws.services.ec2.model.TerminateInstancesResult extends Object implements Serializable

Serialized Fields

terminatingInstances

List<E> terminatingInstances

The list of the terminating instances and details on how their state has changed.

Class com.amazonaws.services.ec2.model.UnassignPrivateIpAddressesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

networkInterfaceId

String networkInterfaceId

privateIpAddresses

List<E> privateIpAddresses

Class com.amazonaws.services.ec2.model.UnmonitorInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceIds

List<E> instanceIds

The list of Amazon EC2 instances on which to disable monitoring.

Class com.amazonaws.services.ec2.model.UnmonitorInstancesResult extends Object implements Serializable

Serialized Fields

instanceMonitorings

List<E> instanceMonitorings

A list of updated monitoring information for the instances specified in the request.

Class com.amazonaws.services.ec2.model.UserIdGroupPair extends Object implements Serializable

Serialized Fields

userId

String userId

The AWS user ID of an account.

groupName

String groupName

Name of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.

groupId

String groupId

ID of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.

Class com.amazonaws.services.ec2.model.VgwTelemetry extends Object implements Serializable

Serialized Fields

outsideIpAddress

String outsideIpAddress

status

String status

lastStatusChange

Date lastStatusChange

statusMessage

String statusMessage

acceptedRouteCount

Integer acceptedRouteCount

Class com.amazonaws.services.ec2.model.Volume extends Object implements Serializable

Serialized Fields

volumeId

String volumeId

The unique ID of this volume.

size

Integer size

The size of this volume, in gigabytes.

snapshotId

String snapshotId

Optional snapshot from which this volume was created.

availabilityZone

String availabilityZone

Availability zone in which this volume was created.

state

String state

State of this volume (e.g., creating, available).

Constraints:
Allowed Values: creating, available, in-use, deleting, error

createTime

Date createTime

Timestamp when volume creation was initiated.

attachments

List<E> attachments

Information on what this volume is attached to.

tags

List<E> tags

A list of tags for the Volume.

volumeType

String volumeType

iops

Integer iops

Class com.amazonaws.services.ec2.model.VolumeAttachment extends Object implements Serializable

Serialized Fields

volumeId

String volumeId

instanceId

String instanceId

device

String device

How the device is exposed to the instance (e.g., /dev/sdh).

state

String state

Constraints:
Allowed Values: attaching, attached, detaching, detached

attachTime

Date attachTime

Timestamp when this attachment initiated.

deleteOnTermination

Boolean deleteOnTermination

`

Whether this volume will be deleted or not when the associated instance is terminated.

Class com.amazonaws.services.ec2.model.VolumeDetail extends Object implements Serializable

Serialized Fields

size

Long size

Class com.amazonaws.services.ec2.model.VolumeStatusAction extends Object implements Serializable

Serialized Fields

code

String code

description

String description

eventType

String eventType

eventId

String eventId

Class com.amazonaws.services.ec2.model.VolumeStatusDetails extends Object implements Serializable

Serialized Fields

name

String name

status

String status

Class com.amazonaws.services.ec2.model.VolumeStatusEvent extends Object implements Serializable

Serialized Fields

eventType

String eventType

description

String description

notBefore

Date notBefore

notAfter

Date notAfter

eventId

String eventId

Class com.amazonaws.services.ec2.model.VolumeStatusInfo extends Object implements Serializable

Serialized Fields

status

String status

details

List<E> details

Class com.amazonaws.services.ec2.model.VolumeStatusItem extends Object implements Serializable

Serialized Fields

volumeId

String volumeId

availabilityZone

String availabilityZone

volumeStatus

VolumeStatusInfo volumeStatus

events

List<E> events

actions

List<E> actions

Class com.amazonaws.services.ec2.model.Vpc extends Object implements Serializable

Serialized Fields

vpcId

String vpcId

Specifies the ID of the VPC.

state

String state

Describes the current state of the VPC. The state of the subnet may be either pending or available.

cidrBlock

String cidrBlock

Specifies the CIDR block the VPC covers.

dhcpOptionsId

String dhcpOptionsId

Specifies the ID of the set of DHCP options associated with the VPC. Contains a value of default if the default options are associated with the VPC.

tags

List<E> tags

A list of tags for the VPC.

instanceTenancy

String instanceTenancy

The allowed tenancy of instances launched into the VPC.

isDefault

Boolean isDefault

Class com.amazonaws.services.ec2.model.VpcAttachment extends Object implements Serializable

Serialized Fields

vpcId

String vpcId

state

String state

Class com.amazonaws.services.ec2.model.VpnConnection extends Object implements Serializable

Serialized Fields

vpnConnectionId

String vpnConnectionId

Specifies the ID of the VPN gateway at the VPC end of the VPN connection.

state

String state

Describes the current state of the VPN connection. Valid values are pending, available, deleting, and deleted.

customerGatewayConfiguration

String customerGatewayConfiguration

Contains configuration information in the native XML format for the VPN connection's customer gateway.

This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

type

String type

Specifies the type of VPN connection.

customerGatewayId

String customerGatewayId

Specifies ID of the customer gateway at the end of the VPN connection.

vpnGatewayId

String vpnGatewayId

Specfies the ID of the VPN gateway at the VPC end of the VPN connection.

tags

List<E> tags

A list of tags for the VpnConnection.

vgwTelemetry

List<E> vgwTelemetry

options

VpnConnectionOptions options

routes

List<E> routes

Class com.amazonaws.services.ec2.model.VpnConnectionOptions extends Object implements Serializable

Serialized Fields

staticRoutesOnly

Boolean staticRoutesOnly

Class com.amazonaws.services.ec2.model.VpnConnectionOptionsSpecification extends Object implements Serializable

Serialized Fields

staticRoutesOnly

Boolean staticRoutesOnly

Class com.amazonaws.services.ec2.model.VpnGateway extends Object implements Serializable

Serialized Fields

vpnGatewayId

String vpnGatewayId

Specifies the ID of the VPN gateway.

state

String state

Describes the current state of the VPN gateway. Valid values are pending, available, deleting, and deleted.

type

String type

Specifies the type of VPN connection the VPN gateway supports.

availabilityZone

String availabilityZone

Specifies the Availability Zone where the VPN gateway was created.

vpcAttachments

List<E> vpcAttachments

Contains information about the VPCs attached to the VPN gateway.

tags

List<E> tags

A list of tags for the VpnGateway.

Class com.amazonaws.services.ec2.model.VpnStaticRoute extends Object implements Serializable

Serialized Fields

destinationCidrBlock

String destinationCidrBlock

source

String source

state

String state

Package com.amazonaws.services.elasticache.model

Class com.amazonaws.services.elasticache.model.AuthorizationAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.AuthorizationNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.AuthorizeCacheSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheSecurityGroupName

String cacheSecurityGroupName

The name of the Cache Security Group to authorize.

eC2SecurityGroupName

String eC2SecurityGroupName

Name of the EC2 Security Group to include in the authorization.

eC2SecurityGroupOwnerId

String eC2SecurityGroupOwnerId

AWS Account Number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.

Class com.amazonaws.services.elasticache.model.AvailabilityZone extends Object implements Serializable

Serialized Fields

name

String name

Specifies the name of the Availability Zone

Class com.amazonaws.services.elasticache.model.CacheCluster extends Object implements Serializable

Serialized Fields

cacheClusterId

String cacheClusterId

Specifies a user-supplied identifier. This is the unique key that identifies a Cache Cluster.

configurationEndpoint

Endpoint configurationEndpoint

Specifies a user-supplied identifier. This is the unique key that identifies a Cache Cluster.

clientDownloadLandingPage

String clientDownloadLandingPage

Provides the landing page to download the latest ElastiCache client library.

cacheNodeType

String cacheNodeType

Specifies the name of the compute and memory capacity node type for the Cache Cluster.

engine

String engine

Provides the name of the cache engine to be used for this Cache Cluster.

engineVersion

String engineVersion

Provides the cache engine version of the cache engine to be used for this Cache Cluster.

cacheClusterStatus

String cacheClusterStatus

Specifies the current state of this Cache Cluster.

numCacheNodes

Integer numCacheNodes

Specifies the number of Cache Nodes the Cache Cluster contains.

preferredAvailabilityZone

String preferredAvailabilityZone

Specifies the name of the Availability Zone the Cache Cluster is located in.

cacheClusterCreateTime

Date cacheClusterCreateTime

Provides the date and time the Cache Cluster was created.

preferredMaintenanceWindow

String preferredMaintenanceWindow

Specifies the weekly time range (in UTC) during which system maintenance can occur.

pendingModifiedValues

PendingModifiedValues pendingModifiedValues

Specifies that changes to the Cache Cluster are pending. This element is only included when changes are pending. Specific changes are identified by sub-elements.

notificationConfiguration

NotificationConfiguration notificationConfiguration

Specifies the notification details the Cache Cluster contains.

cacheSecurityGroups

List<E> cacheSecurityGroups

Provides the list of Cache Security Group elements containing CacheSecurityGroup.Name and CacheSecurityGroup.Status sub-elements.

cacheParameterGroup

CacheParameterGroupStatus cacheParameterGroup

Provides the status of the Cache Parameter Group assigned to the Cache Cluster.

cacheSubnetGroupName

String cacheSubnetGroupName

Specifies the name of the Cache Subnet Group associated with the Cache Cluster.

cacheNodes

List<E> cacheNodes

Specifies the list of Cache Nodes the Cache Cluster contains.

autoMinorVersionUpgrade

Boolean autoMinorVersionUpgrade

Indicates that minor version patches are applied automatically.

securityGroups

List<E> securityGroups

Specifies the VPC Security Groups associated with the Cache Cluster.

Class com.amazonaws.services.elasticache.model.CacheClusterAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.CacheClusterNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.CacheEngineVersion extends Object implements Serializable

Serialized Fields

engine

String engine

The name of the cache engine.

engineVersion

String engineVersion

The version number of the cache engine.

cacheParameterGroupFamily

String cacheParameterGroupFamily

The name of the CacheParameterGroupFamily for the cache engine.

cacheEngineDescription

String cacheEngineDescription

The description of the cache engine.

cacheEngineVersionDescription

String cacheEngineVersionDescription

The description of the cache engine version.

Class com.amazonaws.services.elasticache.model.CacheNode extends Object implements Serializable

Serialized Fields

cacheNodeId

String cacheNodeId

Specifies a Cache Node identifier. This is the unique key that identifies a Cache Node per Customer (AWS account).

cacheNodeStatus

String cacheNodeStatus

Specifies the current state of this Cache Node.

cacheNodeCreateTime

Date cacheNodeCreateTime

Provides the date and time the Cache Node was created.

endpoint

Endpoint endpoint

Specifies the endpoint details for a Cache Node.

parameterGroupStatus

String parameterGroupStatus

Specifies the status of the parameter group applied to this Cache Node.

Class com.amazonaws.services.elasticache.model.CacheNodeTypeSpecificParameter extends Object implements Serializable

Serialized Fields

parameterName

String parameterName

Specifies the name of the parameter.

description

String description

Provides a description of the parameter.

source

String source

Indicates the source of the parameter value.

dataType

String dataType

Specifies the valid data type for the parameter.

allowedValues

String allowedValues

Specifies the valid range of values for the parameter.

isModifiable

Boolean isModifiable

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

minimumEngineVersion

String minimumEngineVersion

The earliest engine version to which the parameter can apply.

cacheNodeTypeSpecificValues

List<E> cacheNodeTypeSpecificValues

A list of Cache Node types and their corresponding values for this parameter.

Class com.amazonaws.services.elasticache.model.CacheNodeTypeSpecificValue extends Object implements Serializable

Serialized Fields

cacheNodeType

String cacheNodeType

Specifies the Cache Node type for which this value applies.

value

String value

Specifies the value for the Cache Node type.

Class com.amazonaws.services.elasticache.model.CacheParameterGroup extends Object implements Serializable

Serialized Fields

cacheParameterGroupName

String cacheParameterGroupName

Provides the name of the Cache Parameter Group.

cacheParameterGroupFamily

String cacheParameterGroupFamily

Provides the name of the Cache Parameter Group Family that this Cache Parameter Group is compatible with.

description

String description

Provides the customer-specified description for this Cache Parameter Group.

Class com.amazonaws.services.elasticache.model.CacheParameterGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.CacheParameterGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.CacheParameterGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.CacheParameterGroupStatus extends Object implements Serializable

Serialized Fields

cacheParameterGroupName

String cacheParameterGroupName

The name of the Cache Parameter Group.

parameterApplyStatus

String parameterApplyStatus

The status of parameter updates.

cacheNodeIdsToReboot

List<E> cacheNodeIdsToReboot

A list of the Cache Node Ids which need to be rebooted for parameter changes to be applied.

Class com.amazonaws.services.elasticache.model.CacheSecurityGroup extends Object implements Serializable

Serialized Fields

ownerId

String ownerId

Provides the AWS ID of the owner of a specific Cache Security Group.

cacheSecurityGroupName

String cacheSecurityGroupName

Specifies the name of the Cache Security Group.

description

String description

Provides the description of the Cache Security Group.

eC2SecurityGroups

List<E> eC2SecurityGroups

Contains a list of EC2SecurityGroup elements.

Class com.amazonaws.services.elasticache.model.CacheSecurityGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.CacheSecurityGroupMembership extends Object implements Serializable

Serialized Fields

cacheSecurityGroupName

String cacheSecurityGroupName

The name of the Cache Security Group.

status

String status

The status of the CacheSecurityGroupMembership, the status changes either when a CacheSecurityGroup is modified, or when the CacheSecurityGroups assigned to a Cache Cluster are modified.

Class com.amazonaws.services.elasticache.model.CacheSecurityGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.CacheSecurityGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.CacheSubnetGroup extends Object implements Serializable

Serialized Fields

cacheSubnetGroupName

String cacheSubnetGroupName

Specifies the name of the Cache Subnet Group.

cacheSubnetGroupDescription

String cacheSubnetGroupDescription

Provides the description of the Cache Subnet Group.

vpcId

String vpcId

Provides the VPC ID of the Cache Subnet Group.

subnets

List<E> subnets

Contains a list of subnets for this group.

Class com.amazonaws.services.elasticache.model.CacheSubnetGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.CacheSubnetGroupInUseException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.CacheSubnetGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.CacheSubnetGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.CacheSubnetQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.ClusterQuotaForCustomerExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.CreateCacheClusterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheClusterId

String cacheClusterId

The Cache Cluster identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 20 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: mycachecluster

numCacheNodes

Integer numCacheNodes

The number of Cache Nodes the Cache Cluster should have.

cacheNodeType

String cacheNodeType

The compute and memory capacity of nodes in a Cache Cluster.

Valid values: cache.t1.micro | cache.m1.small | cache.m1.medium | cache.m1.large | cache.m1.xlarge | cache.m3.xlarge | cache.m3.2xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

engine

String engine

The name of the cache engine to be used for this Cache Cluster. Currently, memcached is the only cache engine supported by the service.

engineVersion

String engineVersion

The version of the cache engine to be used for this cluster.

cacheParameterGroupName

String cacheParameterGroupName

The name of the cache parameter group to associate with this Cache cluster. If this argument is omitted, the default CacheParameterGroup for the specified engine will be used.

cacheSubnetGroupName

String cacheSubnetGroupName

The name of the Cache Subnet Group to be used for the Cache Cluster.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).

cacheSecurityGroupNames

List<E> cacheSecurityGroupNames

A list of Cache Security Group Names to associate with this Cache Cluster.

Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).

securityGroupIds

List<E> securityGroupIds

Specifies the VPC Security Groups associated with the Cache Cluster.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).

preferredAvailabilityZone

String preferredAvailabilityZone

The EC2 Availability Zone that the Cache Cluster will be created in.

All cache nodes belonging to a cache cluster are placed in the preferred availability zone.

Default: System chosen (random) availability zone.

preferredMaintenanceWindow

String preferredMaintenanceWindow

The weekly time range (in UTC) during which system maintenance can occur.

Example: sun:05:00-sun:09:00

port

Integer port

The port number on which each of the Cache Nodes will accept connections.

notificationTopicArn

String notificationTopicArn

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent. The Amazon SNS topic owner must be the same as the Cache Cluster owner.

autoMinorVersionUpgrade

Boolean autoMinorVersionUpgrade

Indicates that minor engine upgrades will be applied automatically to the Cache Cluster during the maintenance window.

Default: true

Class com.amazonaws.services.elasticache.model.CreateCacheParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheParameterGroupName

String cacheParameterGroupName

The name of the Cache Parameter Group.

cacheParameterGroupFamily

String cacheParameterGroupFamily

The name of the Cache Parameter Group Family the Cache Parameter Group can be used with. Currently, memcached1.4 is the only cache parameter group family supported by the service.

description

String description

The description for the Cache Parameter Group.

Class com.amazonaws.services.elasticache.model.CreateCacheSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheSecurityGroupName

String cacheSecurityGroupName

The name for the Cache Security Group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

Example: mysecuritygroup

description

String description

The description for the Cache Security Group.

Class com.amazonaws.services.elasticache.model.CreateCacheSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheSubnetGroupName

String cacheSubnetGroupName

The name for the Cache Subnet Group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

Example: mysubnetgroup

cacheSubnetGroupDescription

String cacheSubnetGroupDescription

The description for the Cache Subnet Group.

subnetIds

List<E> subnetIds

The EC2 Subnet IDs for the Cache Subnet Group.

Class com.amazonaws.services.elasticache.model.DeleteCacheClusterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheClusterId

String cacheClusterId

The Cache Cluster identifier for the Cache Cluster to be deleted. This parameter isn't case sensitive.

Class com.amazonaws.services.elasticache.model.DeleteCacheParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheParameterGroupName

String cacheParameterGroupName

The name of the Cache Parameter Group to delete. The specified cache security group must not be associated with any Cache clusters.

Class com.amazonaws.services.elasticache.model.DeleteCacheSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheSecurityGroupName

String cacheSecurityGroupName

The name of the Cache Security Group to delete. You cannot delete the default security group.

Class com.amazonaws.services.elasticache.model.DeleteCacheSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheSubnetGroupName

String cacheSubnetGroupName

The name of the Cache Subnet Group to delete.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

Class com.amazonaws.services.elasticache.model.DescribeCacheClustersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheClusterId

String cacheClusterId

The user-supplied cluster identifier. If this parameter is specified, only information about that specific Cache Cluster is returned. This parameter isn't case sensitive.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

marker

String marker

An optional marker provided in the previous DescribeCacheClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

showCacheNodeInfo

Boolean showCacheNodeInfo

An optional flag that can be included in the DescribeCacheCluster request to retrieve Cache Nodes information.

Class com.amazonaws.services.elasticache.model.DescribeCacheClustersResult extends Object implements Serializable

Serialized Fields

marker

String marker

The marker obtained from a previous operation response.

cacheClusters

List<E> cacheClusters

A list of CacheClusters.

Class com.amazonaws.services.elasticache.model.DescribeCacheEngineVersionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

engine

String engine

The cache engine to return.

engineVersion

String engineVersion

The cache engine version to return.

Example: 1.4.14

cacheParameterGroupFamily

String cacheParameterGroupFamily

The name of a specific Cache Parameter Group family to return details for.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved.

marker

String marker

An optional marker provided in the previous DescribeCacheParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

defaultOnly

Boolean defaultOnly

Indicates that only the default version of the specified engine or engine and major version combination is returned.

Class com.amazonaws.services.elasticache.model.DescribeCacheEngineVersionsResult extends Object implements Serializable

Serialized Fields

marker

String marker

The identifier returned to allow retrieval of paginated results.

cacheEngineVersions

List<E> cacheEngineVersions

A list of CacheEngineVersion elements.

Class com.amazonaws.services.elasticache.model.DescribeCacheParameterGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheParameterGroupName

String cacheParameterGroupName

The name of a specific cache parameter group to return details for.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved.

marker

String marker

An optional marker provided in the previous DescribeCacheParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.elasticache.model.DescribeCacheParameterGroupsResult extends Object implements Serializable

Serialized Fields

marker

String marker

The marker obtained from a previous operation response.

cacheParameterGroups

List<E> cacheParameterGroups

A list of CacheParameterGroup instances.

Class com.amazonaws.services.elasticache.model.DescribeCacheParametersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheParameterGroupName

String cacheParameterGroupName

The name of a specific cache parameter group to return details for.

source

String source

The parameter types to return.

Valid values: user | system | engine-default

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved.

marker

String marker

An optional marker provided in the previous DescribeCacheClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.elasticache.model.DescribeCacheParametersResult extends Object implements Serializable

Serialized Fields

marker

String marker

The marker obtained from a previous operation response.

parameters

List<E> parameters

A list of Parameter instances.

cacheNodeTypeSpecificParameters

List<E> cacheNodeTypeSpecificParameters

A list of CacheNodeTypeSpecificParameter instances.

Class com.amazonaws.services.elasticache.model.DescribeCacheSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheSecurityGroupName

String cacheSecurityGroupName

The name of the Cache Security Group to return details for.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

marker

String marker

An optional marker provided in the previous DescribeCacheClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.elasticache.model.DescribeCacheSecurityGroupsResult extends Object implements Serializable

Serialized Fields

marker

String marker

The marker obtained from a previous operation response.

cacheSecurityGroups

List<E> cacheSecurityGroups

A list of CacheSecurityGroup instances.

Class com.amazonaws.services.elasticache.model.DescribeCacheSubnetGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheSubnetGroupName

String cacheSubnetGroupName

The name of the Cache Subnet Group to return details for.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

marker

String marker

An optional marker provided in the previous DescribeCacheSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.elasticache.model.DescribeCacheSubnetGroupsResult extends Object implements Serializable

Serialized Fields

marker

String marker

The marker obtained from a previous operation response.

cacheSubnetGroups

List<E> cacheSubnetGroups

One or more Cache Subnet Groups.

Class com.amazonaws.services.elasticache.model.DescribeEngineDefaultParametersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheParameterGroupFamily

String cacheParameterGroupFamily

The name of the Cache Parameter Group Family. Currently, memcached1.4 is the only cache parameter group family supported by the service.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved.

marker

String marker

An optional marker provided in the previous DescribeCacheClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.elasticache.model.DescribeEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sourceIdentifier

String sourceIdentifier

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

sourceType

String sourceType

The event source to retrieve events for. If no value is specified, all events are returned.

Constraints:
Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group

startTime

Date startTime

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

endTime

Date endTime

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

duration

Integer duration

The number of minutes to retrieve events for.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved.

marker

String marker

An optional marker provided in the previous DescribeCacheClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.elasticache.model.DescribeEventsResult extends Object implements Serializable

Serialized Fields

marker

String marker

The marker obtained from a previous operation response.

events

List<E> events

A list of Event instances.

Class com.amazonaws.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

reservedCacheNodesOfferingId

String reservedCacheNodesOfferingId

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

cacheNodeType

String cacheNodeType

The Cache Node type filter value. Specify this parameter to show only the available offerings matching the specified Cache Node type.

duration

String duration

Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

productDescription

String productDescription

Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.

offeringType

String offeringType

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Light Utilization" | "Medium Utilization" | "Heavy Utilization"

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more than the MaxRecords value is available, a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

marker

String marker

The marker provided in the previous request. If this parameter is specified, the response includes records beyond the marker only, up to MaxRecords.

Class com.amazonaws.services.elasticache.model.DescribeReservedCacheNodesOfferingsResult extends Object implements Serializable

Serialized Fields

marker

String marker

A marker provided for paginated results.

reservedCacheNodesOfferings

List<E> reservedCacheNodesOfferings

A list of reserved Cache Node offerings.

Class com.amazonaws.services.elasticache.model.DescribeReservedCacheNodesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

reservedCacheNodeId

String reservedCacheNodeId

The reserved Cache Node identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

reservedCacheNodesOfferingId

String reservedCacheNodesOfferingId

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

cacheNodeType

String cacheNodeType

The Cache Node type filter value. Specify this parameter to show only those reservations matching the specified Cache Nodes type.

duration

String duration

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

productDescription

String productDescription

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

offeringType

String offeringType

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Light Utilization" | "Medium Utilization" | "Heavy Utilization"

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more than the MaxRecords value is available, a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

marker

String marker

The marker provided in the previous request. If this parameter is specified, the response includes records beyond the marker only, up to MaxRecords.

Class com.amazonaws.services.elasticache.model.DescribeReservedCacheNodesResult extends Object implements Serializable

Serialized Fields

marker

String marker

The marker provided for paginated results.

reservedCacheNodes

List<E> reservedCacheNodes

A list of of reserved Cache Nodes.

Class com.amazonaws.services.elasticache.model.EC2SecurityGroup extends Object implements Serializable

Serialized Fields

status

String status

Provides the status of the EC2 Security Group.

eC2SecurityGroupName

String eC2SecurityGroupName

Specifies the name of the EC2 Security Group.

eC2SecurityGroupOwnerId

String eC2SecurityGroupOwnerId

Specifies the AWS ID of the owner of the EC2 Security Group specified in the EC2SecurityGroupName field.

Class com.amazonaws.services.elasticache.model.Endpoint extends Object implements Serializable

Serialized Fields

address

String address

Specifies the DNS address of the Cache Node.

port

Integer port

Specifies the port that the cache engine is listening on.

Class com.amazonaws.services.elasticache.model.EngineDefaults extends Object implements Serializable

Serialized Fields

cacheParameterGroupFamily

String cacheParameterGroupFamily

Specifies the name of the Cache Parameter Group Family which the engine default parameters apply to.

marker

String marker

Provides an identifier to allow retrieval of paginated results.

parameters

List<E> parameters

Contains a list of engine default parameters.

cacheNodeTypeSpecificParameters

List<E> cacheNodeTypeSpecificParameters

A list of CacheNodeTypeSpecificParameter instances.

Class com.amazonaws.services.elasticache.model.Event extends Object implements Serializable

Serialized Fields

sourceIdentifier

String sourceIdentifier

Provides the identifier for the source of the event.

sourceType

String sourceType

Specifies the source type for this event.

Constraints:
Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group

message

String message

Provides the text of this event.

date

Date date

Specifies the date and time of the event.

Class com.amazonaws.services.elasticache.model.InsufficientCacheClusterCapacityException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.InvalidCacheClusterStateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.InvalidCacheParameterGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.InvalidCacheSecurityGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.InvalidParameterCombinationException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.InvalidParameterValueException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.InvalidSubnetException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.InvalidVPCNetworkStateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.ModifyCacheClusterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheClusterId

String cacheClusterId

The Cache Cluster identifier. This value is stored as a lowercase string.

numCacheNodes

Integer numCacheNodes

The number of Cache Nodes the Cache Cluster should have. If NumCacheNodes is greater than the existing number of Cache Nodes, Cache Nodes will be added. If NumCacheNodes is less than the existing number of Cache Nodes, Cache Nodes will be removed. When removing Cache Nodes, the Ids of the specific Cache Nodes to be removed must be supplied using the CacheNodeIdsToRemove parameter.

cacheNodeIdsToRemove

List<E> cacheNodeIdsToRemove

The list of Cache Node IDs to be removed. This parameter is only valid when NumCacheNodes is less than the existing number of Cache Nodes. The number of Cache Node Ids supplied in this parameter must match the difference between the existing number of Cache Nodes in the cluster and the new NumCacheNodes requested.

cacheSecurityGroupNames

List<E> cacheSecurityGroupNames

A list of Cache Security Group Names to authorize on this Cache Cluster. This change is asynchronously applied as soon as possible.

This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

securityGroupIds

List<E> securityGroupIds

Specifies the VPC Security Groups associated with the Cache Cluster.

This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).

preferredMaintenanceWindow

String preferredMaintenanceWindow

The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. This change is made immediately. If moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure pending changes are applied.

notificationTopicArn

String notificationTopicArn

The Amazon Resource Name (ARN) of the SNS topic to which notifications will be sent. The SNS topic owner must be same as the Cache Cluster owner.

cacheParameterGroupName

String cacheParameterGroupName

The name of the Cache Parameter Group to apply to this Cache Cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

notificationTopicStatus

String notificationTopicStatus

The status of the Amazon SNS notification topic. The value can be active or inactive. Notifications are sent only if the status is active.

applyImmediately

Boolean applyImmediately

Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the Cache Cluster.

If this parameter is passed as false, changes to the Cache Cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

Default: false

engineVersion

String engineVersion

The version of the cache engine to upgrade this cluster to.

autoMinorVersionUpgrade

Boolean autoMinorVersionUpgrade

Indicates that minor engine upgrades will be applied automatically to the Cache Cluster during the maintenance window.

Default: true

Class com.amazonaws.services.elasticache.model.ModifyCacheParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheParameterGroupName

String cacheParameterGroupName

The name of the cache parameter group to modify.

parameterNameValues

List<E> parameterNameValues

An array of parameter names and values for the parameter update. At least one parameter name and value must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.

Class com.amazonaws.services.elasticache.model.ModifyCacheParameterGroupResult extends Object implements Serializable

Serialized Fields

cacheParameterGroupName

String cacheParameterGroupName

The name of the Cache Parameter Group.

Class com.amazonaws.services.elasticache.model.ModifyCacheSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheSubnetGroupName

String cacheSubnetGroupName

The name for the Cache Subnet Group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

Example: mysubnetgroup

cacheSubnetGroupDescription

String cacheSubnetGroupDescription

The description for the Cache Subnet Group.

subnetIds

List<E> subnetIds

The EC2 Subnet IDs for the Cache Subnet Group.

Class com.amazonaws.services.elasticache.model.NodeQuotaForClusterExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.NodeQuotaForCustomerExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.NotificationConfiguration extends Object implements Serializable

Serialized Fields

topicArn

String topicArn

Specifies the topic Amazon Resource Name (ARN), identifying this resource.

topicStatus

String topicStatus

Specifies the current state of this topic.

Class com.amazonaws.services.elasticache.model.Parameter extends Object implements Serializable

Serialized Fields

parameterName

String parameterName

Specifies the name of the parameter.

parameterValue

String parameterValue

Specifies the value of the parameter.

description

String description

Provides a description of the parameter.

source

String source

Indicates the source of the parameter value.

dataType

String dataType

Specifies the valid data type for the parameter.

allowedValues

String allowedValues

Specifies the valid range of values for the parameter.

isModifiable

Boolean isModifiable

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

minimumEngineVersion

String minimumEngineVersion

The earliest engine version to which the parameter can apply.

Class com.amazonaws.services.elasticache.model.ParameterNameValue extends Object implements Serializable

Serialized Fields

parameterName

String parameterName

Specifies the name of the parameter.

parameterValue

String parameterValue

Specifies the value of the parameter.

Class com.amazonaws.services.elasticache.model.PendingModifiedValues extends Object implements Serializable

Serialized Fields

numCacheNodes

Integer numCacheNodes

Contains the new NumCacheNodes for the Cache Cluster that will be applied or is in progress.

cacheNodeIdsToRemove

List<E> cacheNodeIdsToRemove

Contains the list of node Ids to remove from the Cache Cluster that will be applied or is in progress.

engineVersion

String engineVersion

Contains the new version of the Cache Engine the Cache Cluster will be upgraded to.

Class com.amazonaws.services.elasticache.model.PurchaseReservedCacheNodesOfferingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

reservedCacheNodesOfferingId

String reservedCacheNodesOfferingId

The ID of the Reserved Cache Node offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

reservedCacheNodeId

String reservedCacheNodeId

Customer-specified identifier to track this reservation.

Example: myreservationID

cacheNodeCount

Integer cacheNodeCount

The number of instances to reserve.

Default: 1

Class com.amazonaws.services.elasticache.model.RebootCacheClusterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheClusterId

String cacheClusterId

The Cache Cluster identifier. This parameter is stored as a lowercase string.

cacheNodeIdsToReboot

List<E> cacheNodeIdsToReboot

A list of Cache Cluster Node Ids to reboot. To reboot an entire cache cluster, specify all cache cluster node Ids.

Class com.amazonaws.services.elasticache.model.RecurringCharge extends Object implements Serializable

Serialized Fields

recurringChargeAmount

Double recurringChargeAmount

The amount of the recurring charge.

recurringChargeFrequency

String recurringChargeFrequency

The frequency of the recurring charge.

Class com.amazonaws.services.elasticache.model.ReservedCacheNode extends Object implements Serializable

Serialized Fields

reservedCacheNodeId

String reservedCacheNodeId

The unique identifier for the reservation.

reservedCacheNodesOfferingId

String reservedCacheNodesOfferingId

The offering identifier.

cacheNodeType

String cacheNodeType

The cache node type for the reserved Cache Node.

startTime

Date startTime

The time the reservation started.

duration

Integer duration

The duration of the reservation in seconds.

fixedPrice

Double fixedPrice

The fixed price charged for this reserved Cache Node.

usagePrice

Double usagePrice

The hourly price charged for this reserved Cache Node.

cacheNodeCount

Integer cacheNodeCount

The number of reserved Cache Nodes.

productDescription

String productDescription

The description of the reserved Cache Node.

offeringType

String offeringType

The offering type of this reserved Cache Node.

state

String state

The state of the reserved Cache Node.

recurringCharges

List<E> recurringCharges

The recurring price charged to run this reserved Cache Node.

Class com.amazonaws.services.elasticache.model.ReservedCacheNodeAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.ReservedCacheNodeNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.ReservedCacheNodeQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.ReservedCacheNodesOffering extends Object implements Serializable

Serialized Fields

reservedCacheNodesOfferingId

String reservedCacheNodesOfferingId

The offering identifier.

cacheNodeType

String cacheNodeType

The Cache Node type for the reserved Cache Node.

duration

Integer duration

The duration of the offering in seconds.

fixedPrice

Double fixedPrice

The fixed price charged for this offering.

usagePrice

Double usagePrice

The hourly price charged for this offering.

productDescription

String productDescription

The cache engine used by the offering.

offeringType

String offeringType

The offering type.

recurringCharges

List<E> recurringCharges

The recurring price charged to run this reserved Cache Node.

Class com.amazonaws.services.elasticache.model.ReservedCacheNodesOfferingNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticache.model.ResetCacheParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheParameterGroupName

String cacheParameterGroupName

The name of the Cache Parameter Group.

resetAllParameters

Boolean resetAllParameters

Specifies whether (true) or not (false) to reset all parameters in the Cache Parameter Group to default values.

parameterNameValues

List<E> parameterNameValues

An array of parameter names which should be reset. If not resetting the entire CacheParameterGroup, at least one parameter name must be supplied.

Class com.amazonaws.services.elasticache.model.ResetCacheParameterGroupResult extends Object implements Serializable

Serialized Fields

cacheParameterGroupName

String cacheParameterGroupName

The name of the Cache Parameter Group.

Class com.amazonaws.services.elasticache.model.RevokeCacheSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheSecurityGroupName

String cacheSecurityGroupName

The name of the Cache Security Group to revoke ingress from.

eC2SecurityGroupName

String eC2SecurityGroupName

The name of the EC2 Security Group to revoke access from.

eC2SecurityGroupOwnerId

String eC2SecurityGroupOwnerId

The AWS Account Number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.

Class com.amazonaws.services.elasticache.model.SecurityGroupMembership extends Object implements Serializable

Serialized Fields

securityGroupId

String securityGroupId

The identifier of the Cache Security Group.

status

String status

The status of the Cache Security Group membership. The status changes whenever a Cache Security Group is modified, or when the Cache Security Groups assigned to a Cache Cluster are modified.

Class com.amazonaws.services.elasticache.model.Subnet extends Object implements Serializable

Serialized Fields

subnetIdentifier

String subnetIdentifier

Specifies the unique identifier for the Subnet

subnetAvailabilityZone

AvailabilityZone subnetAvailabilityZone

Specifies the Availability Zone associated with the Subnet

Class com.amazonaws.services.elasticache.model.SubnetInUseException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Package com.amazonaws.services.elasticbeanstalk.model

Class com.amazonaws.services.elasticbeanstalk.model.ApplicationDescription extends Object implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application.

Constraints:
Length: 1 - 100

description

String description

User-defined description of the application.

Constraints:
Length: 0 - 200

dateCreated

Date dateCreated

The date when the application was created.

dateUpdated

Date dateUpdated

The date when the application was last modified.

versions

List<E> versions

The names of the versions for this application.

configurationTemplates

List<E> configurationTemplates

The names of the configuration templates associated with this application.

Class com.amazonaws.services.elasticbeanstalk.model.ApplicationVersionDescription extends Object implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application associated with this release.

Constraints:
Length: 1 - 100

description

String description

The description of this application version.

Constraints:
Length: 0 - 200

versionLabel

String versionLabel

A label uniquely identifying the version for the associated application.

Constraints:
Length: 1 - 100

sourceBundle

S3Location sourceBundle

The location where the source bundle is located for this version.

dateCreated

Date dateCreated

The creation date of the application version.

dateUpdated

Date dateUpdated

The last modified date of the application version.

Class com.amazonaws.services.elasticbeanstalk.model.AutoScalingGroup extends Object implements Serializable

Serialized Fields

name

String name

The name of the AutoScalingGroup .

Class com.amazonaws.services.elasticbeanstalk.model.CheckDNSAvailabilityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cNAMEPrefix

String cNAMEPrefix

The prefix used when this CNAME is reserved.

Constraints:
Length: 4 - 63

Class com.amazonaws.services.elasticbeanstalk.model.CheckDNSAvailabilityResult extends Object implements Serializable

Serialized Fields

available

Boolean available

Indicates if the specified CNAME is available:

true : The CNAME is available.

true : The CNAME is not available.

• true : The CNAME is available.
• false : The CNAME is not available.

fullyQualifiedCNAME

String fullyQualifiedCNAME

The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix.

Constraints:
Length: 1 - 255

Class com.amazonaws.services.elasticbeanstalk.model.ConfigurationOptionDescription extends Object implements Serializable

Serialized Fields

namespace

String namespace

A unique namespace identifying the option's associated AWS resource.

name

String name

The name of the configuration option.

defaultValue

String defaultValue

The default value for this configuration option.

changeSeverity

String changeSeverity

An indication of which action is required if the value for this configuration option changes:

NoInterruption - There is no interruption to the environment or application availability.

RestartEnvironment - The environment is restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.

RestartApplicationServer - The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.

• NoInterruption : There is no interruption to the environment or application availability.
• RestartEnvironment : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.
• RestartApplicationServer : The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.

userDefined

Boolean userDefined

An indication of whether the user defined this configuration option:

true : This configuration option was defined by the user. It is a valid choice for specifying this as an Option to Remove when updating configuration settings.

false : This configuration was not defined by the user.

• true : This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating configuration settings.

• false : This configuration was not defined by the user.

Constraint: You can remove only UserDefined options from a configuration.

Valid Values: true | false

valueType

String valueType

An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:

Scalar : Values for this option are a single selection from the possible values, or a unformatted string or numeric value governed by the MIN/MAX/Regex constraints:

List : Values for this option are multiple selections of the possible values.

Boolean : Values for this option are either true or false .

• Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.
• List : Values for this option are multiple selections from the possible values.
• Boolean : Values for this option are either true or false .

Constraints:
Allowed Values: Scalar, List

valueOptions

List<E> valueOptions

If specified, values for the configuration option are selected from this list.

minValue

Integer minValue

If specified, the configuration option must be a numeric value greater than this value.

maxValue

Integer maxValue

If specified, the configuration option must be a numeric value less than this value.

maxLength

Integer maxLength

If specified, the configuration option must be a string value no longer than this value.

regex

OptionRestrictionRegex regex

If specified, the configuration option must be a string value that satisfies this regular expression.

Class com.amazonaws.services.elasticbeanstalk.model.ConfigurationOptionSetting extends Object implements Serializable

Serialized Fields

namespace

String namespace

A unique namespace identifying the option's associated AWS resource.

optionName

String optionName

The name of the configuration option.

value

String value

The current value for the configuration option.

Class com.amazonaws.services.elasticbeanstalk.model.ConfigurationSettingsDescription extends Object implements Serializable

Serialized Fields

solutionStackName

String solutionStackName

The name of the solution stack this configuration set uses.

Constraints:
Length: 0 - 100

applicationName

String applicationName

The name of the application associated with this configuration set.

Constraints:
Length: 1 - 100

templateName

String templateName

If not null, the name of the configuration template for this configuration set.

Constraints:
Length: 1 - 100

description

String description

Describes this configuration set.

Constraints:
Length: 0 - 200

environmentName

String environmentName

If not null, the name of the environment for this configuration set.

Constraints:
Length: 4 - 23

deploymentStatus

String deploymentStatus

If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:

null: This configuration is not associated with a running environment.

pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.

deployed: This is the configuration that is currently deployed to the associated running environment.

failed: This is a draft configuration, that failed to successfully deploy.

• null: This configuration is not associated with a running environment.
• pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.
• deployed: This is the configuration that is currently deployed to the associated running environment.
• failed: This is a draft configuration that failed to successfully deploy.

Constraints:
Allowed Values: deployed, pending, failed

dateCreated

Date dateCreated

The date (in UTC time) when this configuration set was created.

dateUpdated

Date dateUpdated

The date (in UTC time) when this configuration set was last modified.

optionSettings

List<E> optionSettings

A list of the configuration options and their values in this configuration set.

Class com.amazonaws.services.elasticbeanstalk.model.CreateApplicationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application.

Constraint: This name must be unique within your account. If the specified name already exists, the action returns an InvalidParameterValue error.

Constraints:
Length: 1 - 100

description

String description

Describes the application.

Constraints:
Length: 0 - 200

Class com.amazonaws.services.elasticbeanstalk.model.CreateApplicationResult extends Object implements Serializable

Serialized Fields

application

ApplicationDescription application

The ApplicationDescription of the application.

Class com.amazonaws.services.elasticbeanstalk.model.CreateApplicationVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application. If no application is found with this name, and AutoCreateApplication is false, returns an InvalidParameterValue error.

Constraints:
Length: 1 - 100

versionLabel

String versionLabel

A label identifying this version.

Constraint: Must be unique per application. If an application version already exists with this label for the specified application, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Constraints:
Length: 1 - 100

description

String description

Describes this version.

Constraints:
Length: 0 - 200

sourceBundle

S3Location sourceBundle

The Amazon S3 bucket and key that identify the location of the source bundle for this version.

If data found at the Amazon S3 location exceeds the maximum allowed source bundle size, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Default: If not specified, AWS Elastic Beanstalk uses a sample application. If only partially specified (for example, a bucket is provided but not the key) or if no data is found at the Amazon S3 location, AWS Elastic Beanstalk returns an InvalidParameterCombination error.

autoCreateApplication

Boolean autoCreateApplication

Determines how the system behaves if the specified application for this version does not already exist:

true: Automatically creates the specified application for this version if it does not already exist.

false: Returns an InvalidParameterValue if the specified application for this version does not already exist.

• true : Automatically creates the specified application for this release if it does not already exist.
• false : Throws an InvalidParameterValue if the specified application for this release does not already exist.

Default: false

Valid Values: true | false

Class com.amazonaws.services.elasticbeanstalk.model.CreateApplicationVersionResult extends Object implements Serializable

Serialized Fields

applicationVersion

ApplicationVersionDescription applicationVersion

The ApplicationVersionDescription of the application version.

Class com.amazonaws.services.elasticbeanstalk.model.CreateConfigurationTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Constraints:
Length: 1 - 100

templateName

String templateName

The name of the configuration template.

Constraint: This name must be unique per application.

Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Constraints:
Length: 1 - 100

solutionStackName

String solutionStackName

The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values.

Use ListAvailableSolutionStacks to obtain a list of available solution stacks.

Default: If the SolutionStackName is not specified and the source configuration parameter is blank, AWS Elastic Beanstalk uses the default solution stack.

If not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.

Constraints:
Length: 0 - 100

sourceConfiguration

SourceConfiguration sourceConfiguration

If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.

Values specified in the OptionSettings parameter of this call overrides any values obtained from the SourceConfiguration.

If no configuration template is found, returns an InvalidParameterValue error.

Constraint: If both the solution stack name parameter and the source configuration parameters are specified, the solution stack of the source configuration template must match the specified solution stack name or else AWS Elastic Beanstalk returns an InvalidParameterCombination error.

environmentId

String environmentId

The ID of the environment used with this configuration template.

description

String description

Describes this configuration.

Constraints:
Length: 0 - 200

optionSettings

List<E> optionSettings

If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template.

Class com.amazonaws.services.elasticbeanstalk.model.CreateConfigurationTemplateResult extends Object implements Serializable

Serialized Fields

solutionStackName

String solutionStackName

The name of the solution stack this configuration set uses.

Constraints:
Length: 0 - 100

applicationName

String applicationName

The name of the application associated with this configuration set.

Constraints:
Length: 1 - 100

templateName

String templateName

If not null, the name of the configuration template for this configuration set.

Constraints:
Length: 1 - 100

description

String description

Describes this configuration set.

Constraints:
Length: 0 - 200

environmentName

String environmentName

If not null, the name of the environment for this configuration set.

Constraints:
Length: 4 - 23

deploymentStatus

String deploymentStatus

If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:

null: This configuration is not associated with a running environment.

pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.

deployed: This is the configuration that is currently deployed to the associated running environment.

failed: This is a draft configuration, that failed to successfully deploy.

• null: This configuration is not associated with a running environment.
• pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.
• deployed: This is the configuration that is currently deployed to the associated running environment.
• failed: This is a draft configuration that failed to successfully deploy.

Constraints:
Allowed Values: deployed, pending, failed

dateCreated

Date dateCreated

The date (in UTC time) when this configuration set was created.

dateUpdated

Date dateUpdated

The date (in UTC time) when this configuration set was last modified.

optionSettings

List<E> optionSettings

A list of the configuration options and their values in this configuration set.

Class com.amazonaws.services.elasticbeanstalk.model.CreateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application that contains the version to be deployed.

If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.

Constraints:
Length: 1 - 100

versionLabel

String versionLabel

The name of the application version to deploy.

If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.

Default: If not specified, AWS Elastic Beanstalk attempts to launch the most recently created application version.

Constraints:
Length: 1 - 100

environmentName

String environmentName

A unique name for the deployment environment. Used in the application URL.

Constraint: Must be from 4 to 23 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique in your account. If the specified name already exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.

Constraints:
Length: 4 - 23

templateName

String templateName

The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Condition: You must specify either this parameter or a SolutionStackName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

Constraints:
Length: 1 - 100

solutionStackName

String solutionStackName

This is an alternative to specifying a configuration name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

Constraints:
Length: 0 - 100

cNAMEPrefix

String cNAMEPrefix

If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the environment uses the environment name.

Constraints:
Length: 4 - 63

description

String description

Describes this environment.

Constraints:
Length: 0 - 200

optionSettings

List<E> optionSettings

If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.

optionsToRemove

List<E> optionsToRemove

A list of custom user-defined configuration options to remove from the configuration set for this new environment.

Class com.amazonaws.services.elasticbeanstalk.model.CreateEnvironmentResult extends Object implements Serializable

Serialized Fields

environmentName

String environmentName

The name of this environment.

Constraints:
Length: 4 - 23

environmentId

String environmentId

The ID of this environment.

applicationName

String applicationName

The name of the application associated with this environment.

Constraints:
Length: 1 - 100

versionLabel

String versionLabel

The application version deployed in this environment.

Constraints:
Length: 1 - 100

solutionStackName

String solutionStackName

The name of the SolutionStack deployed with this environment.

Constraints:
Length: 0 - 100

templateName

String templateName

The name of the configuration template used to originally launch this environment.

Constraints:
Length: 1 - 100

description

String description

Describes this environment.

Constraints:
Length: 0 - 200

endpointURL

String endpointURL

The URL to the LoadBalancer for this environment.

cNAME

String cNAME

The URL to the CNAME for this environment.

Constraints:
Length: 1 - 255

dateCreated

Date dateCreated

The creation date for this environment.

dateUpdated

Date dateUpdated

The last modified date for this environment.

status

String status

The current operational status of the environment:

• Launching: Environment is in the process of initial deployment.
• Updating: Environment is in the process of updating its configuration settings or application version.
• Ready: Environment is available to have an action performed on it, such as update or terminate.
• Terminating: Environment is in the shut-down process.
• Terminated: Environment is not running.

Constraints:
Allowed Values: Launching, Updating, Ready, Terminating, Terminated

health

String health

Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

Red : Indicates the environment is not working.

Yellow: Indicates that something is wrong, the application might not be available, but the instances appear running.

Green: Indicates the environment is healthy and fully functional.

• Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
• Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
• Green: Indicates the environment is healthy and fully functional.
• Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.

Default: Grey

Constraints:
Allowed Values: Green, Yellow, Red, Grey

resources

EnvironmentResourcesDescription resources

The description of the AWS resources used by this environment.

Class com.amazonaws.services.elasticbeanstalk.model.CreateStorageLocationRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.elasticbeanstalk.model.CreateStorageLocationResult extends Object implements Serializable

Serialized Fields

s3Bucket

String s3Bucket

The name of the Amazon S3 bucket created.

Constraints:
Length: 0 - 255

Class com.amazonaws.services.elasticbeanstalk.model.DeleteApplicationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application to delete.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.elasticbeanstalk.model.DeleteApplicationVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application to delete releases from.

Constraints:
Length: 1 - 100

versionLabel

String versionLabel

The label of the version to delete.

Constraints:
Length: 1 - 100

deleteSourceBundle

Boolean deleteSourceBundle

Indicates whether to delete the associated source bundle from Amazon S3:

• true: An attempt is made to delete the associated Amazon S3 source bundle specified at time of creation.
• false: No action is taken on the Amazon S3 source bundle specified at time of creation.

Valid Values: true | false

Class com.amazonaws.services.elasticbeanstalk.model.DeleteConfigurationTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application to delete the configuration template from.

Constraints:
Length: 1 - 100

templateName

String templateName

The name of the configuration template to delete.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.elasticbeanstalk.model.DeleteEnvironmentConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application the environment is associated with.

Constraints:
Length: 1 - 100

environmentName

String environmentName

The name of the environment to delete the draft configuration from.

Constraints:
Length: 4 - 23

Class com.amazonaws.services.elasticbeanstalk.model.DescribeApplicationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationNames

List<E> applicationNames

If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeApplicationsResult extends Object implements Serializable

Serialized Fields

applications

List<E> applications

This parameter contains a list of ApplicationDescription.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeApplicationVersionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include ones that are associated with the specified application.

Constraints:
Length: 1 - 100

versionLabels

List<E> versionLabels

If specified, restricts the returned descriptions to only include ones that have the specified version labels.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeApplicationVersionsResult extends Object implements Serializable

Serialized Fields

applicationVersions

List<E> applicationVersions

A list of ApplicationVersionDescription .

Class com.amazonaws.services.elasticbeanstalk.model.DescribeConfigurationOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.

Constraints:
Length: 1 - 100

templateName

String templateName

The name of the configuration template whose configuration options you want to describe.

Constraints:
Length: 1 - 100

environmentName

String environmentName

The name of the environment whose configuration options you want to describe.

Constraints:
Length: 4 - 23

solutionStackName

String solutionStackName

The name of the solution stack whose configuration options you want to describe.

Constraints:
Length: 0 - 100

options

List<E> options

If specified, restricts the descriptions to only the specified options.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeConfigurationOptionsResult extends Object implements Serializable

Serialized Fields

solutionStackName

String solutionStackName

The name of the solution stack these configuration options belong to.

Constraints:
Length: 0 - 100

options

List<E> options

A list of ConfigurationOptionDescription.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeConfigurationSettingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

The application for the environment or configuration template.

Constraints:
Length: 1 - 100

templateName

String templateName

The name of the configuration template to describe.

Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

Constraints:
Length: 1 - 100

environmentName

String environmentName

The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Constraints:
Length: 4 - 23

Class com.amazonaws.services.elasticbeanstalk.model.DescribeConfigurationSettingsResult extends Object implements Serializable

Serialized Fields

configurationSettings

List<E> configurationSettings

A list of ConfigurationSettingsDescription.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentResourcesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

environmentId

String environmentId

The ID of the environment to retrieve AWS resource usage data.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

environmentName

String environmentName

The name of the environment to retrieve AWS resource usage data.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Constraints:
Length: 4 - 23

Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentResourcesResult extends Object implements Serializable

Serialized Fields

environmentResources

EnvironmentResourceDescription environmentResources

A list of EnvironmentResourceDescription.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

Constraints:
Length: 1 - 100

versionLabel

String versionLabel

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

Constraints:
Length: 1 - 100

environmentIds

List<E> environmentIds

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

environmentNames

List<E> environmentNames

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

includeDeleted

Boolean includeDeleted

Indicates whether to include deleted environments:

true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

false: Do not include deleted environments.

includedDeletedBackTo

Date includedDeletedBackTo

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentsResult extends Object implements Serializable

Serialized Fields

environments

List<E> environments

Returns an EnvironmentDescription list.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.

Constraints:
Length: 1 - 100

versionLabel

String versionLabel

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.

Constraints:
Length: 1 - 100

templateName

String templateName

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.

Constraints:
Length: 1 - 100

environmentId

String environmentId

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

environmentName

String environmentName

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

Constraints:
Length: 4 - 23

requestId

String requestId

If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.

severity

String severity

If specified, limits the events returned from this call to include only those with the specified severity or higher.

Constraints:
Allowed Values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

startTime

Date startTime

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.

endTime

Date endTime

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

maxRecords

Integer maxRecords

Specifies the maximum number of events that can be returned, beginning with the most recent event.

Constraints:
Range: 1 - 1000

nextToken

String nextToken

Pagination token. If specified, the events return the next batch of results.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeEventsResult extends Object implements Serializable

Serialized Fields

events

List<E> events

A list of EventDescription.

nextToken

String nextToken

If returned, this indicates that there are more results to obtain. Use this token in the next DescribeEvents call to get the next batch of events.

Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentDescription extends Object implements Serializable

Serialized Fields

environmentName

String environmentName

The name of this environment.

Constraints:
Length: 4 - 23

environmentId

String environmentId

The ID of this environment.

applicationName

String applicationName

The name of the application associated with this environment.

Constraints:
Length: 1 - 100

versionLabel

String versionLabel

The application version deployed in this environment.

Constraints:
Length: 1 - 100

solutionStackName

String solutionStackName

The name of the SolutionStack deployed with this environment.

Constraints:
Length: 0 - 100

templateName

String templateName

The name of the configuration template used to originally launch this environment.

Constraints:
Length: 1 - 100

description

String description

Describes this environment.

Constraints:
Length: 0 - 200

endpointURL

String endpointURL

The URL to the LoadBalancer for this environment.

cNAME

String cNAME

The URL to the CNAME for this environment.

Constraints:
Length: 1 - 255

dateCreated

Date dateCreated

The creation date for this environment.

dateUpdated

Date dateUpdated

The last modified date for this environment.

status

String status

The current operational status of the environment:

• Launching: Environment is in the process of initial deployment.
• Updating: Environment is in the process of updating its configuration settings or application version.
• Ready: Environment is available to have an action performed on it, such as update or terminate.
• Terminating: Environment is in the shut-down process.
• Terminated: Environment is not running.

Constraints:
Allowed Values: Launching, Updating, Ready, Terminating, Terminated

health

String health

Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

Red : Indicates the environment is not working.

Yellow: Indicates that something is wrong, the application might not be available, but the instances appear running.

Green: Indicates the environment is healthy and fully functional.

• Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
• Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
• Green: Indicates the environment is healthy and fully functional.
• Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.

Default: Grey

Constraints:
Allowed Values: Green, Yellow, Red, Grey

resources

EnvironmentResourcesDescription resources

The description of the AWS resources used by this environment.

Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentInfoDescription extends Object implements Serializable

Serialized Fields

infoType

String infoType

The type of information retrieved.

Constraints:
Allowed Values: tail

ec2InstanceId

String ec2InstanceId

The Amazon EC2 Instance ID for this information.

sampleTimestamp

Date sampleTimestamp

The time stamp when this information was retrieved.

message

String message

The retrieved information.

Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentResourceDescription extends Object implements Serializable

Serialized Fields

environmentName

String environmentName

The name of the environment.

Constraints:
Length: 4 - 23

autoScalingGroups

List<E> autoScalingGroups

The AutoScalingGroups used by this environment.

instances

List<E> instances

The Amazon EC2 instances used by this environment.

launchConfigurations

List<E> launchConfigurations

The Auto Scaling launch configurations in use by this environment.

loadBalancers

List<E> loadBalancers

The LoadBalancers in use by this environment.

triggers

List<E> triggers

The AutoScaling triggers in use by this environment.

Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentResourcesDescription extends Object implements Serializable

Serialized Fields

loadBalancer

LoadBalancerDescription loadBalancer

Describes the LoadBalancer.

Class com.amazonaws.services.elasticbeanstalk.model.EventDescription extends Object implements Serializable

Serialized Fields

eventDate

Date eventDate

The date when the event occurred.

message

String message

The event message.

applicationName

String applicationName

The application associated with the event.

Constraints:
Length: 1 - 100

versionLabel

String versionLabel

The release label for the application version associated with this event.

Constraints:
Length: 1 - 100

templateName

String templateName

The name of the configuration associated with this event.

Constraints:
Length: 1 - 100

environmentName

String environmentName

The name of the environment associated with this event.

Constraints:
Length: 4 - 23

requestId

String requestId

The web service request ID for the activity of this event.

severity

String severity

The severity level of this event.

Constraints:
Allowed Values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Class com.amazonaws.services.elasticbeanstalk.model.Instance extends Object implements Serializable

Serialized Fields

id

String id

The ID of the Amazon EC2 instance.

Class com.amazonaws.services.elasticbeanstalk.model.LaunchConfiguration extends Object implements Serializable

Serialized Fields

name

String name

The name of the launch configuration.

Class com.amazonaws.services.elasticbeanstalk.model.ListAvailableSolutionStacksRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.elasticbeanstalk.model.ListAvailableSolutionStacksResult extends Object implements Serializable

Serialized Fields

solutionStacks

List<E> solutionStacks

A list of available solution stacks.

solutionStackDetails

List<E> solutionStackDetails

A list of available solution stacks and their SolutionStackDescription.

Class com.amazonaws.services.elasticbeanstalk.model.Listener extends Object implements Serializable

Serialized Fields

protocol

String protocol

The protocol that is used by the Listener.

port

Integer port

The port that is used by the Listener.

Class com.amazonaws.services.elasticbeanstalk.model.LoadBalancer extends Object implements Serializable

Serialized Fields

name

String name

The name of the LoadBalancer.

Class com.amazonaws.services.elasticbeanstalk.model.LoadBalancerDescription extends Object implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name of the LoadBalancer.

domain

String domain

The domain name of the LoadBalancer.

listeners

List<E> listeners

A list of Listeners used by the LoadBalancer.

Class com.amazonaws.services.elasticbeanstalk.model.OptionRestrictionRegex extends Object implements Serializable

Serialized Fields

pattern

String pattern

The regular expression pattern that a string configuration option value with this restriction must match.

label

String label

A unique name representing this regular expression.

Class com.amazonaws.services.elasticbeanstalk.model.OptionSpecification extends Object implements Serializable

Serialized Fields

namespace

String namespace

A unique namespace identifying the option's associated AWS resource.

optionName

String optionName

The name of the configuration option.

Class com.amazonaws.services.elasticbeanstalk.model.RebuildEnvironmentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

environmentId

String environmentId

The ID of the environment to rebuild.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

environmentName

String environmentName

The name of the environment to rebuild.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Constraints:
Length: 4 - 23

Class com.amazonaws.services.elasticbeanstalk.model.RequestEnvironmentInfoRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

environmentId

String environmentId

The ID of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

environmentName

String environmentName

The name of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Constraints:
Length: 4 - 23

infoType

String infoType

The type of information to request.

Constraints:
Allowed Values: tail

Class com.amazonaws.services.elasticbeanstalk.model.RestartAppServerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

environmentId

String environmentId

The ID of the environment to restart the server for.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

environmentName

String environmentName

The name of the environment to restart the server for.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Constraints:
Length: 4 - 23

Class com.amazonaws.services.elasticbeanstalk.model.RetrieveEnvironmentInfoRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

environmentId

String environmentId

The ID of the data's environment.

If no such environment is found, returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

environmentName

String environmentName

The name of the data's environment.

If no such environment is found, returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Constraints:
Length: 4 - 23

infoType

String infoType

The type of information to retrieve.

Constraints:
Allowed Values: tail

Class com.amazonaws.services.elasticbeanstalk.model.RetrieveEnvironmentInfoResult extends Object implements Serializable

Serialized Fields

environmentInfo

List<E> environmentInfo

The EnvironmentInfoDescription of the environment.

Class com.amazonaws.services.elasticbeanstalk.model.S3Location extends Object implements Serializable

Serialized Fields

s3Bucket

String s3Bucket

The Amazon S3 bucket where the data is located.

Constraints:
Length: 0 - 255

s3Key

String s3Key

The Amazon S3 key where the data is located.

Constraints:
Length: 0 - 1024

Class com.amazonaws.services.elasticbeanstalk.model.S3SubscriptionRequiredException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticbeanstalk.model.SolutionStackDescription extends Object implements Serializable

Serialized Fields

solutionStackName

String solutionStackName

The name of the solution stack.

Constraints:
Length: 0 - 100

permittedFileTypes

List<E> permittedFileTypes

The permitted file types allowed for a solution stack.

Class com.amazonaws.services.elasticbeanstalk.model.SourceBundleDeletionException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticbeanstalk.model.SourceConfiguration extends Object implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application associated with the configuration.

Constraints:
Length: 1 - 100

templateName

String templateName

The name of the configuration template.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.elasticbeanstalk.model.SwapEnvironmentCNAMEsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sourceEnvironmentId

String sourceEnvironmentId

The ID of the source environment.

Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentId, you must specify the DestinationEnvironmentId.

sourceEnvironmentName

String sourceEnvironmentName

The name of the source environment.

Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentName, you must specify the DestinationEnvironmentName.

Constraints:
Length: 4 - 23

destinationEnvironmentId

String destinationEnvironmentId

The ID of the destination environment.

Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentId with the DestinationEnvironmentId.

destinationEnvironmentName

String destinationEnvironmentName

The name of the destination environment.

Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentName with the DestinationEnvironmentName.

Constraints:
Length: 4 - 23

Class com.amazonaws.services.elasticbeanstalk.model.TerminateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

environmentId

String environmentId

The ID of the environment to terminate.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

environmentName

String environmentName

The name of the environment to terminate.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Constraints:
Length: 4 - 23

terminateResources

Boolean terminateResources

Indicates whether the associated AWS resources should shut down when the environment is terminated:

true: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment.

false: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate.

• true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
• false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

For more information, see the AWS Elastic Beanstalk User Guide.

Default: true

Valid Values: true | false

Class com.amazonaws.services.elasticbeanstalk.model.TerminateEnvironmentResult extends Object implements Serializable

Serialized Fields

environmentName

String environmentName

The name of this environment.

Constraints:
Length: 4 - 23

environmentId

String environmentId

The ID of this environment.

applicationName

String applicationName

The name of the application associated with this environment.

Constraints:
Length: 1 - 100

versionLabel

String versionLabel

The application version deployed in this environment.

Constraints:
Length: 1 - 100

solutionStackName

String solutionStackName

The name of the SolutionStack deployed with this environment.

Constraints:
Length: 0 - 100

templateName

String templateName

The name of the configuration template used to originally launch this environment.

Constraints:
Length: 1 - 100

description

String description

Describes this environment.

Constraints:
Length: 0 - 200

endpointURL

String endpointURL

The URL to the LoadBalancer for this environment.

cNAME

String cNAME

The URL to the CNAME for this environment.

Constraints:
Length: 1 - 255

dateCreated

Date dateCreated

The creation date for this environment.

dateUpdated

Date dateUpdated

The last modified date for this environment.

status

String status

The current operational status of the environment:

• Launching: Environment is in the process of initial deployment.
• Updating: Environment is in the process of updating its configuration settings or application version.
• Ready: Environment is available to have an action performed on it, such as update or terminate.
• Terminating: Environment is in the shut-down process.
• Terminated: Environment is not running.

Constraints:
Allowed Values: Launching, Updating, Ready, Terminating, Terminated

health

String health

Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

Red : Indicates the environment is not working.

Yellow: Indicates that something is wrong, the application might not be available, but the instances appear running.

Green: Indicates the environment is healthy and fully functional.

• Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
• Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
• Green: Indicates the environment is healthy and fully functional.
• Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.

Default: Grey

Constraints:
Allowed Values: Green, Yellow, Red, Grey

resources

EnvironmentResourcesDescription resources

The description of the AWS resources used by this environment.

Class com.amazonaws.services.elasticbeanstalk.model.TooManyApplicationsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticbeanstalk.model.TooManyApplicationVersionsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticbeanstalk.model.TooManyBucketsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticbeanstalk.model.TooManyConfigurationTemplatesException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticbeanstalk.model.TooManyEnvironmentsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticbeanstalk.model.Trigger extends Object implements Serializable

Serialized Fields

name

String name

The name of the trigger.

Class com.amazonaws.services.elasticbeanstalk.model.UpdateApplicationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application to update. If no such application is found, UpdateApplication returns an InvalidParameterValue error.

Constraints:
Length: 1 - 100

description

String description

A new description for the application.

Default: If not specified, AWS Elastic Beanstalk does not update the description.

Constraints:
Length: 0 - 200

Class com.amazonaws.services.elasticbeanstalk.model.UpdateApplicationResult extends Object implements Serializable

Serialized Fields

application

ApplicationDescription application

The ApplicationDescription of the application.

Class com.amazonaws.services.elasticbeanstalk.model.UpdateApplicationVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application associated with this version.

If no application is found with this name, UpdateApplication returns an InvalidParameterValue error.

Constraints:
Length: 1 - 100

versionLabel

String versionLabel

The name of the version to update.

If no application version is found with this label, UpdateApplication returns an InvalidParameterValue error.

Constraints:
Length: 1 - 100

description

String description

A new description for this release.

Constraints:
Length: 0 - 200

Class com.amazonaws.services.elasticbeanstalk.model.UpdateApplicationVersionResult extends Object implements Serializable

Serialized Fields

applicationVersion

ApplicationVersionDescription applicationVersion

The ApplicationVersionDescription of the application version.

Class com.amazonaws.services.elasticbeanstalk.model.UpdateConfigurationTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application associated with the configuration template to update.

If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

Constraints:
Length: 1 - 100

templateName

String templateName

The name of the configuration template to update.

If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

Constraints:
Length: 1 - 100

description

String description

A new description for the configuration.

Constraints:
Length: 0 - 200

optionSettings

List<E> optionSettings

A list of configuration option settings to update with the new specified option value.

optionsToRemove

List<E> optionsToRemove

A list of configuration options to remove from the configuration set.

Constraint: You can remove only UserDefined configuration options.

Class com.amazonaws.services.elasticbeanstalk.model.UpdateConfigurationTemplateResult extends Object implements Serializable

Serialized Fields

solutionStackName

String solutionStackName

The name of the solution stack this configuration set uses.

Constraints:
Length: 0 - 100

applicationName

String applicationName

The name of the application associated with this configuration set.

Constraints:
Length: 1 - 100

templateName

String templateName

If not null, the name of the configuration template for this configuration set.

Constraints:
Length: 1 - 100

description

String description

Describes this configuration set.

Constraints:
Length: 0 - 200

environmentName

String environmentName

If not null, the name of the environment for this configuration set.

Constraints:
Length: 4 - 23

deploymentStatus

String deploymentStatus

If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:

null: This configuration is not associated with a running environment.

pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.

deployed: This is the configuration that is currently deployed to the associated running environment.

failed: This is a draft configuration, that failed to successfully deploy.

• null: This configuration is not associated with a running environment.
• pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.
• deployed: This is the configuration that is currently deployed to the associated running environment.
• failed: This is a draft configuration that failed to successfully deploy.

Constraints:
Allowed Values: deployed, pending, failed

dateCreated

Date dateCreated

The date (in UTC time) when this configuration set was created.

dateUpdated

Date dateUpdated

The date (in UTC time) when this configuration set was last modified.

optionSettings

List<E> optionSettings

A list of the configuration options and their values in this configuration set.

Class com.amazonaws.services.elasticbeanstalk.model.UpdateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

environmentId

String environmentId

The ID of the environment to update.

If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

environmentName

String environmentName

The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Constraints:
Length: 4 - 23

versionLabel

String versionLabel

If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.

Constraints:
Length: 1 - 100

templateName

String templateName

If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Constraints:
Length: 1 - 100

description

String description

If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

Constraints:
Length: 0 - 200

optionSettings

List<E> optionSettings

If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

optionsToRemove

List<E> optionsToRemove

A list of custom user-defined configuration options to remove from the configuration set for this environment.

Class com.amazonaws.services.elasticbeanstalk.model.UpdateEnvironmentResult extends Object implements Serializable

Serialized Fields

environmentName

String environmentName

The name of this environment.

Constraints:
Length: 4 - 23

environmentId

String environmentId

The ID of this environment.

applicationName

String applicationName

The name of the application associated with this environment.

Constraints:
Length: 1 - 100

versionLabel

String versionLabel

The application version deployed in this environment.

Constraints:
Length: 1 - 100

solutionStackName

String solutionStackName

The name of the SolutionStack deployed with this environment.

Constraints:
Length: 0 - 100

templateName

String templateName

The name of the configuration template used to originally launch this environment.

Constraints:
Length: 1 - 100

description

String description

Describes this environment.

Constraints:
Length: 0 - 200

endpointURL

String endpointURL

The URL to the LoadBalancer for this environment.

cNAME

String cNAME

The URL to the CNAME for this environment.

Constraints:
Length: 1 - 255

dateCreated

Date dateCreated

The creation date for this environment.

dateUpdated

Date dateUpdated

The last modified date for this environment.

status

String status

The current operational status of the environment:

• Launching: Environment is in the process of initial deployment.
• Updating: Environment is in the process of updating its configuration settings or application version.
• Ready: Environment is available to have an action performed on it, such as update or terminate.
• Terminating: Environment is in the shut-down process.
• Terminated: Environment is not running.

Constraints:
Allowed Values: Launching, Updating, Ready, Terminating, Terminated

health

String health

Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

Red : Indicates the environment is not working.

Yellow: Indicates that something is wrong, the application might not be available, but the instances appear running.

Green: Indicates the environment is healthy and fully functional.

• Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
• Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
• Green: Indicates the environment is healthy and fully functional.
• Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.

Default: Grey

Constraints:
Allowed Values: Green, Yellow, Red, Grey

resources

EnvironmentResourcesDescription resources

The description of the AWS resources used by this environment.

Class com.amazonaws.services.elasticbeanstalk.model.ValidateConfigurationSettingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application that the configuration template or environment belongs to.

Constraints:
Length: 1 - 100

templateName

String templateName

The name of the configuration template to validate the settings against.

Condition: You cannot specify both this and an environment name.

Constraints:
Length: 1 - 100

environmentName

String environmentName

The name of the environment to validate the settings against.

Condition: You cannot specify both this and a configuration template name.

Constraints:
Length: 4 - 23

optionSettings

List<E> optionSettings

A list of the options and desired values to evaluate.

Class com.amazonaws.services.elasticbeanstalk.model.ValidateConfigurationSettingsResult extends Object implements Serializable

Serialized Fields

messages

List<E> messages

A list of ValidationMessage.

Class com.amazonaws.services.elasticbeanstalk.model.ValidationMessage extends Object implements Serializable

Serialized Fields

message

String message

A message describing the error or warning.

severity

String severity

An indication of the severity of this message:

error: This message indicates that this is not a valid setting for an option.

warning: This message is providing information you should take into account.

• error: This message indicates that this is not a valid setting for an option.
• warning: This message is providing information you should take into account.

Constraints:
Allowed Values: error, warning

namespace

String namespace

optionName

String optionName

Package com.amazonaws.services.elasticloadbalancing.model

Class com.amazonaws.services.elasticloadbalancing.model.AppCookieStickinessPolicy extends Object implements Serializable

Serialized Fields

policyName

String policyName

The mnemonic name for the policy being created. The name must be unique within a set of policies for this LoadBalancer.

cookieName

String cookieName

The name of the application cookie used for stickiness.

Class com.amazonaws.services.elasticloadbalancing.model.ApplySecurityGroupsToLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name associated with the LoadBalancer. The name must be unique within the client AWS account.

securityGroups

List<E> securityGroups

A list of security group IDs to associate with your LoadBalancer in VPC. The security group IDs must be provided as the ID and not the security group name (For example, sg-1234).

Class com.amazonaws.services.elasticloadbalancing.model.ApplySecurityGroupsToLoadBalancerResult extends Object implements Serializable

Serialized Fields

securityGroups

List<E> securityGroups

A list of security group IDs associated with your LoadBalancer.

Class com.amazonaws.services.elasticloadbalancing.model.AttachLoadBalancerToSubnetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name associated with the LoadBalancer. The name must be unique within the client AWS account.

subnets

List<E> subnets

A list of subnet IDs to add for the LoadBalancer.

Class com.amazonaws.services.elasticloadbalancing.model.AttachLoadBalancerToSubnetsResult extends Object implements Serializable

Serialized Fields

subnets

List<E> subnets

A list of subnet IDs added for the LoadBalancer.

Class com.amazonaws.services.elasticloadbalancing.model.BackendServerDescription extends Object implements Serializable

Serialized Fields

instancePort

Integer instancePort

Provides the port on which the back-end server is listening.

Constraints:
Range: 1 - 65535

policyNames

List<E> policyNames

Provides a list of policy names enabled for the back-end server.

Class com.amazonaws.services.elasticloadbalancing.model.CertificateNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticloadbalancing.model.ConfigureHealthCheckRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The mnemonic name associated with the LoadBalancer. This name must be unique within the client AWS account.

healthCheck

HealthCheck healthCheck

A structure containing the configuration information for the new healthcheck.

Class com.amazonaws.services.elasticloadbalancing.model.ConfigureHealthCheckResult extends Object implements Serializable

Serialized Fields

healthCheck

HealthCheck healthCheck

The updated healthcheck for the instances.

Class com.amazonaws.services.elasticloadbalancing.model.CreateAppCookieStickinessPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name associated with the LoadBalancer. The name must be unique within the client AWS account.

policyName

String policyName

The name of the policy being created. The name must be unique within the set of policies for this LoadBalancer.

cookieName

String cookieName

Name of the application cookie used for stickiness.

Class com.amazonaws.services.elasticloadbalancing.model.CreateAppCookieStickinessPolicyResult extends Object implements Serializable

Class com.amazonaws.services.elasticloadbalancing.model.CreateLBCookieStickinessPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name associated with the LoadBalancer. The name must be unique within the client AWS account.

policyName

String policyName

The name of the policy being created. The name must be unique within the set of policies for this LoadBalancer.

cookieExpirationPeriod

Long cookieExpirationPeriod

The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the sticky session will last for the duration of the browser session.

Class com.amazonaws.services.elasticloadbalancing.model.CreateLBCookieStickinessPolicyResult extends Object implements Serializable

Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerListenersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name of the new LoadBalancer. The name must be unique within your AWS account.

listeners

List<E> listeners

A list of LoadBalancerPort, InstancePort, Protocol, and SSLCertificateId items.

Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name associated with the LoadBalancer for which the policy is being created. This name must be unique within the client AWS account.

policyName

String policyName

The name of the LoadBalancer policy being created. The name must be unique within the set of policies for this LoadBalancer.

policyTypeName

String policyTypeName

The name of the base policy type being used to create this policy. To get the list of policy types, use the DescribeLoadBalancerPolicyTypes action.

policyAttributes

List<E> policyAttributes

A list of attributes associated with the policy being created.

Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerPolicyResult extends Object implements Serializable

Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name associated with the LoadBalancer. The name must be unique within your set of LoadBalancers.

listeners

List<E> listeners

A list of the following tuples: LoadBalancerPort, InstancePort, and Protocol.

availabilityZones

List<E> availabilityZones

A list of Availability Zones.

At least one Availability Zone must be specified. Specified Availability Zones must be in the same EC2 Region as the LoadBalancer. Traffic will be equally distributed across all zones.

This list can be modified after the creation of the LoadBalancer.

subnets

List<E> subnets

A list of subnet IDs in your VPC to attach to your LoadBalancer.

securityGroups

List<E> securityGroups

The security groups assigned to your LoadBalancer within your VPC.

scheme

String scheme

The type of a LoadBalancer. This option is only available for LoadBalancers attached to a Amazon VPC. By default, Elastic Load Balancer creates an internet-facing load balancer with publicly resolvable DNS name that resolves to public IP addresses. Specify the value internal for this option to create an internal load balancer with a DNS name that resolves to private IP addresses.

Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerResult extends Object implements Serializable

Serialized Fields

dNSName

String dNSName

The DNS name for the LoadBalancer.

Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerListenersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The mnemonic name associated with the LoadBalancer.

loadBalancerPorts

List<E> loadBalancerPorts

The client port number(s) of the LoadBalancerListener(s) to be removed.

Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The mnemonic name associated with the LoadBalancer. The name must be unique within your AWS account.

policyName

String policyName

The mnemonic name for the policy being deleted.

Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerPolicyResult extends Object implements Serializable

Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name associated with the LoadBalancer. The name must be unique within the client AWS account.

Class com.amazonaws.services.elasticloadbalancing.model.DeregisterInstancesFromLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name associated with the LoadBalancer. The name must be unique within the client AWS account.

instances

List<E> instances

A list of EC2 instance IDs consisting of all instances to be deregistered.

Class com.amazonaws.services.elasticloadbalancing.model.DeregisterInstancesFromLoadBalancerResult extends Object implements Serializable

Serialized Fields

instances

List<E> instances

An updated list of remaining instances registered with the LoadBalancer.

Class com.amazonaws.services.elasticloadbalancing.model.DescribeInstanceHealthRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name associated with the LoadBalancer. The name must be unique within the client AWS account.

instances

List<E> instances

A list of instance IDs whose states are being queried.

Class com.amazonaws.services.elasticloadbalancing.model.DescribeInstanceHealthResult extends Object implements Serializable

Serialized Fields

instanceStates

List<E> instanceStates

A list containing health information for the specified instances.

Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The mnemonic name associated with the LoadBalancer. If no name is specified, the operation returns the attributes of either all the sample policies pre-defined by Elastic Load Balancing or the specified sample polices.

policyNames

List<E> policyNames

The names of LoadBalancer policies you've created or Elastic Load Balancing sample policy names.

Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerPoliciesResult extends Object implements Serializable

Serialized Fields

policyDescriptions

List<E> policyDescriptions

A list of policy description structures.

Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerPolicyTypesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyTypeNames

List<E> policyTypeNames

Specifies the name of the policy types. If no names are specified, returns the description of all the policy types defined by Elastic Load Balancing service.

Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerPolicyTypesResult extends Object implements Serializable

Serialized Fields

policyTypeDescriptions

List<E> policyTypeDescriptions

List of policy type description structures of the specified policy type. If no policy type names are specified, returns the description of all the policy types defined by Elastic Load Balancing service.

Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerNames

List<E> loadBalancerNames

A list of names associated with the LoadBalancers at creation time.

marker

String marker

An optional parameter reserved for future use.

Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancersResult extends Object implements Serializable

Serialized Fields

loadBalancerDescriptions

List<E> loadBalancerDescriptions

A list of LoadBalancer description structures.

nextMarker

String nextMarker

An optional parameter reserved for future use.

Class com.amazonaws.services.elasticloadbalancing.model.DetachLoadBalancerFromSubnetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name associated with the LoadBalancer to be detached. The name must be unique within the client AWS account.

subnets

List<E> subnets

A list of subnet IDs to remove from the set of configured subnets for the LoadBalancer.

Class com.amazonaws.services.elasticloadbalancing.model.DetachLoadBalancerFromSubnetsResult extends Object implements Serializable

Serialized Fields

subnets

List<E> subnets

A list of subnet IDs removed from the configured set of subnets for the LoadBalancer.

Class com.amazonaws.services.elasticloadbalancing.model.DisableAvailabilityZonesForLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name associated with the LoadBalancer. The name must be unique within the client AWS account.

availabilityZones

List<E> availabilityZones

A list of Availability Zones to be removed from the LoadBalancer. There must be at least one Availability Zone registered with a LoadBalancer at all times. The client cannot remove all the Availability Zones from a LoadBalancer. Specified Availability Zones must be in the same Region.

Class com.amazonaws.services.elasticloadbalancing.model.DisableAvailabilityZonesForLoadBalancerResult extends Object implements Serializable

Serialized Fields

availabilityZones

List<E> availabilityZones

A list of updated Availability Zones for the LoadBalancer.

Class com.amazonaws.services.elasticloadbalancing.model.DuplicateListenerException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticloadbalancing.model.DuplicateLoadBalancerNameException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticloadbalancing.model.DuplicatePolicyNameException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticloadbalancing.model.EnableAvailabilityZonesForLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name associated with the LoadBalancer. The name must be unique within the client AWS account.

availabilityZones

List<E> availabilityZones

A list of new Availability Zones for the LoadBalancer. Each Availability Zone must be in the same Region as the LoadBalancer.

Class com.amazonaws.services.elasticloadbalancing.model.EnableAvailabilityZonesForLoadBalancerResult extends Object implements Serializable

Serialized Fields

availabilityZones

List<E> availabilityZones

An updated list of Availability Zones for the LoadBalancer.

Class com.amazonaws.services.elasticloadbalancing.model.HealthCheck extends Object implements Serializable

Serialized Fields

target

String target

Specifies the instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case a healthcheck simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

SSL is also specified as SSL: port pair, for example, SSL:5000.

For HTTP or HTTPS protocol, the situation is different. You have to include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.

The total length of the HTTP ping target needs to be 1024 16-bit Unicode characters or less.

interval

Integer interval

Specifies the approximate interval, in seconds, between health checks of an individual instance.

Constraints:
Range: 1 - 300

timeout

Integer timeout

Specifies the amount of time, in seconds, during which no response means a failed health probe. This value must be less than the Interval value.

Constraints:
Range: 1 - 300

unhealthyThreshold

Integer unhealthyThreshold

Specifies the number of consecutive health probe failures required before moving the instance to the Unhealthy state.

Constraints:
Range: 2 - 10

healthyThreshold

Integer healthyThreshold

Specifies the number of consecutive health probe successes required before moving the instance to the Healthy state.

Constraints:
Range: 2 - 10

Class com.amazonaws.services.elasticloadbalancing.model.Instance extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

Provides an EC2 instance ID.

Class com.amazonaws.services.elasticloadbalancing.model.InstanceState extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

Provides an EC2 instance ID.

state

String state

Specifies the current status of the instance.

reasonCode

String reasonCode

Provides information about the cause of OutOfService instances. Specifically, it indicates whether the cause is Elastic Load Balancing or the instance behind the LoadBalancer.

description

String description

Provides a description of the instance.

Class com.amazonaws.services.elasticloadbalancing.model.InvalidConfigurationRequestException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticloadbalancing.model.InvalidInstanceException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticloadbalancing.model.InvalidSchemeException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticloadbalancing.model.InvalidSecurityGroupException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticloadbalancing.model.InvalidSubnetException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticloadbalancing.model.LBCookieStickinessPolicy extends Object implements Serializable

Serialized Fields

policyName

String policyName

The name for the policy being created. The name must be unique within the set of policies for this LoadBalancer.

cookieExpirationPeriod

Long cookieExpirationPeriod

The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the stickiness session will last for the duration of the browser session.

Class com.amazonaws.services.elasticloadbalancing.model.Listener extends Object implements Serializable

Serialized Fields

protocol

String protocol

Specifies the LoadBalancer transport protocol to use for routing - HTTP, HTTPS, TCP or SSL. This property cannot be modified for the life of the LoadBalancer.

loadBalancerPort

Integer loadBalancerPort

Specifies the external LoadBalancer port number. This property cannot be modified for the life of the LoadBalancer.

instanceProtocol

String instanceProtocol

Specifies the protocol to use for routing traffic to back-end instances - HTTP, HTTPS, TCP, or SSL. This property cannot be modified for the life of the LoadBalancer. If the front-end protocol is HTTP or HTTPS, InstanceProtocol has to be at the same protocol layer, i.e., HTTP or HTTPS. Likewise, if the front-end protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL. If there is another listener with the same InstancePort whose InstanceProtocol is secure, i.e., HTTPS or SSL, the listener's InstanceProtocol has to be secure, i.e., HTTPS or SSL. If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be either HTTP or TCP.

instancePort

Integer instancePort

Specifies the TCP port on which the instance server is listening. This property cannot be modified for the life of the LoadBalancer.

Constraints:
Range: 1 - 65535

sSLCertificateId

String sSLCertificateId

The ARN string of the server certificate. To get the ARN of the server certificate, call the AWS Identity and Access Management UploadServerCertificate API.

Class com.amazonaws.services.elasticloadbalancing.model.ListenerDescription extends Object implements Serializable

Serialized Fields

listener

Listener listener

The Listener data type.

policyNames

List<E> policyNames

A list of policies enabled for this listener. An empty list indicates that no policies are enabled.

Class com.amazonaws.services.elasticloadbalancing.model.ListenerNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticloadbalancing.model.LoadBalancerDescription extends Object implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

Specifies the name associated with the LoadBalancer.

dNSName

String dNSName

Specifies the external DNS name associated with the LoadBalancer.

canonicalHostedZoneName

String canonicalHostedZoneName

Provides the name of the Amazon Route 53 hosted zone that is associated with the LoadBalancer. For information on how to associate your load balancer with a hosted zone, go to Using Domain Names With Elastic Load Balancing in the Elastic Load Balancing Developer Guide.

canonicalHostedZoneNameID

String canonicalHostedZoneNameID

Provides the ID of the Amazon Route 53 hosted zone name that is associated with the LoadBalancer. For information on how to associate or disassociate your load balancer with a hosted zone, go to Using Domain Names With Elastic Load Balancing in the Elastic Load Balancing Developer Guide.

listenerDescriptions

List<E> listenerDescriptions

LoadBalancerPort, InstancePort, Protocol, InstanceProtocol, and PolicyNames are returned in a list of tuples in the ListenerDescriptions element.

policies

Policies policies

Provides a list of policies defined for the LoadBalancer.

backendServerDescriptions

List<E> backendServerDescriptions

Contains a list of back-end server descriptions.

availabilityZones

List<E> availabilityZones

Specifies a list of Availability Zones.

subnets

List<E> subnets

Provides a list of VPC subnet IDs for the LoadBalancer.

vPCId

String vPCId

Provides the ID of the VPC attached to the LoadBalancer.

instances

List<E> instances

Provides a list of EC2 instance IDs for the LoadBalancer.

healthCheck

HealthCheck healthCheck

Specifies information regarding the various health probes conducted on the LoadBalancer.

sourceSecurityGroup

SourceSecurityGroup sourceSecurityGroup

The security group that you can use as part of your inbound rules for your LoadBalancer's back-end Amazon EC2 application instances. To only allow traffic from LoadBalancers, add a security group rule to your back end instance that specifies this source security group as the inbound source.

securityGroups

List<E> securityGroups

The security groups the LoadBalancer is a member of (VPC only).

createdTime

Date createdTime

Provides the date and time the LoadBalancer was created.

scheme

String scheme

Specifies the type of a load balancer. If it is internet-facing, the load balancer has a publicly resolvable DNS name that resolves to public IP addresses. If it is internal, the load balancer has a publicly resolvable DNS name that resolves to private IP addresses. This option is only available for load balancers attached to a VPC.

Class com.amazonaws.services.elasticloadbalancing.model.LoadBalancerNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticloadbalancing.model.Policies extends Object implements Serializable

Serialized Fields

appCookieStickinessPolicies

List<E> appCookieStickinessPolicies

A list of the AppCookieStickinessPolicy objects created with CreateAppCookieStickinessPolicy.

lBCookieStickinessPolicies

List<E> lBCookieStickinessPolicies

A list of LBCookieStickinessPolicy objects created with CreateAppCookieStickinessPolicy.

otherPolicies

List<E> otherPolicies

A list of policy names other than the stickiness policies.

Class com.amazonaws.services.elasticloadbalancing.model.PolicyAttribute extends Object implements Serializable

Serialized Fields

attributeName

String attributeName

The name of the attribute associated with the policy.

attributeValue

String attributeValue

The value of the attribute associated with the policy.

Class com.amazonaws.services.elasticloadbalancing.model.PolicyAttributeDescription extends Object implements Serializable

Serialized Fields

attributeName

String attributeName

The name of the attribute associated with the policy.

attributeValue

String attributeValue

The value of the attribute associated with the policy.

Class com.amazonaws.services.elasticloadbalancing.model.PolicyAttributeTypeDescription extends Object implements Serializable

Serialized Fields

attributeName

String attributeName

The name of the attribute associated with the policy type.

attributeType

String attributeType

The type of attribute. For example, Boolean, Integer, etc.

description

String description

A human-readable description of the attribute.

defaultValue

String defaultValue

The default value of the attribute, if applicable.

cardinality

String cardinality

The cardinality of the attribute. Valid Values:

• ONE(1) : Single value required
• ZERO_OR_ONE(0..1) : Up to one value can be supplied
• ZERO_OR_MORE(0..*) : Optional. Multiple values are allowed
• ONE_OR_MORE(1..*0) : Required. Multiple values are allowed

Class com.amazonaws.services.elasticloadbalancing.model.PolicyDescription extends Object implements Serializable

Serialized Fields

policyName

String policyName

The name mof the policy associated with the LoadBalancer.

policyTypeName

String policyTypeName

The name of the policy type associated with the LoadBalancer.

policyAttributeDescriptions

List<E> policyAttributeDescriptions

A list of policy attribute description structures.

Class com.amazonaws.services.elasticloadbalancing.model.PolicyNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticloadbalancing.model.PolicyTypeDescription extends Object implements Serializable

Serialized Fields

policyTypeName

String policyTypeName

The name of the policy type.

description

String description

A human-readable description of the policy type.

policyAttributeTypeDescriptions

List<E> policyAttributeTypeDescriptions

The description of the policy attributes associated with the LoadBalancer policies defined by the Elastic Load Balancing service.

Class com.amazonaws.services.elasticloadbalancing.model.PolicyTypeNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticloadbalancing.model.RegisterInstancesWithLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name associated with the LoadBalancer. The name must be unique within the client AWS account.

instances

List<E> instances

A list of instance IDs that should be registered with the LoadBalancer. When the instance is stopped and then restarted, the IP addresses associated with your instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to your instances. We recommend that you de-register your Amazon EC2 instances from your load balancer after you stop your instance, and then register the load balancer with your instance after you've restarted. To de-register your instances from load balancer, use DeregisterInstancesFromLoadBalancer action.

Class com.amazonaws.services.elasticloadbalancing.model.RegisterInstancesWithLoadBalancerResult extends Object implements Serializable

Serialized Fields

instances

List<E> instances

An updated list of instances for the LoadBalancer.

Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerListenerSSLCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name of the the LoadBalancer.

loadBalancerPort

Integer loadBalancerPort

The port that uses the specified SSL certificate.

sSLCertificateId

String sSLCertificateId

The ID of the SSL certificate chain to use. For more information on SSL certificates, see Managing Server Certificates in the AWS Identity and Access Management documentation.

Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerPoliciesForBackendServerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The mnemonic name associated with the LoadBalancer. This name must be unique within the client AWS account.

instancePort

Integer instancePort

The port number associated with the back-end server.

policyNames

List<E> policyNames

List of policy names to be set. If the list is empty, then all current polices are removed from the back-end server.

Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerPoliciesForBackendServerResult extends Object implements Serializable

Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerPoliciesOfListenerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name associated with the LoadBalancer. The name must be unique within the client AWS account.

loadBalancerPort

Integer loadBalancerPort

The external port of the LoadBalancer with which this policy applies to.

policyNames

List<E> policyNames

List of policies to be associated with the listener. Currently this list can have at most one policy. If the list is empty, the current policy is removed from the listener.

Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerPoliciesOfListenerResult extends Object implements Serializable

Class com.amazonaws.services.elasticloadbalancing.model.SourceSecurityGroup extends Object implements Serializable

Serialized Fields

ownerAlias

String ownerAlias

Owner of the source security group. Use this value for the --source-group-user parameter of the ec2-authorize command in the Amazon EC2 command line tool.

groupName

String groupName

Name of the source security group. Use this value for the --source-group parameter of the ec2-authorize command in the Amazon EC2 command line tool.

Class com.amazonaws.services.elasticloadbalancing.model.SubnetNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticloadbalancing.model.TooManyLoadBalancersException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticloadbalancing.model.TooManyPoliciesException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Package com.amazonaws.services.elasticmapreduce.model

Class com.amazonaws.services.elasticmapreduce.model.AddInstanceGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceGroups

List<E> instanceGroups

Instance Groups to add.

jobFlowId

String jobFlowId

Job flow in which to add the instance groups.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.elasticmapreduce.model.AddInstanceGroupsResult extends Object implements Serializable

Serialized Fields

jobFlowId

String jobFlowId

The job flow ID in which the instance groups are added.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

instanceGroupIds

List<E> instanceGroupIds

Instance group IDs of the newly created instance groups.

Class com.amazonaws.services.elasticmapreduce.model.AddJobFlowStepsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobFlowId

String jobFlowId

A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

steps

List<E> steps

A list of StepConfig to be executed by the job flow.

Class com.amazonaws.services.elasticmapreduce.model.BootstrapActionConfig extends Object implements Serializable

Serialized Fields

name

String name

The name of the bootstrap action.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

scriptBootstrapAction

ScriptBootstrapActionConfig scriptBootstrapAction

The script run by the bootstrap action.

Class com.amazonaws.services.elasticmapreduce.model.BootstrapActionDetail extends Object implements Serializable

Serialized Fields

bootstrapActionConfig

BootstrapActionConfig bootstrapActionConfig

A description of the bootstrap action.

Class com.amazonaws.services.elasticmapreduce.model.DescribeJobFlowsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

createdAfter

Date createdAfter

Return only job flows created after this date and time.

createdBefore

Date createdBefore

Return only job flows created before this date and time.

jobFlowIds

List<E> jobFlowIds

Return only job flows whose job flow ID is contained in this list.

jobFlowStates

List<E> jobFlowStates

Return only job flows whose state is contained in this list.

Class com.amazonaws.services.elasticmapreduce.model.DescribeJobFlowsResult extends Object implements Serializable

Serialized Fields

jobFlows

List<E> jobFlows

A list of job flows matching the parameters supplied.

Class com.amazonaws.services.elasticmapreduce.model.HadoopJarStepConfig extends Object implements Serializable

Serialized Fields

properties

List<E> properties

A list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.

jar

String jar

A path to a JAR file run during the step.

Constraints:
Length: 0 - 10280
Pattern: [ -??-??-?\r\n\t]*

mainClass

String mainClass

The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class in its manifest file.

Constraints:
Length: 0 - 10280
Pattern: [ -??-??-?\r\n\t]*

args

List<E> args

A list of command line arguments passed to the JAR file's main function when executed.

Class com.amazonaws.services.elasticmapreduce.model.InstanceGroupConfig extends Object implements Serializable

Serialized Fields

name

String name

Friendly name given to the instance group.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

market

String market

Market type of the Amazon EC2 instances used to create a cluster node.

Constraints:
Allowed Values: ON_DEMAND, SPOT

instanceRole

String instanceRole

The role of the instance group in the cluster.

Constraints:
Allowed Values: MASTER, CORE, TASK

bidPrice

String bidPrice

Bid price for each Amazon EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

instanceType

String instanceType

The Amazon EC2 instance type for all instances in the instance group.

Constraints:
Length: 1 - 256
Pattern: [ -??-??-?\r\n\t]*

instanceCount

Integer instanceCount

Target number of instances for the instance group.

Class com.amazonaws.services.elasticmapreduce.model.InstanceGroupDetail extends Object implements Serializable

Serialized Fields

instanceGroupId

String instanceGroupId

Unique identifier for the instance group.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

name

String name

Friendly name for the instance group.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

market

String market

Market type of the Amazon EC2 instances used to create a cluster node.

Constraints:
Allowed Values: ON_DEMAND, SPOT

instanceRole

String instanceRole

Instance group role in the cluster

Constraints:
Allowed Values: MASTER, CORE, TASK

bidPrice

String bidPrice

Bid price for EC2 Instances when launching nodes as Spot Instances, expressed in USD.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

instanceType

String instanceType

Amazon EC2 Instance type.

Constraints:
Length: 1 - 256
Pattern: [ -??-??-?\r\n\t]*

instanceRequestCount

Integer instanceRequestCount

Target number of instances to run in the instance group.

instanceRunningCount

Integer instanceRunningCount

Actual count of running instances.

state

String state

State of instance group. The following values are deprecated: STARTING, TERMINATED, and FAILED.

Constraints:
Allowed Values: PROVISIONING, STARTING, BOOTSTRAPPING, RUNNING, RESIZING, ARRESTED, SHUTTING_DOWN, TERMINATED, FAILED, ENDED

lastStateChangeReason

String lastStateChangeReason

Details regarding the state of the instance group.

Constraints:
Length: 0 - 10280
Pattern: [ -??-??-?\r\n\t]*

creationDateTime

Date creationDateTime

The date/time the instance group was created.

startDateTime

Date startDateTime

The date/time the instance group was started.

readyDateTime

Date readyDateTime

The date/time the instance group was available to the cluster.

endDateTime

Date endDateTime

The date/time the instance group was terminated.

Class com.amazonaws.services.elasticmapreduce.model.InstanceGroupModifyConfig extends Object implements Serializable

Serialized Fields

instanceGroupId

String instanceGroupId

Unique ID of the instance group to expand or shrink.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

instanceCount

Integer instanceCount

Target size for the instance group.

Class com.amazonaws.services.elasticmapreduce.model.InternalServerErrorException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elasticmapreduce.model.JobFlowDetail extends Object implements Serializable

Serialized Fields

jobFlowId

String jobFlowId

The job flow identifier.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

name

String name

The name of the job flow.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

logUri

String logUri

The location in Amazon S3 where log files for the job are stored.

Constraints:
Length: 0 - 10280
Pattern: [ -??-??-?\r\n\t]*

amiVersion

String amiVersion

The version of the AMI used to initialize Amazon EC2 instances in the job flow. For a list of AMI versions currently supported by Amazon ElasticMapReduce, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer's Guide.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

executionStatusDetail

JobFlowExecutionStatusDetail executionStatusDetail

Describes the execution status of the job flow.

instances

JobFlowInstancesDetail instances

Describes the Amazon EC2 instances of the job flow.

steps

List<E> steps

A list of steps run by the job flow.

bootstrapActions

List<E> bootstrapActions

A list of the bootstrap actions run by the job flow.

supportedProducts

List<E> supportedProducts

A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.

visibleToAllUsers

Boolean visibleToAllUsers

Specifies whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the job flow. If it is set to false, only the IAM user that created the job flow can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

jobFlowRole

String jobFlowRole

The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.

Constraints:
Length: 0 - 10280
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.elasticmapreduce.model.JobFlowExecutionStatusDetail extends Object implements Serializable

Serialized Fields

state

String state

The state of the job flow.

Constraints:
Allowed Values: COMPLETED, FAILED, TERMINATED, RUNNING, SHUTTING_DOWN, STARTING, WAITING, BOOTSTRAPPING

creationDateTime

Date creationDateTime

The creation date and time of the job flow.

startDateTime

Date startDateTime

The start date and time of the job flow.

readyDateTime

Date readyDateTime

The date and time when the job flow was ready to start running bootstrap actions.

endDateTime

Date endDateTime

The completion date and time of the job flow.

lastStateChangeReason

String lastStateChangeReason

Description of the job flow last changed state.

Constraints:
Length: 0 - 10280
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.elasticmapreduce.model.JobFlowInstancesConfig extends Object implements Serializable

Serialized Fields

masterInstanceType

String masterInstanceType

The EC2 instance type of the master node.

Constraints:
Length: 1 - 256
Pattern: [ -??-??-?\r\n\t]*

slaveInstanceType

String slaveInstanceType

The EC2 instance type of the slave nodes.

Constraints:
Length: 1 - 256
Pattern: [ -??-??-?\r\n\t]*

instanceCount

Integer instanceCount

The number of Amazon EC2 instances used to execute the job flow.

instanceGroups

List<E> instanceGroups

Configuration for the job flow's instance groups.

ec2KeyName

String ec2KeyName

Specifies the name of the Amazon EC2 key pair that can be used to ssh to the master node as the user called "hadoop."

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

placement

PlacementType placement

Specifies the Availability Zone the job flow will run in.

keepJobFlowAliveWhenNoSteps

Boolean keepJobFlowAliveWhenNoSteps

Specifies whether the job flow should terminate after completing all steps.

terminationProtected

Boolean terminationProtected

Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job flow error.

hadoopVersion

String hadoopVersion

Specifies the Hadoop version for the job flow. Valid inputs are "0.18", "0.20", or "0.20.205". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

ec2SubnetId

String ec2SubnetId

To launch the job flow in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the job flow to launch. If you do not specify this value, the job flow is launched in the normal Amazon Web Services cloud, outside of an Amazon VPC.

Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a Amazon VPC.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.elasticmapreduce.model.JobFlowInstancesDetail extends Object implements Serializable

Serialized Fields

masterInstanceType

String masterInstanceType

The Amazon EC2 master node instance type.

Constraints:
Length: 1 - 256
Pattern: [ -??-??-?\r\n\t]*

masterPublicDnsName

String masterPublicDnsName

The DNS name of the master node.

Constraints:
Length: 0 - 10280
Pattern: [ -??-??-?\r\n\t]*

masterInstanceId

String masterInstanceId

The Amazon EC2 instance identifier of the master node.

Constraints:
Length: 0 - 10280
Pattern: [ -??-??-?\r\n\t]*

slaveInstanceType

String slaveInstanceType

The Amazon EC2 slave node instance type.

Constraints:
Length: 1 - 256
Pattern: [ -??-??-?\r\n\t]*

instanceCount

Integer instanceCount

The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and slave node. If the value is greater than 1, one instance is the master node and all others are slave nodes.

instanceGroups

List<E> instanceGroups

Details about the job flow's instance groups.

normalizedInstanceHours

Integer normalizedInstanceHours

An approximation of the cost of the job flow, represented in m1.small/hours. This value is incremented once for every hour an m1.small runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

ec2KeyName

String ec2KeyName

The name of an Amazon EC2 key pair that can be used to ssh to the master node of job flow.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

ec2SubnetId

String ec2SubnetId

For job flows launched within Amazon Virtual Private Cloud, this value specifies the identifier of the subnet where the job flow was launched.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

placement

PlacementType placement

Specifies the Amazon EC2 Availability Zone for the job flow.

keepJobFlowAliveWhenNoSteps

Boolean keepJobFlowAliveWhenNoSteps

Specifies whether or not the job flow should terminate after completing all steps.

terminationProtected

Boolean terminationProtected

Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job flow error.

hadoopVersion

String hadoopVersion

Specifies the Hadoop version for the job flow.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.elasticmapreduce.model.KeyValue extends Object implements Serializable

Serialized Fields

key

String key

The unique identifier of a key value pair.

Constraints:
Length: 0 - 10280
Pattern: [ -??-??-?\r\n\t]*

value

String value

The value part of the identified key.

Constraints:
Length: 0 - 10280
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.elasticmapreduce.model.ModifyInstanceGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceGroups

List<E> instanceGroups

Instance groups to change.

Class com.amazonaws.services.elasticmapreduce.model.PlacementType extends Object implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The Amazon EC2 Availability Zone for the job flow.

Constraints:
Length: 0 - 10280
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.elasticmapreduce.model.RunJobFlowRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

The name of the job flow.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

logUri

String logUri

Specifies the location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.

Constraints:
Length: 0 - 10280
Pattern: [ -??-??-?\r\n\t]*

additionalInfo

String additionalInfo

A JSON string for selecting additional features.

Constraints:
Length: 0 - 10280
Pattern: [ -??-??-?\r\n\t]*

amiVersion

String amiVersion

The version of the Amazon Machine Image (AMI) to use when launching Amazon EC2 instances in the job flow. The following values are valid:

• "latest" (uses the latest AMI)
• The version number of the AMI to use, for example, "2.0"

If this value is not specified, the job flow uses the default of (AMI 1.0, Hadoop 0.18).

If the AMI supports multiple versions of Hadoop (for example, AMI 1.0 supports both Hadoop 0.18 and 0.20) you can use the JobFlowInstancesConfig HadoopVersion parameter to modify the version of Hadoop from the defaults shown above.

For details about the AMI versions currently supported by Amazon ElasticMapReduce, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer's Guide.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

instances

JobFlowInstancesConfig instances

A specification of the number and type of Amazon EC2 instances on which to run the job flow.

steps

List<E> steps

A list of steps to be executed by the job flow.

bootstrapActions

List<E> bootstrapActions

A list of bootstrap actions that will be run before Hadoop is started on the cluster nodes.

supportedProducts

List<E> supportedProducts

A list of strings that indicates third-party software to use with the job flow. For more information, go to Use Third Party Applications with Amazon EMR. Currently supported values are:

• "karmasphere-enterprise-utility" - tag the job flow for management by Karmasphere.
• "mapr-m3" - launch the job flow using MapR M3 Edition.
• "mapr-m5" - launch the job flow using MapR M5 Edition.

visibleToAllUsers

Boolean visibleToAllUsers

Whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the job flow. If it is set to false, only the IAM user that created the job flow can view and manage it.

jobFlowRole

String jobFlowRole

An IAM role for the job flow. The EC2 instances of the job flow assume this role. The default role is EMRJobflowDefault. In order to use the default role, you must have already created it using the CLI.

Constraints:
Length: 0 - 10280
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.elasticmapreduce.model.RunJobFlowResult extends Object implements Serializable

Serialized Fields

jobFlowId

String jobFlowId

An unique identifier for the job flow.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.elasticmapreduce.model.ScriptBootstrapActionConfig extends Object implements Serializable

Serialized Fields

path

String path

Location of the script to run during a bootstrap action. Can be either a location in Amazon S3 or on a local file system.

Constraints:
Length: 0 - 10280
Pattern: [ -??-??-?\r\n\t]*

args

List<E> args

A list of command line arguments to pass to the bootstrap action script.

Class com.amazonaws.services.elasticmapreduce.model.SetTerminationProtectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobFlowIds

List<E> jobFlowIds

A list of strings that uniquely identify the job flows to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .

terminationProtected

Boolean terminationProtected

A Boolean that indicates whether to protect the job flow and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.

Class com.amazonaws.services.elasticmapreduce.model.SetVisibleToAllUsersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobFlowIds

List<E> jobFlowIds

Identifiers of the job flows to receive the new visibility setting.

visibleToAllUsers

Boolean visibleToAllUsers

Whether the specified job flows are visible to all IAM users of the AWS account associated with the job flow. If this value is set to True, all IAM users of that AWS account can view and, if they have the proper IAM policy permissions set, manage the job flows. If it is set to False, only the IAM user that created a job flow can view and manage it.

Class com.amazonaws.services.elasticmapreduce.model.StepConfig extends Object implements Serializable

Serialized Fields

name

String name

The name of the job flow step.

Constraints:
Length: 0 - 256
Pattern: [ -??-??-?\r\n\t]*

actionOnFailure

String actionOnFailure

Specifies the action to take if the job flow step fails.

Constraints:
Allowed Values: TERMINATE_JOB_FLOW, CANCEL_AND_WAIT, CONTINUE

hadoopJarStep

HadoopJarStepConfig hadoopJarStep

Specifies the JAR file used for the job flow step.

Class com.amazonaws.services.elasticmapreduce.model.StepDetail extends Object implements Serializable

Serialized Fields

stepConfig

StepConfig stepConfig

The step configuration.

executionStatusDetail

StepExecutionStatusDetail executionStatusDetail

The description of the step status.

Class com.amazonaws.services.elasticmapreduce.model.StepExecutionStatusDetail extends Object implements Serializable

Serialized Fields

state

String state

The state of the job flow step.

Constraints:
Allowed Values: PENDING, RUNNING, CONTINUE, COMPLETED, CANCELLED, FAILED, INTERRUPTED

creationDateTime

Date creationDateTime

The creation date and time of the step.

startDateTime

Date startDateTime

The start date and time of the step.

endDateTime

Date endDateTime

The completion date and time of the step.

lastStateChangeReason

String lastStateChangeReason

A description of the step's current state.

Constraints:
Length: 0 - 10280
Pattern: [ -??-??-?\r\n\t]*

Class com.amazonaws.services.elasticmapreduce.model.TerminateJobFlowsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobFlowIds

List<E> jobFlowIds

A list of job flows to be shutdown.

Package com.amazonaws.services.elastictranscoder.model

Class com.amazonaws.services.elastictranscoder.model.AccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elastictranscoder.model.AudioParameters extends Object implements Serializable

Serialized Fields

codec

String codec

The audio codec for the output file. This value must be AAC.

Constraints:
Pattern: (^AAC$)|(^vorbis$)

sampleRate

String sampleRate

The sample rate of the audio stream in the output file, in Hertz. Valid values include:

auto, 22050, 32000, 44100, 48000, 96000

If you specify auto, Elastic Transcoder automatically detects the sample rate.

Constraints:
Pattern: (^auto$)|(^22050$)|(^32000$)|(^44100$)|(^48000$)|(^96000$)

bitRate

String bitRate

The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 64 and 320, inclusive.

Constraints:
Pattern: ^\d{1,3}$

channels

String channels

The number of audio channels in the output file. Valid values include:

auto, 0, 1, 2

If you specify auto, Elastic Transcoder automatically detects the number of channels in the input file.

Constraints:
Pattern: (^auto$)|(^0$)|(^1$)|(^2$)

Class com.amazonaws.services.elastictranscoder.model.CancelJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The identifier of the job that you want to delete.

To get a list of the jobs (including their jobId) that have a status of Submitted, use the ListJobsByStatus API action.

Constraints:
Pattern: ^\d{13}-\w{6}$

Class com.amazonaws.services.elastictranscoder.model.CancelJobResult extends Object implements Serializable

Class com.amazonaws.services.elastictranscoder.model.CreateJobOutput extends Object implements Serializable

Serialized Fields

key

String key

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID. If a file with the specified name already exists in the output bucket, the job fails.

Constraints:
Length: 1 - 255

thumbnailPattern

String thumbnailPattern

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.

If you don't want Elastic Transcoder to create thumbnails, specify "".

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:

• {count} (Required): If you want to create thumbnails, you must include {count} in the ThumbnailPattern object. Wherever you specify {count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file. If you specify a literal value and/or {resolution} but you omit {count}, Elastic Transcoder returns a validation error and does not create the job.

• Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern object. For example, you can include them as a file name prefix or as a delimiter between {resolution} and {count}.

• {resolution} (Optional): If you want Elastic Transcoder to include the resolution in the file name, include {resolution} in the ThumbnailPattern object.

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension.

Constraints:
Pattern: (^$)|(^.*\{count\}.*$)

rotate

String rotate

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values: auto, 0, 90, 180, 270. The value auto generally works only if the file that you're transcoding contains rotation metadata.

Constraints:
Pattern: (^auto$)|(^0$)|(^90$)|(^180$)|(^270$)

presetId

String presetId

The Id of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding.

Constraints:
Pattern: ^\d{13}-\w{6}$

segmentDuration

String segmentDuration

If you specify a preset in PresetId for which the value of Container is ts (MPEG-TS), SegmentDuration is the duration of each .ts file in seconds. The range of valid values is 1 to 60 seconds.

Constraints:
Pattern: ^\d{1,5}([.]\d{0,5})?$

Class com.amazonaws.services.elastictranscoder.model.CreateJobPlaylist extends Object implements Serializable

Serialized Fields

name

String name

The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. The name cannot include a / character. If you create more than one master playlist (not recommended), the values of all Name objects must be unique. Elastic Transcoder automatically appends .m3u8 to the file name. If you include .m3u8 in Name, it will appear twice in the file name.

Constraints:
Length: 1 - 255

format

String format

This value must currently be HLSv3.

Constraints:
Pattern: (^HLSv3$)

outputKeys

List<E> outputKeys

For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object. If you include more than one output in a playlist, the value of SegmentDuration for all of the outputs must be the same.

Constraints:
Length: 0 - 30

Class com.amazonaws.services.elastictranscoder.model.CreateJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.

Constraints:
Pattern: ^\d{13}-\w{6}$

input

JobInput input

A section of the request body that provides information about the file that is being transcoded.

output

CreateJobOutput output

outputs

List<E> outputs

A section of the request body that provides information about the transcoded (target) files. We recommend that you use the Outputs syntax instead of the Output syntax.

Constraints:
Length: 0 - 30

outputKeyPrefix

String outputKeyPrefix

The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists.

Constraints:
Length: 1 - 255

playlists

List<E> playlists

If you specify a preset in PresetId for which the value of Container is ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

We recommend that you create only one master playlist. The maximum number of master playlists in a job is 30.

Constraints:
Length: 0 - 30

Class com.amazonaws.services.elastictranscoder.model.CreateJobResult extends Object implements Serializable

Serialized Fields

job

Job job

A section of the response body that provides information about the job that is created.

Class com.amazonaws.services.elastictranscoder.model.CreatePipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters.

Constraints:
Length: 1 - 40

inputBucket

String inputBucket

The Amazon S3 bucket in which you saved the media files that you want to transcode.

Constraints:
Pattern: ^(\w|\.|-){1,255}$

outputBucket

String outputBucket

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.)

Specify this value when all of the following are true:

• You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.
• You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.
• You do not want to specify the permissions that Elastic Transcoder grants to the files. When Elastic Transcoder saves files in OutputBucket, it grants full control over the files only to the AWS account that owns the role that is specified by Role.
• You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.

If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for ContentConfig and ThumbnailConfig instead.

Constraints:
Pattern: ^(\w|\.|-){1,255}$

role

String role

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.

Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$

notifications

Notifications notifications

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

• Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.
• Completed: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
• Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
• Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.

contentConfig

PipelineOutputConfig contentConfig

The optional ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

If you specify values for ContentConfig, you must also specify values for ThumbnailConfig.

If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

• Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.
• Permissions (Optional): The Permissions object specifies which users you want to have access to transcoded files and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.
• Grantee Type: Specify the type of value that appears in the Grantee object:
  • Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content. A canonical user ID is not the same as an AWS account number.
  • Email: The value in the Grantee object is the registered email address of an AWS account.
  • Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.
• Grantee: The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group
• Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. Valid values include:
  • READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.
  • READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.
  • WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.
  • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.
• StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

thumbnailConfig

PipelineOutputConfig thumbnailConfig

The ThumbnailConfig object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

If you specify values for ContentConfig, you must also specify values for ThumbnailConfig even if you don't want to create thumbnails.

If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

• Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.
• Permissions (Optional): The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.
• GranteeType: Specify the type of value that appears in the Grantee object:
  • Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. A canonical user ID is not the same as an AWS account number.
  • Email: The value in the Grantee object is the registered email address of an AWS account.
  • Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.
• Grantee: The AWS user or group that you want to have access to thumbnail files. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.
• Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include:
  • READ: The grantee can read the thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.
  • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
  • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
  • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
• StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.

Class com.amazonaws.services.elastictranscoder.model.CreatePipelineResult extends Object implements Serializable

Serialized Fields

pipeline

Pipeline pipeline

A section of the response body that provides information about the pipeline that is created.

Class com.amazonaws.services.elastictranscoder.model.CreatePresetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

The name of the preset. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints:
Length: 1 - 40

description

String description

A description of the preset.

Constraints:
Length: 0 - 255

container

String container

The container type for the output file. This value must be mp4.

Constraints:
Pattern: (^mp4$)|(^ts$)|(^webm$)

video

VideoParameters video

A section of the request body that specifies the video parameters.

audio

AudioParameters audio

A section of the request body that specifies the audio parameters.

thumbnails

Thumbnails thumbnails

A section of the request body that specifies the thumbnail parameters, if any.

Class com.amazonaws.services.elastictranscoder.model.CreatePresetResult extends Object implements Serializable

Serialized Fields

preset

Preset preset

A section of the response body that provides information about the preset that is created.

warning

String warning

If the preset settings don't comply with the standards for the video codec but Elastic Transcoder created the preset, this message explains the reason the preset settings don't meet the standard. Elastic Transcoder created the preset because the settings might produce acceptable output.

Class com.amazonaws.services.elastictranscoder.model.DeletePipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The identifier of the pipeline that you want to delete.

Constraints:
Pattern: ^\d{13}-\w{6}$

Class com.amazonaws.services.elastictranscoder.model.DeletePipelineResult extends Object implements Serializable

Class com.amazonaws.services.elastictranscoder.model.DeletePresetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The identifier of the preset for which you want to get detailed information.

Constraints:
Pattern: ^\d{13}-\w{6}$

Class com.amazonaws.services.elastictranscoder.model.DeletePresetResult extends Object implements Serializable

Class com.amazonaws.services.elastictranscoder.model.IncompatibleVersionException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elastictranscoder.model.InternalServiceException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elastictranscoder.model.Job extends Object implements Serializable

Serialized Fields

id

String id

The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.

Constraints:
Pattern: ^\d{13}-\w{6}$

pipelineId

String pipelineId

The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.

Constraints:
Pattern: ^\d{13}-\w{6}$

input

JobInput input

A section of the request or response body that provides information about the file that is being transcoded.

output

JobOutput output

If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.

Outputs recommended instead. A section of the request or response body that provides information about the transcoded (target) file.

outputs

List<E> outputs

Information about the output files. We recommend that you use the Outputs syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both the Outputs and Output syntaxes in the same request. You can create a maximum of 30 outputs per job.

If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.

outputKeyPrefix

String outputKeyPrefix

The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists. We recommend that you add a / or some other delimiter to the end of the OutputKeyPrefix.

Constraints:
Length: 1 - 255

playlists

List<E> playlists

Outputs in MPEG-TS format only.If you specify a preset in PresetId for which the value of Container is ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

We recommend that you create only one master playlist. The maximum number of master playlists in a job is 30.

status

String status

The status of the job: Submitted, Progressing, l, Canceled, or Error.

Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)

Class com.amazonaws.services.elastictranscoder.model.JobInput extends Object implements Serializable

Serialized Fields

key

String key

The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID of the pipeline to use for processing the job. The InputBucket object in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.

If the file name includes a prefix, such as cooking/lasagna.mpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

Constraints:
Length: 1 - 255

frameRate

String frameRate

The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the input file, specify auto. If you want to specify the frame rate for the input file, enter one of the following values:

10, 15, 23.97, 24, 25, 29.97, 30, 60

If you specify a value other than auto, Elastic Transcoder disables automatic detection of the frame rate.

Constraints:
Pattern: (^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^60$)

resolution

String resolution

This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.

Constraints:
Pattern: (^auto$)|(^\d{1,5}x\d{1,5}$)

aspectRatio

String aspectRatio

The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of the input file, specify auto. If you want to specify the aspect ratio for the output file, enter one of the following values:

1:1, 4:3, 3:2, 16:9

If you specify a value other than auto, Elastic Transcoder disables automatic detection of the aspect ratio.

Constraints:
Pattern: (^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)

interlaced

String interlaced

Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input file is interlaced, specify auto. If you want to specify whether the input file is interlaced, enter one of the following values:

true, false

If you specify a value other than auto, Elastic Transcoder disables automatic detection of interlacing.

Constraints:
Pattern: (^auto$)|(^true$)|(^false$)

container

String container

The container type for the input file. If you want Elastic Transcoder to automatically detect the container type of the input file, specify auto. If you want to specify the container type for the input file, enter one of the following values:

3gp, asf, avi, divx, flv, mkv, mov, mp4, mpeg, mpeg-ps, mpeg-ts, mxf, ogg, vob, wav, webm

Constraints:
Pattern: (^auto$)|(^3gp$)|(^asf$)|(^avi$)|(^divx$)|(^flv$)|(^mkv$)|(^mov$)|(^mp4$)|(^mpeg$)|(^mpeg-ps$)|(^mpeg-ts$)|(^mxf$)|(^ogg$)|(^ts$)|(^vob$)|(^wav$)|(^webm$)

Class com.amazonaws.services.elastictranscoder.model.JobOutput extends Object implements Serializable

Serialized Fields

id

String id

A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the Output syntax, this value is always 1.

key

String key

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID.

Constraints:
Length: 1 - 255

thumbnailPattern

String thumbnailPattern

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.

If you don't want Elastic Transcoder to create thumbnails, specify "".

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:

• {count} (Required): If you want to create thumbnails, you must include {count} in the ThumbnailPattern object. Wherever you specify {count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file. If you specify a literal value and/or {resolution} but you omit {count}, Elastic Transcoder returns a validation error and does not create the job.

• Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern object. For example, you can include them as a file name prefix or as a delimiter between {resolution} and {count}.

• {resolution} (Optional): If you want Elastic Transcoder to include the resolution in the file name, include {resolution} in the ThumbnailPattern object.

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension.

Constraints:
Pattern: (^$)|(^.*\{count\}.*$)

rotate

String rotate

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values:

auto, 0, 90, 180, 270

The value auto generally works only if the file that you're transcoding contains rotation metadata.

Constraints:
Pattern: (^auto$)|(^0$)|(^90$)|(^180$)|(^270$)

presetId

String presetId

The value of the Id object for the preset that you want to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding. To use a preset that you created, specify the preset ID that Elastic Transcoder returned in the response when you created the preset. You can also use the Elastic Transcoder system presets, which you can get with ListPresets.

Constraints:
Pattern: ^\d{13}-\w{6}$

segmentDuration

String segmentDuration

(Outputs in MPEG-TS format only.If you specify a preset in PresetId for which the value of Containeris ts (MPEG-TS), SegmentDuration is the maximum duration of each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration of the video is not evenly divisible by SegmentDuration, the duration of the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder creates an output-specific playlist for each output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in OutputKeys.

Constraints:
Pattern: ^\d{1,5}([.]\d{0,5})?$

status

String status

The status of one output in a job. If you specified only one output for the job, Outputs:Status is always the same as Job:Status. If you specified more than one output:

• Job:Status and Outputs:Status for all of the outputs is Submitted until Elastic Transcoder starts to process the first output.
• When Elastic Transcoder starts to process the first output, Outputs:Status for that output and Job:Status both change to Progressing. For each output, the value of Outputs:Status remains Submitted until Elastic Transcoder starts to process the output.
• Job:Status remains Progressing until all of the outputs reach a terminal status, either Complete or Error.
• When all of the outputs reach a terminal status, Job:Status changes to Complete only if Outputs:Status for all of the outputs is Complete. If Outputs:Status for one or more outputs is Error, the terminal status for Job:Status is also Error.

The value of Status is one of the following: Submitted, Progressing, Complete, Canceled, or Error.

Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)

statusDetail

String statusDetail

Information that further explains Status.

Constraints:
Length: 0 - 255

duration

Long duration

Duration of the output file, in seconds.

width

Integer width

Specifies the width of the output file in pixels.

height

Integer height

Height of the output file, in pixels.

Class com.amazonaws.services.elastictranscoder.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elastictranscoder.model.ListJobsByPipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The ID of the pipeline for which you want to get job information.

Constraints:
Pattern: ^\d{13}-\w{6}$

ascending

String ascending

To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false.

Constraints:
Pattern: (^true$)|(^false$)

pageToken

String pageToken

When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

Constraints:
Pattern: ^\d{13}-\w{6}$

Class com.amazonaws.services.elastictranscoder.model.ListJobsByPipelineResult extends Object implements Serializable

Serialized Fields

jobs

List<E> jobs

An array of Job objects that are in the specified pipeline.

nextPageToken

String nextPageToken

A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of NextPageToken is null.

Constraints:
Pattern: ^\d{13}-\w{6}$

Class com.amazonaws.services.elastictranscoder.model.ListJobsByStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

status

String status

To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: Submitted, Progressing, Complete, Canceled, or Error.

Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)

ascending

String ascending

To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false.

Constraints:
Pattern: (^true$)|(^false$)

pageToken

String pageToken

When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

Constraints:
Pattern: ^\d{13}-\w{6}$

Class com.amazonaws.services.elastictranscoder.model.ListJobsByStatusResult extends Object implements Serializable

Serialized Fields

jobs

List<E> jobs

An array of Job objects that have the specified status.

nextPageToken

String nextPageToken

A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of NextPageToken is null.

Constraints:
Pattern: ^\d{13}-\w{6}$

Class com.amazonaws.services.elastictranscoder.model.ListPipelinesRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.elastictranscoder.model.ListPipelinesResult extends Object implements Serializable

Serialized Fields

pipelines

List<E> pipelines

An array of Pipeline objects.

Class com.amazonaws.services.elastictranscoder.model.ListPresetsRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.elastictranscoder.model.ListPresetsResult extends Object implements Serializable

Serialized Fields

presets

List<E> presets

An array of Preset objects.

Class com.amazonaws.services.elastictranscoder.model.Notifications extends Object implements Serializable

Serialized Fields

progressing

String progressing

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.

Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)

completed

String completed

The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)

warning

String warning

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)

error

String error

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)

Class com.amazonaws.services.elastictranscoder.model.Permission extends Object implements Serializable

Serialized Fields

granteeType

String granteeType

Constraints:
Pattern: (^Canonical$)|(^Email$)|(^Group$)

grantee

String grantee

Constraints:
Length: 1 - 255

access

List<E> access

Constraints:
Length: 0 - 30

Class com.amazonaws.services.elastictranscoder.model.Pipeline extends Object implements Serializable

Serialized Fields

id

String id

The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

Constraints:
Pattern: ^\d{13}-\w{6}$

arn

String arn

name

String name

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

Constraints:
Length: 1 - 40

status

String status

The current status of the pipeline:

• Active: The pipeline is processing jobs.
• Paused: The pipeline is not currently processing jobs.

Constraints:
Pattern: (^Active$)|(^Paused$)

inputBucket

String inputBucket

The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding.

Constraints:
Pattern: ^(\w|\.|-){1,255}$

outputBucket

String outputBucket

The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify both ContentConfig and ThumbnailConfig.

Constraints:
Pattern: ^(\w|\.|-){1,255}$

role

String role

The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.

Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$

notifications

Notifications notifications

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

• Progressing (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.
• Completed (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
• Warning (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
• Error (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

contentConfig

PipelineOutputConfig contentConfig

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

• Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.
• Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access that you want them to have.
  • GranteeType: The type of value that appears in the Grantee object:
    • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.
    • Email: The registered email address of an AWS account.
    • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.
  • Grantee: The AWS user or group that you want to have access to transcoded files and playlists.
  • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:
    • READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.
    • READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.
    • WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.
    • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.
• StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

thumbnailConfig

PipelineOutputConfig thumbnailConfig

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

• Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.
• Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access that you want them to have.
  • GranteeType: The type of value that appears in the Grantee object:
    • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. A canonical user ID is not the same as an AWS account number.
    • Email: The registered email address of an AWS account.
    • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.
  • Grantee: The AWS user or group that you want to have access to thumbnail files.
  • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:
    • READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
    • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
    • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
    • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
• StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.

Class com.amazonaws.services.elastictranscoder.model.PipelineOutputConfig extends Object implements Serializable

Serialized Fields

bucket

String bucket

Constraints:
Pattern: ^(\w|\.|-){1,255}$

storageClass

String storageClass

Constraints:
Pattern: (^ReducedRedundancy$)|(^Standard$)

permissions

List<E> permissions

Constraints:
Length: 0 - 30

Class com.amazonaws.services.elastictranscoder.model.Playlist extends Object implements Serializable

Serialized Fields

name

String name

Constraints:
Length: 1 - 255

format

String format

Constraints:
Pattern: (^HLSv3$)

outputKeys

List<E> outputKeys

Constraints:
Length: 0 - 30

status

String status

Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)

statusDetail

String statusDetail

Constraints:
Length: 0 - 255

Class com.amazonaws.services.elastictranscoder.model.Preset extends Object implements Serializable

Serialized Fields

id

String id

Identifier for the new preset. You use this value to get settings for the preset or to delete it.

Constraints:
Pattern: ^\d{13}-\w{6}$

name

String name

The name of the preset.

Constraints:
Length: 1 - 40

description

String description

A description of the preset.

Constraints:
Length: 0 - 255

container

String container

The container type for the output file. This value must be mp4.

Constraints:
Pattern: (^mp4$)|(^ts$)|(^webm$)

audio

AudioParameters audio

A section of the response body that provides information about the audio preset values.

video

VideoParameters video

A section of the response body that provides information about the video preset values.

thumbnails

Thumbnails thumbnails

A section of the response body that provides information about the thumbnail preset values, if any.

type

String type

Whether the preset is a default preset provided by Elastic Transcoder (System) or a preset that you have defined (Custom).

Constraints:
Pattern: (^System$)|(^Custom$)

Class com.amazonaws.services.elastictranscoder.model.ReadJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The identifier of the job for which you want to get detailed information.

Constraints:
Pattern: ^\d{13}-\w{6}$

Class com.amazonaws.services.elastictranscoder.model.ReadJobResult extends Object implements Serializable

Serialized Fields

job

Job job

A section of the response body that provides information about the job.

Class com.amazonaws.services.elastictranscoder.model.ReadPipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The identifier of the pipeline to read.

Constraints:
Pattern: ^\d{13}-\w{6}$

Class com.amazonaws.services.elastictranscoder.model.ReadPipelineResult extends Object implements Serializable

Serialized Fields

pipeline

Pipeline pipeline

A section of the response body that provides information about the pipeline.

Class com.amazonaws.services.elastictranscoder.model.ReadPresetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The identifier of the preset for which you want to get detailed information.

Constraints:
Pattern: ^\d{13}-\w{6}$

Class com.amazonaws.services.elastictranscoder.model.ReadPresetResult extends Object implements Serializable

Serialized Fields

preset

Preset preset

A section of the response body that provides information about the preset.

Class com.amazonaws.services.elastictranscoder.model.ResourceInUseException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elastictranscoder.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elastictranscoder.model.TestRoleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

role

String role

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.

Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$

inputBucket

String inputBucket

The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket.

Constraints:
Pattern: ^(\w|\.|-){1,255}$

outputBucket

String outputBucket

The Amazon S3 bucket that Elastic Transcoder will write transcoded media files to. The action attempts to read from this bucket.

Constraints:
Pattern: ^(\w|\.|-){1,255}$

topics

List<E> topics

The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.

Constraints:
Length: 0 - 30

Class com.amazonaws.services.elastictranscoder.model.TestRoleResult extends Object implements Serializable

Serialized Fields

success

String success

If the operation is successful, this value is true; otherwise, the value is false.

Constraints:
Pattern: (^true$)|(^false$)

messages

List<E> messages

If the Success element contains false, this value is an array of one or more error messages that were generated during the test process.

Class com.amazonaws.services.elastictranscoder.model.Thumbnails extends Object implements Serializable

Serialized Fields

format

String format

The format of thumbnails, if any. Valid values are jpg and png.

You specify whether you want Elastic Transcoder to create thumbnails when you create a job.

Constraints:
Pattern: (^jpg$)|(^png$)

interval

String interval

The number of seconds between thumbnails. Specify an integer value.

Constraints:
Pattern: ^\d{1,5}$

resolution

String resolution

To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.

The width and height of thumbnail files in pixels. Specify a value in the format width x height where both values are even integers. The values cannot exceed the width and height that you specified in the Video:Resolution object.

Constraints:
Pattern: ^\d{1,5}x\d{1,5}$

aspectRatio

String aspectRatio

To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.

The aspect ratio of thumbnails. Valid values include:

auto, 1:1, 4:3, 3:2, 16:9

If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the video in the output file.

Constraints:
Pattern: (^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)

maxWidth

String maxWidth

The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 4096.

Constraints:
Pattern: (^auto$)|(^\d{2,4}$)

maxHeight

String maxHeight

The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 3072.

Constraints:
Pattern: (^auto$)|(^\d{2,4}$)

sizingPolicy

String sizingPolicy

Specify one of the following values to control scaling of thumbnails:

• Fit: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding the other value.
• Fill: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings and matches or exceeds the other value. Elastic Transcoder centers the image in thumbnails and then crops in the dimension (if any) that exceeds the maximum value.
• Stretch: Elastic Transcoder stretches thumbnails to match the values that you specified for thumbnail MaxWidth and MaxHeight settings. If the relative proportions of the input video and thumbnails are different, the thumbnails will be distorted.
• Keep: Elastic Transcoder does not scale thumbnails. If either dimension of the input video exceeds the values that you specified for thumbnail MaxWidth and MaxHeight settings, Elastic Transcoder crops the thumbnails.
• ShrinkToFit: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of thumbnail MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.
• ShrinkToFill: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.

Constraints:
Pattern: (^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)

paddingPolicy

String paddingPolicy

When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that you specified for thumbnail MaxWidth and MaxHeight settings.

Constraints:
Pattern: (^Pad$)|(^NoPad$)

Class com.amazonaws.services.elastictranscoder.model.UpdatePipelineNotificationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The identifier of the pipeline for which you want to change notification settings.

Constraints:
Pattern: ^\d{13}-\w{6}$

notifications

Notifications notifications

The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

• Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
• Completed: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic.
• Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic.
• Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic.

Class com.amazonaws.services.elastictranscoder.model.UpdatePipelineNotificationsResult extends Object implements Serializable

Serialized Fields

pipeline

Pipeline pipeline

A section of the response body that provides information about the pipeline.

Class com.amazonaws.services.elastictranscoder.model.UpdatePipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

Constraints:
Pattern: ^\d{13}-\w{6}$

name

String name

Constraints:
Length: 1 - 40

inputBucket

String inputBucket

Constraints:
Pattern: ^(\w|\.|-){1,255}$

role

String role

Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$

notifications

Notifications notifications

The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify in order to report job status. To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

contentConfig

PipelineOutputConfig contentConfig

thumbnailConfig

PipelineOutputConfig thumbnailConfig

Class com.amazonaws.services.elastictranscoder.model.UpdatePipelineResult extends Object implements Serializable

Serialized Fields

pipeline

Pipeline pipeline

The pipeline (queue) that is used to manage jobs.

Class com.amazonaws.services.elastictranscoder.model.UpdatePipelineStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The identifier of the pipeline to update.

Constraints:
Pattern: ^\d{13}-\w{6}$

status

String status

The desired status of the pipeline:

• Active: The pipeline is processing jobs.
• Paused: The pipeline is not currently processing jobs.

Constraints:
Pattern: (^Active$)|(^Paused$)

Class com.amazonaws.services.elastictranscoder.model.UpdatePipelineStatusResult extends Object implements Serializable

Serialized Fields

pipeline

Pipeline pipeline

A section of the response body that provides information about the pipeline.

Class com.amazonaws.services.elastictranscoder.model.ValidationException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.elastictranscoder.model.VideoParameters extends Object implements Serializable

Serialized Fields

codec

String codec

The video codec for the output file. Valid values include H.264 and vp8. You can only specify vp8 when the container type is webm.

Constraints:
Pattern: (^H\.264$)|(^vp8$)

codecOptions

Map<K,V> codecOptions

Profile

The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following profiles:

• baseline: The profile most commonly used for videoconferencing and for mobile applications.
• main: The profile used for standard-definition digital TV broadcasts.
• high: The profile used for high-definition digital TV broadcasts and for Blu-ray discs.

Level

The H.264 level that you want to use for the output file. Elastic Transcoder supports the following levels:

1, 1b, 1.1, 1.2, 1.3, 2, 2.1, 2.2, 3, 3.1, 3.2, 4, 4.1

MaxReferenceFrames

The maximum number of previously decoded frames to use as a reference for decoding future frames. Valid values are integers 0 through 16, but we recommend that you not use a value greater than the following:

Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels * Height in pixels)), 16)

where Width in pixels and Height in pixels represent the resolution of the output video and Maximum decoded picture buffer in macroblocks depends on the value of the Level object. (A macroblock is a block of pixels measuring 16x16.)

Note that the calculation for maximum decoded picture buffer, which is similar to the calculation for maximum reference frames, uses macroblocks instead of pixels for the width and height of the video.

To determine the value of maximum decoded picture buffer in macroblocks, see the following list (Level - Maximum decoded picture buffer):

• 1 - 396
• 1b - 396
• 1.1 - 900
• 1.2 - 2376
• 1.3 - 2376
• 2 - 2376
• 2.1 - 4752
• 2.2 - 8100
• 3 - 8100
• 3.1 - 18000
• 3.2 - 20480
• 4 - 32768
• 4.1 - 32768

Constraints:
Length: 0 - 30

keyframesMaxDist

String keyframesMaxDist

The maximum number of frames between key frames. Key frames are fully encoded frames; the frames between key frames are encoded based, in part, on the content of the key frames. The value is an integer formatted as a string; valid values are between 1 and 100000, inclusive. A higher value results in higher compression but may also discernibly decrease video quality.

Constraints:
Pattern: ^\d{1,6}$

fixedGOP

String fixedGOP

Whether to use a fixed value for FixedGOP. Valid values are true and false:

• true: Elastic Transcoder uses the value of KeyframesMaxDist for the distance between key frames (the number of frames in a group of pictures, or GOP).
• false: The distance between key frames can vary.

Constraints:
Pattern: (^true$)|(^false$)

bitRate

String bitRate

The bit rate of the video stream in the output file, in kilobits/second. Valid values depend on the values of Level and Profile. If you specify auto, Elastic Transcoder uses the detected bit rate of the input source. If you specify a value other than auto, we recommend that you specify a value less than or equal to the maximum H.264-compliant value listed for your level and profile:

Level - Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum video bit rate in kilobits/second (high Profile)

• 1 - 64 : 80
• 1b - 128 : 160
• 1.1 - 192 : 240
• 1.2 - 384 : 480
• 1.3 - 768 : 960
• 2 - 2000 : 2500
• 3 - 10000 : 12500
• 3.1 - 14000 : 17500
• 3.2 - 20000 : 25000
• 4 - 20000 : 25000
• 4.1 - 50000 : 62500

Constraints:
Pattern: (^\d{2,5}$)|(^auto$)

frameRate

String frameRate

The frames per second for the video stream in the output file. Valid values include:

auto, 10, 15, 23.97, 24, 25, 29.97, 30, 60

If you specify auto, Elastic Transcoder uses the detected frame rate of the input source. If you specify a frame rate, we recommend that you perform the following calculation:

Frame rate = maximum recommended decoding speed in luma samples/second / (width in pixels * height in pixels)

where:

• width in pixels and height in pixels represent the Resolution of the output video.
• maximum recommended decoding speed in Luma samples/second is less than or equal to the maximum value listed in the following table, based on the value that you specified for Level.

The maximum recommended decoding speed in Luma samples/second for each level is described in the following list (Level - Decoding speed):

• 1 - 380160
• 1b - 380160
• 1.1 - 76800
• 1.2 - 1536000
• 1.3 - 3041280
• 2 - 3041280
• 2.1 - 5068800
• 2.2 - 5184000
• 3 - 10368000
• 3.1 - 27648000
• 3.2 - 55296000
• 4 - 62914560
• 4.1 - 62914560

Constraints:
Pattern: (^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^60$)

resolution

String resolution

To better control resolution and aspect ratio of output videos, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and DisplayAspectRatio instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.

The width and height of the video in the output file, in pixels. Valid values are auto and width x height:

• auto: Elastic Transcoder attempts to preserve the width and height of the input file, subject to the following rules.
• width x height: The width and height of the output video in pixels.

Note the following about specifying the width and height:

• The width must be an even integer between 128 and 4096, inclusive.
• The height must be an even integer between 96 and 3072, inclusive.
• If you specify a resolution that is less than the resolution of the input file, Elastic Transcoder rescales the output file to the lower resolution.
• If you specify a resolution that is greater than the resolution of the input file, Elastic Transcoder rescales the output to the higher resolution.
• We recommend that you specify a resolution for which the product of width and height is less than or equal to the applicable value in the following list (List - Max width x height value):
• 1 - 25344
• 1b - 25344
• 1.1 - 101376
• 1.2 - 101376
• 1.3 - 101376
• 2 - 101376
• 2.1 - 202752
• 2.2 - 404720
• 3 - 404720
• 3.1 - 921600
• 3.2 - 1310720
• 4 - 2097152
• 4.1 - 2097152

Constraints:
Pattern: (^auto$)|(^\d{1,5}x\d{1,5}$)

aspectRatio

String aspectRatio

To better control resolution and aspect ratio of output videos, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and DisplayAspectRatio instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.

The display aspect ratio of the video in the output file. Valid values include:

auto, 1:1, 4:3, 3:2, 16:9

If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the input file.

If you specify an aspect ratio for the output file that differs from aspect ratio of the input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars on the top and bottom) to maintain the aspect ratio of the active region of the video.

Constraints:
Pattern: (^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)

maxWidth

String maxWidth

The maximum width of the output video in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 128 and 4096.

Constraints:
Pattern: (^auto$)|(^\d{2,4}$)

maxHeight

String maxHeight

The maximum height of the output video in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 96 and 3072.

Constraints:
Pattern: (^auto$)|(^\d{2,4}$)

displayAspectRatio

String displayAspectRatio

The value that Elastic Transcoder adds to the metadata in the output file.

Constraints:
Pattern: (^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)

sizingPolicy

String sizingPolicy

Specify one of the following values to control scaling of the output video:

• Fit: Elastic Transcoder scales the output video so it matches the value that you specified in either MaxWidth or MaxHeight without exceeding the other value.
• Fill: Elastic Transcoder scales the output video so it matches the value that you specified in either MaxWidth or MaxHeight and matches or exceeds the other value. Elastic Transcoder centers the output video and then crops it in the dimension (if any) that exceeds the maximum value.
• Stretch: Elastic Transcoder stretches the output video to match the values that you specified for MaxWidth and MaxHeight. If the relative proportions of the input video and the output video are different, the output video will be distorted.
• Keep: Elastic Transcoder does not scale the output video. If either dimension of the input video exceeds the values that you specified for MaxWidth and MaxHeight, Elastic Transcoder crops the output video.
• ShrinkToFit: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the video up.
• ShrinkToFill: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale the video up.

Constraints:
Pattern: (^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)

paddingPolicy

String paddingPolicy

When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of the output video to make the total size of the output video match the values that you specified for MaxWidth and MaxHeight.

Constraints:
Pattern: (^Pad$)|(^NoPad$)

Package com.amazonaws.services.glacier.model

Class com.amazonaws.services.glacier.model.AbortMultipartUploadRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountId

String accountId

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

vaultName

String vaultName

The name of the vault.

uploadId

String uploadId

The upload ID of the multipart upload to delete.

Class com.amazonaws.services.glacier.model.CompleteMultipartUploadRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountId

String accountId

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

vaultName

String vaultName

The name of the vault.

uploadId

String uploadId

The upload ID of the multipart upload.

archiveSize

String archiveSize

The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.

checksum

String checksum

The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon Glacier, Amazon Glacier returns an error and the request fails.

Class com.amazonaws.services.glacier.model.CompleteMultipartUploadResult extends Object implements Serializable

Serialized Fields

location

String location

The relative URI path of the newly added archive resource.

checksum

String checksum

The checksum of the archive computed by Amazon Glacier.

archiveId

String archiveId

The ID of the archive. This value is also included as part of the location.

Class com.amazonaws.services.glacier.model.CreateVaultRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountId

String accountId

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.CreateVaultResult extends Object implements Serializable

Serialized Fields

location

String location

The URI of the vault that was created.

Class com.amazonaws.services.glacier.model.DeleteArchiveRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountId

String accountId

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

vaultName

String vaultName

The name of the vault.

archiveId

String archiveId

The ID of the archive to delete.

Class com.amazonaws.services.glacier.model.DeleteVaultNotificationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountId

String accountId

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.DeleteVaultRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountId

String accountId

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.DescribeJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountId

String accountId

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

vaultName

String vaultName

The name of the vault.

jobId

String jobId

The ID of the job to describe.

Class com.amazonaws.services.glacier.model.DescribeJobResult extends Object implements Serializable

Serialized Fields

jobId

String jobId

An opaque string that identifies an Amazon Glacier job.

jobDescription

String jobDescription

The job description you provided when you initiated the job.

action

String action

The job type. It is either ArchiveRetrieval or InventoryRetrieval.

Constraints:
Allowed Values: ArchiveRetrieval, InventoryRetrieval

archiveId

String archiveId

For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.

vaultARN

String vaultARN

The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.

creationDate

String creationDate

The UTC date when the job was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

completed

Boolean completed

The job status. When a job is completed, you get the job's output.

statusCode

String statusCode

The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

Constraints:
Allowed Values: InProgress, Succeeded, Failed

statusMessage

String statusMessage

A friendly message that describes the job status.

archiveSizeInBytes

Long archiveSizeInBytes

For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.

inventorySizeInBytes

Long inventorySizeInBytes

For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.

sNSTopic

String sNSTopic

An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.

completionDate

String completionDate

The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.

sHA256TreeHash

String sHA256TreeHash

For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

archiveSHA256TreeHash

String archiveSHA256TreeHash

retrievalByteRange

String retrievalByteRange

Class com.amazonaws.services.glacier.model.DescribeVaultOutput extends Object implements Serializable

Serialized Fields

vaultARN

String vaultARN

The Amazon Resource Name (ARN) of the vault.

vaultName

String vaultName

The name of the vault.

creationDate

String creationDate

The UTC date when the vault was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

lastInventoryDate

String lastInventoryDate

The UTC date when Amazon Glacier completed the last vault inventory. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

numberOfArchives

Long numberOfArchives

The number of archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example, if you just created the vault.

sizeInBytes

Long sizeInBytes

Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example, if you just created the vault.

Class com.amazonaws.services.glacier.model.DescribeVaultRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountId

String accountId

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.DescribeVaultResult extends Object implements Serializable

Serialized Fields

vaultARN

String vaultARN

The Amazon Resource Name (ARN) of the vault.

vaultName

String vaultName

The name of the vault.

creationDate

String creationDate

The UTC date when the vault was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

lastInventoryDate

String lastInventoryDate

The UTC date when Amazon Glacier completed the last vault inventory. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

numberOfArchives

Long numberOfArchives

The number of archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example, if you just created the vault.

sizeInBytes

Long sizeInBytes

Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example, if you just created the vault.

Class com.amazonaws.services.glacier.model.GetJobOutputRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountId

String accountId

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

vaultName

String vaultName

The name of the vault.

jobId

String jobId

The job ID whose data is downloaded.

range

String range

The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify "Range: bytes=0-1048575". By default, this operation downloads the entire output.

Class com.amazonaws.services.glacier.model.GetJobOutputResult extends Object implements Serializable

Serialized Fields

body

InputStream body

The job data, either archive data or inventory data.

checksum

String checksum

The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:

• You get the entire range of the archive.
• You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.
• You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.

status

Integer status

The HTTP response code for a job output request. The value depends on whether a range was specified in the request.

contentRange

String contentRange

The range of bytes returned by Amazon Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.

acceptRanges

String acceptRanges

Indicates the range units accepted. For more information, go to RFC2616.

contentType

String contentType

The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.

archiveDescription

String archiveDescription

The description of an archive.

Class com.amazonaws.services.glacier.model.GetVaultNotificationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountId

String accountId

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.GetVaultNotificationsResult extends Object implements Serializable

Serialized Fields

vaultNotificationConfig

VaultNotificationConfig vaultNotificationConfig

Returns the notification configuration set on the vault.

Class com.amazonaws.services.glacier.model.GlacierJobDescription extends Object implements Serializable

Serialized Fields

jobId

String jobId

An opaque string that identifies an Amazon Glacier job.

jobDescription

String jobDescription

The job description you provided when you initiated the job.

action

String action

The job type. It is either ArchiveRetrieval or InventoryRetrieval.

Constraints:
Allowed Values: ArchiveRetrieval, InventoryRetrieval

archiveId

String archiveId

For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.

vaultARN

String vaultARN

The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.

creationDate

String creationDate

The UTC date when the job was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

completed

Boolean completed

The job status. When a job is completed, you get the job's output.

statusCode

String statusCode

The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

Constraints:
Allowed Values: InProgress, Succeeded, Failed

statusMessage

String statusMessage

A friendly message that describes the job status.

archiveSizeInBytes

Long archiveSizeInBytes

For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.

inventorySizeInBytes

Long inventorySizeInBytes

For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.

sNSTopic

String sNSTopic

An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.

completionDate

String completionDate

The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.

sHA256TreeHash

String sHA256TreeHash

For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

archiveSHA256TreeHash

String archiveSHA256TreeHash

retrievalByteRange

String retrievalByteRange

Class com.amazonaws.services.glacier.model.InitiateJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountId

String accountId

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

vaultName

String vaultName

The name of the vault.

jobParameters

JobParameters jobParameters

Provides options for specifying job information.

Class com.amazonaws.services.glacier.model.InitiateJobResult extends Object implements Serializable

Serialized Fields

location

String location

The relative URI path of the job.

jobId

String jobId

The ID of the job.

Class com.amazonaws.services.glacier.model.InitiateMultipartUploadRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountId

String accountId

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

vaultName

String vaultName

The name of the vault.

archiveDescription

String archiveDescription

The archive description that you are uploading in parts.

The part size must be a megabyte (1024 KB) multiplied by a power of 2?????????for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).

partSize

String partSize

The size of each part except the last, in bytes. The last part can be smaller than this part size.

Class com.amazonaws.services.glacier.model.InitiateMultipartUploadResult extends Object implements Serializable

Serialized Fields

location

String location

The relative URI path of the multipart upload ID Amazon Glacier created.

uploadId

String uploadId

The ID of the multipart upload. This value is also included as part of the location.

Class com.amazonaws.services.glacier.model.InvalidParameterValueException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

type

String type

code

String code

Class com.amazonaws.services.glacier.model.JobParameters extends Object implements Serializable

Serialized Fields

format

String format

When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid Values are "CSV" and "JSON".

type

String type

The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid Values are "archive-retrieval" and "inventory-retrieval".

archiveId

String archiveId

The ID of the archive that you want to retrieve. This field is required only if Type is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.

description

String description

The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes?????????specifically, ASCII values 32?????????126 decimal or 0x20?????????0x7E hexadecimal.

sNSTopic

String sNSTopic

The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

retrievalByteRange

String retrievalByteRange

Class com.amazonaws.services.glacier.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

type

String type

code

String code

Class com.amazonaws.services.glacier.model.ListJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountId

String accountId

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

vaultName

String vaultName

The name of the vault.

limit

String limit

Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.

marker

String marker

An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.

statuscode

String statuscode

Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed".

completed

String completed

Specifies the state of the jobs to return. You can specify true or false.

Class com.amazonaws.services.glacier.model.ListJobsResult extends Object implements Serializable

Serialized Fields

jobList

List<E> jobList

A list of job objects. Each job object contains metadata describing the job.

marker

String marker

An opaque string that represents where to continue pagination of the results. You use this value in a new List Jobs request to obtain more jobs in the list. If there are no more jobs, this value is null.

Class com.amazonaws.services.glacier.model.ListMultipartUploadsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountId

String accountId

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

vaultName

String vaultName

The name of the vault.

uploadIdMarker

String uploadIdMarker

An opaque string used for pagination. This value specifies the upload at which the listing of uploads should begin. Get the marker value from a previous List Uploads response. You need only include the marker if you are continuing the pagination of results started in a previous List Uploads request.

limit

String limit

Specifies the maximum number of uploads returned in the response body. If this value is not specified, the List Uploads operation returns up to 1,000 uploads.

Class com.amazonaws.services.glacier.model.ListMultipartUploadsResult extends Object implements Serializable

Serialized Fields

uploadsList

List<E> uploadsList

A list of in-progress multipart uploads.

marker

String marker

An opaque string that represents where to continue pagination of the results. You use the marker in a new List Multipart Uploads request to obtain more uploads in the list. If there are no more uploads, this value is null.

Class com.amazonaws.services.glacier.model.ListPartsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountId

String accountId

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

vaultName

String vaultName

The name of the vault.

uploadId

String uploadId

The upload ID of the multipart upload.

marker

String marker

An opaque string used for pagination. This value specifies the part at which the listing of parts should begin. Get the marker value from the response of a previous List Parts response. You need only include the marker if you are continuing the pagination of results started in a previous List Parts request.

limit

String limit

Specifies the maximum number of parts returned in the response body. If this value is not specified, the List Parts operation returns up to 1,000 uploads.

Class com.amazonaws.services.glacier.model.ListPartsResult extends Object implements Serializable

Serialized Fields

multipartUploadId

String multipartUploadId

The ID of the upload to which the parts are associated.

vaultARN

String vaultARN

The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated.

archiveDescription

String archiveDescription

The description of the archive that was specified in the Initiate Multipart Upload request.

partSizeInBytes

Long partSizeInBytes

The part size in bytes.

creationDate

String creationDate

The UTC time at which the multipart upload was initiated.

parts

List<E> parts

A list of the part sizes of the multipart upload.

marker

String marker

An opaque string that represents where to continue pagination of the results. You use the marker in a new List Parts request to obtain more jobs in the list. If there are no more parts, this value is null.

Class com.amazonaws.services.glacier.model.ListVaultsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountId

String accountId

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

marker

String marker

A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

limit

String limit

The maximum number of items returned in the response. If you don't specify a value, the List Vaults operation returns up to 1,000 items.

Class com.amazonaws.services.glacier.model.ListVaultsResult extends Object implements Serializable

Serialized Fields

vaultList

List<E> vaultList

List of vaults.

marker

String marker

The vault ARN at which to continue pagination of the results. You use the marker in another List Vaults request to obtain more vaults in the list.

Class com.amazonaws.services.glacier.model.MissingParameterValueException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

type

String type

code

String code

Class com.amazonaws.services.glacier.model.PartListElement extends Object implements Serializable

Serialized Fields

rangeInBytes

String rangeInBytes

The byte range of a part, inclusive of the upper value of the range.

sHA256TreeHash

String sHA256TreeHash

The SHA256 tree hash value that Amazon Glacier calculated for the part. This field is never null.

Class com.amazonaws.services.glacier.model.RequestTimeoutException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

type

String type

code

String code

Class com.amazonaws.services.glacier.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

type

String type

code

String code

Class com.amazonaws.services.glacier.model.ServiceUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

type

String type

code

String code

Class com.amazonaws.services.glacier.model.SetVaultNotificationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountId

String accountId

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

vaultName

String vaultName

The name of the vault.

vaultNotificationConfig

VaultNotificationConfig vaultNotificationConfig

Provides options for specifying notification configuration.

Class com.amazonaws.services.glacier.model.UploadArchiveRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contentLength

Long contentLength

vaultName

String vaultName

The name of the vault.

accountId

String accountId

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

archiveDescription

String archiveDescription

The optional description of the archive you are uploading.

checksum

String checksum

The SHA256 checksum (a linear hash) of the payload.

body

InputStream body

The data to upload.

Class com.amazonaws.services.glacier.model.UploadArchiveResult extends Object implements Serializable

Serialized Fields

location

String location

The relative URI path of the newly added archive resource.

checksum

String checksum

The checksum of the archive computed by Amazon Glacier.

archiveId

String archiveId

The ID of the archive. This value is also included as part of the location.

Class com.amazonaws.services.glacier.model.UploadListElement extends Object implements Serializable

Serialized Fields

multipartUploadId

String multipartUploadId

The ID of a multipart upload.

vaultARN

String vaultARN

The Amazon Resource Name (ARN) of the vault that contains the archive.

archiveDescription

String archiveDescription

The description of the archive that was specified in the Initiate Multipart Upload request.

partSizeInBytes

Long partSizeInBytes

The part size, in bytes, specified in the Initiate Multipart Upload request. This is the size of all the parts in the upload except the last part, which may be smaller than this size.

creationDate

String creationDate

The UTC time at which the multipart upload was initiated.

Class com.amazonaws.services.glacier.model.UploadMultipartPartRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountId

String accountId

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

vaultName

String vaultName

The name of the vault.

uploadId

String uploadId

The upload ID of the multipart upload.

checksum

String checksum

The SHA256 tree hash of the data being uploaded.

range

String range

Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*.

body

InputStream body

The data to upload.

Class com.amazonaws.services.glacier.model.UploadMultipartPartResult extends Object implements Serializable

Serialized Fields

checksum

String checksum

The SHA256 tree hash that Amazon Glacier computed for the uploaded part.

Class com.amazonaws.services.glacier.model.VaultNotificationConfig extends Object implements Serializable

Serialized Fields

sNSTopic

String sNSTopic

The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN).

events

List<E> events

A list of one or more events for which Amazon Glacier will send a notification to the specified Amazon SNS topic.

Package com.amazonaws.services.identitymanagement.model

Class com.amazonaws.services.identitymanagement.model.AccessKey extends Object implements Serializable

Serialized Fields

userName

String userName

Name of the user the key is associated with.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

accessKeyId

String accessKeyId

The ID for this access key.

Constraints:
Length: 16 - 32
Pattern: [\w]*

status

String status

The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.

Constraints:
Allowed Values: Active, Inactive

secretAccessKey

String secretAccessKey

The secret key used to sign requests.

createDate

Date createDate

The date when the access key was created.

Class com.amazonaws.services.identitymanagement.model.AccessKeyMetadata extends Object implements Serializable

Serialized Fields

userName

String userName

Name of the user the key is associated with.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

accessKeyId

String accessKeyId

The ID for this access key.

Constraints:
Length: 16 - 32
Pattern: [\w]*

status

String status

The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.

Constraints:
Allowed Values: Active, Inactive

createDate

Date createDate

The date when the access key was created.

Class com.amazonaws.services.identitymanagement.model.AddRoleToInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceProfileName

String instanceProfileName

Name of the instance profile to update.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

roleName

String roleName

Name of the role to add.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.AddUserToGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

Name of the group to update.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

userName

String userName

Name of the user to add.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.ChangePasswordRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

oldPassword

String oldPassword

newPassword

String newPassword

Class com.amazonaws.services.identitymanagement.model.CreateAccessKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

The user name that the new key will belong to.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.CreateAccessKeyResult extends Object implements Serializable

Serialized Fields

accessKey

AccessKey accessKey

Information about the access key.

Class com.amazonaws.services.identitymanagement.model.CreateAccountAliasRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountAlias

String accountAlias

Name of the account alias to create.

Constraints:
Length: 3 - 63
Pattern: ^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$

Class com.amazonaws.services.identitymanagement.model.CreateGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

path

String path

The path to the group. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

This parameter is optional. If it is not included, it defaults to a slash (/).

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

groupName

String groupName

Name of the group to create. Do not include the path in this value.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.CreateGroupResult extends Object implements Serializable

Serialized Fields

group

Group group

Information about the group.

Class com.amazonaws.services.identitymanagement.model.CreateInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceProfileName

String instanceProfileName

Name of the instance profile to create.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

path

String path

The path to the instance profile. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

This parameter is optional. If it is not included, it defaults to a slash (/).

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

Class com.amazonaws.services.identitymanagement.model.CreateInstanceProfileResult extends Object implements Serializable

Serialized Fields

instanceProfile

InstanceProfile instanceProfile

Information about the instance profile.

Class com.amazonaws.services.identitymanagement.model.CreateLoginProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

Name of the user to create a password for.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

password

String password

The new password for the user name.

Constraints:
Length: 1 - 128
Pattern: [ -?]+

Class com.amazonaws.services.identitymanagement.model.CreateLoginProfileResult extends Object implements Serializable

Serialized Fields

loginProfile

LoginProfile loginProfile

The user name and password create date.

Class com.amazonaws.services.identitymanagement.model.CreateRoleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

path

String path

The path to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

This parameter is optional. If it is not included, it defaults to a slash (/).

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

roleName

String roleName

Name of the role to create.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

assumeRolePolicyDocument

String assumeRolePolicyDocument

The policy that grants an entity permission to assume the role.

Constraints:
Length: 1 - 131072
Pattern: [ -?]+

Class com.amazonaws.services.identitymanagement.model.CreateRoleResult extends Object implements Serializable

Serialized Fields

role

Role role

Information about the role.

Class com.amazonaws.services.identitymanagement.model.CreateUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

path

String path

The path for the user name. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

This parameter is optional. If it is not included, it defaults to a slash (/).

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

userName

String userName

Name of the user to create.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.CreateUserResult extends Object implements Serializable

Serialized Fields

user

User user

Information about the user.

Class com.amazonaws.services.identitymanagement.model.CreateVirtualMFADeviceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

path

String path

The path for the virtual MFA device. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

This parameter is optional. If it is not included, it defaults to a slash (/).

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

virtualMFADeviceName

String virtualMFADeviceName

The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device.

Constraints:
Length: 1 -
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.CreateVirtualMFADeviceResult extends Object implements Serializable

Serialized Fields

virtualMFADevice

VirtualMFADevice virtualMFADevice

A newly created virtual MFA device.

Class com.amazonaws.services.identitymanagement.model.DeactivateMFADeviceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

Name of the user whose MFA device you want to deactivate.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

serialNumber

String serialNumber

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*

Class com.amazonaws.services.identitymanagement.model.DeleteAccessKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

Name of the user whose key you want to delete.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

accessKeyId

String accessKeyId

The Access Key ID for the Access Key ID and Secret Access Key you want to delete.

Constraints:
Length: 16 - 32
Pattern: [\w]*

Class com.amazonaws.services.identitymanagement.model.DeleteAccountAliasRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountAlias

String accountAlias

Name of the account alias to delete.

Constraints:
Length: 3 - 63
Pattern: ^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$

Class com.amazonaws.services.identitymanagement.model.DeleteAccountPasswordPolicyRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.identitymanagement.model.DeleteConflictException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.identitymanagement.model.DeleteGroupPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

Name of the group the policy is associated with.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

policyName

String policyName

Name of the policy document to delete.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.DeleteGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

Name of the group to delete.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.DeleteInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceProfileName

String instanceProfileName

Name of the instance profile to delete.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.DeleteLoginProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

Name of the user whose password you want to delete.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.DeleteRolePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

roleName

String roleName

Name of the role the associated with the policy.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

policyName

String policyName

Name of the policy document to delete.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.DeleteRoleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

roleName

String roleName

Name of the role to delete.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.DeleteServerCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serverCertificateName

String serverCertificateName

The name of the server certificate you want to delete.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.DeleteSigningCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

Name of the user the signing certificate belongs to.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

certificateId

String certificateId

ID of the signing certificate to delete.

Constraints:
Length: 24 - 128
Pattern: [\w]*

Class com.amazonaws.services.identitymanagement.model.DeleteUserPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

Name of the user the policy is associated with.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

policyName

String policyName

Name of the policy document to delete.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.DeleteUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

Name of the user to delete.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.DeleteVirtualMFADeviceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serialNumber

String serialNumber

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the same as the ARN.

Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*

Class com.amazonaws.services.identitymanagement.model.DuplicateCertificateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.identitymanagement.model.EnableMFADeviceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

Name of the user for whom you want to enable the MFA device.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

serialNumber

String serialNumber

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*

authenticationCode1

String authenticationCode1

An authentication code emitted by the device.

Constraints:
Length: 6 - 6
Pattern: [\d]*

authenticationCode2

String authenticationCode2

A subsequent authentication code emitted by the device.

Constraints:
Length: 6 - 6
Pattern: [\d]*

Class com.amazonaws.services.identitymanagement.model.EntityAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.identitymanagement.model.EntityTemporarilyUnmodifiableException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.identitymanagement.model.GetAccountPasswordPolicyRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.identitymanagement.model.GetAccountPasswordPolicyResult extends Object implements Serializable

Serialized Fields

passwordPolicy

PasswordPolicy passwordPolicy

The PasswordPolicy data type contains information about the account password policy.

This data type is used as a response element in the action GetAccountPasswordPolicy.

Class com.amazonaws.services.identitymanagement.model.GetAccountSummaryRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.identitymanagement.model.GetAccountSummaryResult extends Object implements Serializable

Serialized Fields

summaryMap

Map<K,V> summaryMap

A set of key value pairs containing account-level information.

SummaryMap contains the following keys:

• AccessKeysPerUserQuota - Maximum number of access keys that can be created per user

• AccountMFAEnabled - 1 if the root account has an MFA device assigned to it, 0 otherwise

• AssumeRolePolicySizeQuota - Maximum allowed size for assume role policy documents (in kilobytes)

• GroupPolicySizeQuota - Maximum allowed size for Group policy documents (in kilobytes)

• Groups - Number of Groups for the AWS account

• GroupsPerUserQuota - Maximum number of groups a user can belong to

• GroupsQuota - Maximum groups allowed for the AWS account

• InstanceProfiles - Number of instance profiles for the AWS account

• InstanceProfilesQuota - Maximum instance profiles allowed for the AWS account

• MFADevices - Number of MFA devices, either assigned or unassigned

• MFADevicesInUse - Number of MFA devices that have been assigned to an IAM user or to the root account

• RolePolicySizeQuota - Maximum allowed size for role policy documents (in kilobytes)

• Roles - Number of roles for the AWS account

• RolesQuota - Maximum roles allowed for the AWS account

• ServerCertificates - Number of server certificates for the AWS account

• ServerCertificatesQuota - Maximum server certificates allowed for the AWS account

• SigningCertificatesPerUserQuota - Maximum number of X509 certificates allowed for a user

• UserPolicySizeQuota - Maximum allowed size for user policy documents (in kilobytes)

• Users - Number of users for the AWS account

• UsersQuota - Maximum users allowed for the AWS account

Class com.amazonaws.services.identitymanagement.model.GetGroupPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

Name of the group the policy is associated with.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

policyName

String policyName

Name of the policy document to get.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.GetGroupPolicyResult extends Object implements Serializable

Serialized Fields

groupName

String groupName

The group the policy is associated with.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

policyName

String policyName

The name of the policy.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

policyDocument

String policyDocument

The policy document.

Constraints:
Length: 1 - 131072
Pattern: [ -?]+

Class com.amazonaws.services.identitymanagement.model.GetGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

Name of the group.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

marker

String marker

Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

maxItems

Integer maxItems

Use this only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true.

Constraints:
Range: 1 - 1000

Class com.amazonaws.services.identitymanagement.model.GetGroupResult extends Object implements Serializable

Serialized Fields

group

Group group

Information about the group.

users

List<E> users

A list of users in the group.

isTruncated

Boolean isTruncated

A flag that indicates whether there are more user names to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more user names in the list.

marker

String marker

If IsTruncated is true, then this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

Class com.amazonaws.services.identitymanagement.model.GetInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceProfileName

String instanceProfileName

Name of the instance profile to get information about.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.GetInstanceProfileResult extends Object implements Serializable

Serialized Fields

instanceProfile

InstanceProfile instanceProfile

Information about the instance profile.

Class com.amazonaws.services.identitymanagement.model.GetLoginProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

Name of the user whose login profile you want to retrieve.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.GetLoginProfileResult extends Object implements Serializable

Serialized Fields

loginProfile

LoginProfile loginProfile

User name and password create date for the user.

Class com.amazonaws.services.identitymanagement.model.GetRolePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

roleName

String roleName

Name of the role associated with the policy.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

policyName

String policyName

Name of the policy document to get.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.GetRolePolicyResult extends Object implements Serializable

Serialized Fields

roleName

String roleName

The role the policy is associated with.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

policyName

String policyName

The name of the policy.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

policyDocument

String policyDocument

The policy document.

Constraints:
Length: 1 - 131072
Pattern: [ -?]+

Class com.amazonaws.services.identitymanagement.model.GetRoleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

roleName

String roleName

Name of the role to get information about.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.GetRoleResult extends Object implements Serializable

Serialized Fields

role

Role role

Information about the role.

Class com.amazonaws.services.identitymanagement.model.GetServerCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serverCertificateName

String serverCertificateName

The name of the server certificate you want to retrieve information about.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.GetServerCertificateResult extends Object implements Serializable

Serialized Fields

serverCertificate

ServerCertificate serverCertificate

Information about the server certificate.

Class com.amazonaws.services.identitymanagement.model.GetUserPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

Name of the user who the policy is associated with.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

policyName

String policyName

Name of the policy document to get.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.GetUserPolicyResult extends Object implements Serializable

Serialized Fields

userName

String userName

The user the policy is associated with.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

policyName

String policyName

The name of the policy.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

policyDocument

String policyDocument

The policy document.

Constraints:
Length: 1 - 131072
Pattern: [ -?]+

Class com.amazonaws.services.identitymanagement.model.GetUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

Name of the user to get information about.

This parameter is optional. If it is not included, it defaults to the user making the request.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.GetUserResult extends Object implements Serializable

Serialized Fields

user

User user

Information about the user.

Class com.amazonaws.services.identitymanagement.model.Group extends Object implements Serializable

Serialized Fields

path

String path

Path to the group. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

groupName

String groupName

The name that identifies the group.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

groupId

String groupId

The stable and unique string identifying the group. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Constraints:
Length: 16 - 32
Pattern: [\w]*

arn

String arn

The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Constraints:
Length: 20 - 2048

createDate

Date createDate

The date when the group was created.

Class com.amazonaws.services.identitymanagement.model.InstanceProfile extends Object implements Serializable

Serialized Fields

path

String path

Path to the instance profile. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

instanceProfileName

String instanceProfileName

The name identifying the instance profile.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

instanceProfileId

String instanceProfileId

The stable and unique string identifying the instance profile. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Constraints:
Length: 16 - 32
Pattern: [\w]*

arn

String arn

The Amazon Resource Name (ARN) specifying the instance profile. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Constraints:
Length: 20 - 2048

createDate

Date createDate

The date when the instance profile was created.

roles

List<E> roles

The role associated with the instance profile.

Class com.amazonaws.services.identitymanagement.model.InvalidAuthenticationCodeException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.identitymanagement.model.InvalidCertificateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.identitymanagement.model.InvalidUserTypeException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.identitymanagement.model.KeyPairMismatchException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.identitymanagement.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.identitymanagement.model.ListAccessKeysRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

Name of the user.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

marker

String marker

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

maxItems

Integer maxItems

Use this parameter only when paginating results to indicate the maximum number of keys you want in the response. If there are additional keys beyond the maximum you specify, the IsTruncated response element is true.

Constraints:
Range: 1 - 1000

Class com.amazonaws.services.identitymanagement.model.ListAccessKeysResult extends Object implements Serializable

Serialized Fields

accessKeyMetadata

List<E> accessKeyMetadata

A list of access key metadata.

isTruncated

Boolean isTruncated

A flag that indicates whether there are more keys to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more keys in the list.

marker

String marker

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

Class com.amazonaws.services.identitymanagement.model.ListAccountAliasesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

marker

String marker

Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

maxItems

Integer maxItems

Use this only when paginating results to indicate the maximum number of account aliases you want in the response. If there are additional account aliases beyond the maximum you specify, the IsTruncated response element is true.

Constraints:
Range: 1 - 1000

Class com.amazonaws.services.identitymanagement.model.ListAccountAliasesResult extends Object implements Serializable

Serialized Fields

accountAliases

List<E> accountAliases

A list of aliases associated with the account.

isTruncated

Boolean isTruncated

A flag that indicates whether there are more account aliases to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more account aliases in the list.

marker

String marker

Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

Class com.amazonaws.services.identitymanagement.model.ListGroupPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

The name of the group to list policies for.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

marker

String marker

Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

maxItems

Integer maxItems

Use this only when paginating results to indicate the maximum number of policy names you want in the response. If there are additional policy names beyond the maximum you specify, the IsTruncated response element is true.

Constraints:
Range: 1 - 1000

Class com.amazonaws.services.identitymanagement.model.ListGroupPoliciesResult extends Object implements Serializable

Serialized Fields

policyNames

List<E> policyNames

A list of policy names.

isTruncated

Boolean isTruncated

A flag that indicates whether there are more policy names to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more policy names in the list.

marker

String marker

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

Class com.amazonaws.services.identitymanagement.model.ListGroupsForUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

The name of the user to list groups for.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

marker

String marker

Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

maxItems

Integer maxItems

Use this only when paginating results to indicate the maximum number of groups you want in the response. If there are additional groups beyond the maximum you specify, the IsTruncated response element is true.

Constraints:
Range: 1 - 1000

Class com.amazonaws.services.identitymanagement.model.ListGroupsForUserResult extends Object implements Serializable

Serialized Fields

groups

List<E> groups

A list of groups.

isTruncated

Boolean isTruncated

A flag that indicates whether there are more groups to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more groups in the list.

marker

String marker

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

Class com.amazonaws.services.identitymanagement.model.ListGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pathPrefix

String pathPrefix

The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all groups whose path starts with /division_abc/subdivision_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups.

Constraints:
Length: 1 - 512
Pattern: /[!-]*

marker

String marker

Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

maxItems

Integer maxItems

Use this only when paginating results to indicate the maximum number of groups you want in the response. If there are additional groups beyond the maximum you specify, the IsTruncated response element is true.

Constraints:
Range: 1 - 1000

Class com.amazonaws.services.identitymanagement.model.ListGroupsResult extends Object implements Serializable

Serialized Fields

groups

List<E> groups

A list of groups.

isTruncated

Boolean isTruncated

A flag that indicates whether there are more groups to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more groups in the list.

marker

String marker

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

Class com.amazonaws.services.identitymanagement.model.ListInstanceProfilesForRoleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

roleName

String roleName

The name of the role to list instance profiles for.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

marker

String marker

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

maxItems

Integer maxItems

Use this parameter only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true.

Constraints:
Range: 1 - 1000

Class com.amazonaws.services.identitymanagement.model.ListInstanceProfilesForRoleResult extends Object implements Serializable

Serialized Fields

instanceProfiles

List<E> instanceProfiles

A list of instance profiles.

isTruncated

Boolean isTruncated

A flag that indicates whether there are more instance profiles to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more instance profiles in the list.

marker

String marker

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

Class com.amazonaws.services.identitymanagement.model.ListInstanceProfilesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pathPrefix

String pathPrefix

The path prefix for filtering the results. For example: /application_abc/component_xyz/, which would get all instance profiles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles.

Constraints:
Length: 1 - 512
Pattern: /[!-]*

marker

String marker

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

maxItems

Integer maxItems

Use this parameter only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true.

Constraints:
Range: 1 - 1000

Class com.amazonaws.services.identitymanagement.model.ListInstanceProfilesResult extends Object implements Serializable

Serialized Fields

instanceProfiles

List<E> instanceProfiles

A list of instance profiles.

isTruncated

Boolean isTruncated

A flag that indicates whether there are more instance profiles to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more instance profiles in the list.

marker

String marker

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

Class com.amazonaws.services.identitymanagement.model.ListMFADevicesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

Name of the user whose MFA devices you want to list.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

marker

String marker

Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

maxItems

Integer maxItems

Use this only when paginating results to indicate the maximum number of MFA devices you want in the response. If there are additional MFA devices beyond the maximum you specify, the IsTruncated response element is true.

Constraints:
Range: 1 - 1000

Class com.amazonaws.services.identitymanagement.model.ListMFADevicesResult extends Object implements Serializable

Serialized Fields

mFADevices

List<E> mFADevices

A list of MFA devices.

isTruncated

Boolean isTruncated

A flag that indicates whether there are more MFA devices to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more MFA devices in the list.

marker

String marker

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

Class com.amazonaws.services.identitymanagement.model.ListRolePoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

roleName

String roleName

The name of the role to list policies for.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

marker

String marker

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

maxItems

Integer maxItems

Use this parameter only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true.

Constraints:
Range: 1 - 1000

Class com.amazonaws.services.identitymanagement.model.ListRolePoliciesResult extends Object implements Serializable

Serialized Fields

policyNames

List<E> policyNames

A list of policy names.

isTruncated

Boolean isTruncated

A flag that indicates whether there are more policy names to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more policy names in the list.

marker

String marker

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

Class com.amazonaws.services.identitymanagement.model.ListRolesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pathPrefix

String pathPrefix

The path prefix for filtering the results. For example: /application_abc/component_xyz/, which would get all roles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles.

Constraints:
Length: 1 - 512
Pattern: /[!-]*

marker

String marker

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

maxItems

Integer maxItems

Use this parameter only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true.

Constraints:
Range: 1 - 1000

Class com.amazonaws.services.identitymanagement.model.ListRolesResult extends Object implements Serializable

Serialized Fields

roles

List<E> roles

A list of roles.

isTruncated

Boolean isTruncated

A flag that indicates whether there are more roles to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more roles in the list.

marker

String marker

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

Class com.amazonaws.services.identitymanagement.model.ListServerCertificatesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pathPrefix

String pathPrefix

The path prefix for filtering the results. For example: /company/servercerts would get all server certificates for which the path starts with /company/servercerts.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates.

Constraints:
Length: 1 - 512
Pattern: /[!-]*

marker

String marker

Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

maxItems

Integer maxItems

Use this only when paginating results to indicate the maximum number of server certificates you want in the response. If there are additional server certificates beyond the maximum you specify, the IsTruncated response element will be set to true.

Constraints:
Range: 1 - 1000

Class com.amazonaws.services.identitymanagement.model.ListServerCertificatesResult extends Object implements Serializable

Serialized Fields

serverCertificateMetadataList

List<E> serverCertificateMetadataList

A list of server certificates.

isTruncated

Boolean isTruncated

A flag that indicates whether there are more server certificates to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more server certificates in the list.

marker

String marker

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

Class com.amazonaws.services.identitymanagement.model.ListSigningCertificatesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

The name of the user.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

marker

String marker

Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

maxItems

Integer maxItems

Use this only when paginating results to indicate the maximum number of certificate IDs you want in the response. If there are additional certificate IDs beyond the maximum you specify, the IsTruncated response element is true.

Constraints:
Range: 1 - 1000

Class com.amazonaws.services.identitymanagement.model.ListSigningCertificatesResult extends Object implements Serializable

Serialized Fields

certificates

List<E> certificates

A list of the user's signing certificate information.

isTruncated

Boolean isTruncated

A flag that indicates whether there are more certificate IDs to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more certificates in the list.

marker

String marker

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

Class com.amazonaws.services.identitymanagement.model.ListUserPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

The name of the user to list policies for.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

marker

String marker

Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

maxItems

Integer maxItems

Use this only when paginating results to indicate the maximum number of policy names you want in the response. If there are additional policy names beyond the maximum you specify, the IsTruncated response element is true.

Constraints:
Range: 1 - 1000

Class com.amazonaws.services.identitymanagement.model.ListUserPoliciesResult extends Object implements Serializable

Serialized Fields

policyNames

List<E> policyNames

A list of policy names.

isTruncated

Boolean isTruncated

A flag that indicates whether there are more policy names to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more policy names in the list.

marker

String marker

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

Class com.amazonaws.services.identitymanagement.model.ListUsersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pathPrefix

String pathPrefix

The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all user names whose path starts with /division_abc/subdivision_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names.

Constraints:
Length: 1 - 512
Pattern: /[!-]*

marker

String marker

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

maxItems

Integer maxItems

Use this parameter only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true.

Constraints:
Range: 1 - 1000

Class com.amazonaws.services.identitymanagement.model.ListUsersResult extends Object implements Serializable

Serialized Fields

users

List<E> users

A list of users.

isTruncated

Boolean isTruncated

A flag that indicates whether there are more user names to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more users in the list.

marker

String marker

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

Class com.amazonaws.services.identitymanagement.model.ListVirtualMFADevicesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

assignmentStatus

String assignmentStatus

The status (unassigned or assigned) of the devices to list. If you do not specify an AssignmentStatus, the action defaults to Any which lists both assigned and unassigned virtual MFA devices.

Constraints:
Allowed Values: Assigned, Unassigned, Any

marker

String marker

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

maxItems

Integer maxItems

Use this parameter only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true.

Constraints:
Range: 1 - 1000

Class com.amazonaws.services.identitymanagement.model.ListVirtualMFADevicesResult extends Object implements Serializable

Serialized Fields

virtualMFADevices

List<E> virtualMFADevices

isTruncated

Boolean isTruncated

A flag that indicates whether there are more items to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items the list.

marker

String marker

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

Class com.amazonaws.services.identitymanagement.model.LoginProfile extends Object implements Serializable

Serialized Fields

userName

String userName

The name of the user, which can be used for signing into the AWS Management Console.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

createDate

Date createDate

The date when the password for the user was created.

Class com.amazonaws.services.identitymanagement.model.MalformedCertificateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.identitymanagement.model.MalformedPolicyDocumentException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.identitymanagement.model.MFADevice extends Object implements Serializable

Serialized Fields

userName

String userName

The user with whom the MFA device is associated.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

serialNumber

String serialNumber

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*

enableDate

Date enableDate

The date when the MFA device was enabled for the user.

Class com.amazonaws.services.identitymanagement.model.NoSuchEntityException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.identitymanagement.model.PasswordPolicy extends Object implements Serializable

Serialized Fields

minimumPasswordLength

Integer minimumPasswordLength

Minimum length to require for IAM user passwords.

Constraints:
Range: 6 - 128

requireSymbols

Boolean requireSymbols

Specifies whether to require symbols for IAM user passwords.

requireNumbers

Boolean requireNumbers

Specifies whether to require numbers for IAM user passwords.

requireUppercaseCharacters

Boolean requireUppercaseCharacters

Specifies whether to require uppercase characters for IAM user passwords.

requireLowercaseCharacters

Boolean requireLowercaseCharacters

Specifies whether to require lowercase characters for IAM user passwords.

allowUsersToChangePassword

Boolean allowUsersToChangePassword

Specifies whether to allow IAM users to change their own password.

Class com.amazonaws.services.identitymanagement.model.PasswordPolicyViolationException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.identitymanagement.model.PutGroupPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

Name of the group to associate the policy with.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

policyName

String policyName

Name of the policy document.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

policyDocument

String policyDocument

The policy document.

Constraints:
Length: 1 - 131072
Pattern: [ -?]+

Class com.amazonaws.services.identitymanagement.model.PutRolePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

roleName

String roleName

Name of the role to associate the policy with.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

policyName

String policyName

Name of the policy document.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

policyDocument

String policyDocument

The policy document.

Constraints:
Length: 1 - 131072
Pattern: [ -?]+

Class com.amazonaws.services.identitymanagement.model.PutUserPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

Name of the user to associate the policy with.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

policyName

String policyName

Name of the policy document.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

policyDocument

String policyDocument

The policy document.

Constraints:
Length: 1 - 131072
Pattern: [ -?]+

Class com.amazonaws.services.identitymanagement.model.RemoveRoleFromInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceProfileName

String instanceProfileName

Name of the instance profile to update.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

roleName

String roleName

Name of the role to remove.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.RemoveUserFromGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

Name of the group to update.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

userName

String userName

Name of the user to remove.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.ResyncMFADeviceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

Name of the user whose MFA device you want to resynchronize.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

serialNumber

String serialNumber

Serial number that uniquely identifies the MFA device.

Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*

authenticationCode1

String authenticationCode1

An authentication code emitted by the device.

Constraints:
Length: 6 - 6
Pattern: [\d]*

authenticationCode2

String authenticationCode2

A subsequent authentication code emitted by the device.

Constraints:
Length: 6 - 6
Pattern: [\d]*

Class com.amazonaws.services.identitymanagement.model.Role extends Object implements Serializable

Serialized Fields

path

String path

Path to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

roleName

String roleName

The name identifying the role.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

roleId

String roleId

The stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Constraints:
Length: 16 - 32
Pattern: [\w]*

arn

String arn

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Constraints:
Length: 20 - 2048

createDate

Date createDate

The date when the role was created.

assumeRolePolicyDocument

String assumeRolePolicyDocument

The policy that grants an entity permission to assume the role.

The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.

Constraints:
Length: 1 - 131072
Pattern: [ -?]+

Class com.amazonaws.services.identitymanagement.model.ServerCertificate extends Object implements Serializable

Serialized Fields

serverCertificateMetadata

ServerCertificateMetadata serverCertificateMetadata

The meta information of the server certificate, such as its name, path, ID, and ARN.

certificateBody

String certificateBody

The contents of the public key certificate.

Constraints:
Length: 1 - 16384
Pattern: [ -?]+

certificateChain

String certificateChain

The contents of the public key certificate chain.

Constraints:
Length: 1 - 2097152
Pattern: [ -?]*

Class com.amazonaws.services.identitymanagement.model.ServerCertificateMetadata extends Object implements Serializable

Serialized Fields

path

String path

Path to the server certificate. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

serverCertificateName

String serverCertificateName

The name that identifies the server certificate.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

serverCertificateId

String serverCertificateId

The stable and unique string identifying the server certificate. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Constraints:
Length: 16 - 32
Pattern: [\w]*

arn

String arn

The Amazon Resource Name (ARN) specifying the server certificate. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Constraints:
Length: 20 - 2048

uploadDate

Date uploadDate

The date when the server certificate was uploaded.

Class com.amazonaws.services.identitymanagement.model.SigningCertificate extends Object implements Serializable

Serialized Fields

userName

String userName

Name of the user the signing certificate is associated with.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

certificateId

String certificateId

The ID for the signing certificate.

Constraints:
Length: 24 - 128
Pattern: [\w]*

certificateBody

String certificateBody

The contents of the signing certificate.

Constraints:
Length: 1 - 16384
Pattern: [ -?]+

status

String status

The status of the signing certificate. Active means the key is valid for API calls, while Inactive means it is not.

Constraints:
Allowed Values: Active, Inactive

uploadDate

Date uploadDate

The date when the signing certificate was uploaded.

Class com.amazonaws.services.identitymanagement.model.UpdateAccessKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

Name of the user whose key you want to update.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

accessKeyId

String accessKeyId

The Access Key ID of the Secret Access Key you want to update.

Constraints:
Length: 16 - 32
Pattern: [\w]*

status

String status

The status you want to assign to the Secret Access Key. Active means the key can be used for API calls to AWS, while Inactive means the key cannot be used.

Constraints:
Allowed Values: Active, Inactive

Class com.amazonaws.services.identitymanagement.model.UpdateAccountPasswordPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

minimumPasswordLength

Integer minimumPasswordLength

requireSymbols

Boolean requireSymbols

requireNumbers

Boolean requireNumbers

requireUppercaseCharacters

Boolean requireUppercaseCharacters

requireLowercaseCharacters

Boolean requireLowercaseCharacters

allowUsersToChangePassword

Boolean allowUsersToChangePassword

Class com.amazonaws.services.identitymanagement.model.UpdateAssumeRolePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

roleName

String roleName

Name of the role to update.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

policyDocument

String policyDocument

The policy that grants an entity permission to assume the role.

Constraints:
Length: 1 - 131072
Pattern: [ -?]+

Class com.amazonaws.services.identitymanagement.model.UpdateGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

Name of the group to update. If you're changing the name of the group, this is the original name.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

newPath

String newPath

New path for the group. Only include this if changing the group's path.

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

newGroupName

String newGroupName

New name for the group. Only include this if changing the group's name.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.UpdateLoginProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

Name of the user whose password you want to update.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

password

String password

The new password for the user name.

Constraints:
Length: 1 - 128
Pattern: [ -?]+

Class com.amazonaws.services.identitymanagement.model.UpdateServerCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serverCertificateName

String serverCertificateName

The name of the server certificate that you want to update.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

newPath

String newPath

The new path for the server certificate. Include this only if you are updating the server certificate's path.

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

newServerCertificateName

String newServerCertificateName

The new name for the server certificate. Include this only if you are updating the server certificate's name.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.UpdateSigningCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

Name of the user the signing certificate belongs to.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

certificateId

String certificateId

The ID of the signing certificate you want to update.

Constraints:
Length: 24 - 128
Pattern: [\w]*

status

String status

The status you want to assign to the certificate. Active means the certificate can be used for API calls to AWS, while Inactive means the certificate cannot be used.

Constraints:
Allowed Values: Active, Inactive

Class com.amazonaws.services.identitymanagement.model.UpdateUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

Name of the user to update. If you're changing the name of the user, this is the original user name.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

newPath

String newPath

New path for the user. Include this parameter only if you're changing the user's path.

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

newUserName

String newUserName

New name for the user. Include this parameter only if you're changing the user's name.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.identitymanagement.model.UploadServerCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

path

String path

The path for the server certificate. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

This parameter is optional. If it is not included, it defaults to a slash (/).

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

serverCertificateName

String serverCertificateName

The name for the server certificate. Do not include the path in this value.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

certificateBody

String certificateBody

The contents of the public key certificate in PEM-encoded format.

Constraints:
Length: 1 - 16384
Pattern: [ -?]+

privateKey

String privateKey

The contents of the private key in PEM-encoded format.

Constraints:
Length: 1 - 16384
Pattern: [ -?]*

certificateChain

String certificateChain

The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.

Constraints:
Length: 1 - 2097152
Pattern: [ -?]*

Class com.amazonaws.services.identitymanagement.model.UploadServerCertificateResult extends Object implements Serializable

Serialized Fields

serverCertificateMetadata

ServerCertificateMetadata serverCertificateMetadata

The meta information of the uploaded server certificate without its certificate body, certificate chain, and private key.

Class com.amazonaws.services.identitymanagement.model.UploadSigningCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

Name of the user the signing certificate is for.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

certificateBody

String certificateBody

The contents of the signing certificate.

Constraints:
Length: 1 - 16384
Pattern: [ -?]+

Class com.amazonaws.services.identitymanagement.model.UploadSigningCertificateResult extends Object implements Serializable

Serialized Fields

certificate

SigningCertificate certificate

Information about the certificate.

Class com.amazonaws.services.identitymanagement.model.User extends Object implements Serializable

Serialized Fields

path

String path

Path to the user. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

userName

String userName

The name identifying the user.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

userId

String userId

The stable and unique string identifying the user. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Constraints:
Length: 16 - 32
Pattern: [\w]*

arn

String arn

The Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Constraints:
Length: 20 - 2048

createDate

Date createDate

The date when the user was created.

Class com.amazonaws.services.identitymanagement.model.VirtualMFADevice extends Object implements Serializable

Serialized Fields

serialNumber

String serialNumber

The serial number associated with VirtualMFADevice.

Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*

base32StringSeed

ByteBuffer base32StringSeed

The Base32 seed defined as specified in RFC3548. The Base32StringSeed is Base64-encoded.

qRCodePNG

ByteBuffer qRCodePNG

A QR code PNG image that encodes otpauth://totp/$virtualMFADeviceName@$AccountName? secret=$Base32String where $virtualMFADeviceName is one of the create call arguments, AccountName is the user name if set (accountId otherwise), and Base32String is the seed in Base32 format. The Base32String is Base64-encoded.

user

User user

The User data type contains information about a user.

This data type is used as a response element in the following actions:

• CreateUser

• GetUser

• ListUsers

enableDate

Date enableDate

Package com.amazonaws.services.importexport.model

Class com.amazonaws.services.importexport.model.BucketPermissionException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.importexport.model.CanceledJobIdException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.importexport.model.CancelJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

String jobId

A unique identifier which refers to a particular job.

Class com.amazonaws.services.importexport.model.CancelJobResult extends Object implements Serializable

Serialized Fields

success

Boolean success

Specifies whether (true) or not (false) AWS Import/Export updated your job.

Class com.amazonaws.services.importexport.model.CreateJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobType

String jobType

Specifies whether the job to initiate is an import or export job.

Constraints:
Allowed Values: Import, Export

manifest

String manifest

The UTF-8 encoded text of the manifest file.

manifestAddendum

String manifestAddendum

For internal use only.

validateOnly

Boolean validateOnly

Validate the manifest and parameter values in the request but do not actually create a job.

Class com.amazonaws.services.importexport.model.CreateJobResult extends Object implements Serializable

Serialized Fields

jobId

String jobId

A unique identifier which refers to a particular job.

jobType

String jobType

Specifies whether the job to initiate is an import or export job.

Constraints:
Allowed Values: Import, Export

awsShippingAddress

String awsShippingAddress

Address you ship your storage device to.

signature

String signature

An encrypted code used to authenticate the request and response, for example, "DV+TpDfx1/TdSE9ktyK9k/bDTVI=". Only use this value is you want to create the signature file yourself. Generally you should use the SignatureFileContents value.

signatureFileContents

String signatureFileContents

The actual text of the SIGNATURE file to be written to disk.

warningMessage

String warningMessage

An optional message notifying you of non-fatal issues with the job, such as use of an incompatible Amazon S3 bucket name.

Class com.amazonaws.services.importexport.model.ExpiredJobIdException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.importexport.model.GetStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

String jobId

A unique identifier which refers to a particular job.

Class com.amazonaws.services.importexport.model.GetStatusResult extends Object implements Serializable

Serialized Fields

jobId

String jobId

A unique identifier which refers to a particular job.

jobType

String jobType

Specifies whether the job to initiate is an import or export job.

Constraints:
Allowed Values: Import, Export

awsShippingAddress

String awsShippingAddress

Address you ship your storage device to.

locationCode

String locationCode

A token representing the location of the storage device, such as "AtAWS".

locationMessage

String locationMessage

A more human readable form of the physical location of the storage device.

progressCode

String progressCode

A token representing the state of the job, such as "Started".

progressMessage

String progressMessage

A more human readable form of the job status.

carrier

String carrier

Name of the shipping company. This value is included when the LocationCode is "Returned".

trackingNumber

String trackingNumber

The shipping tracking number assigned by AWS Import/Export to the storage device when it's returned to you. We return this value when the LocationCode is "Returned".

logBucket

String logBucket

Amazon S3 bucket for user logs.

logKey

String logKey

The key where the user logs were stored.

errorCount

Integer errorCount

Number of errors. We return this value when the ProgressCode is Success or SuccessWithErrors.

signature

String signature

An encrypted code used to authenticate the request and response, for example, "DV+TpDfx1/TdSE9ktyK9k/bDTVI=". Only use this value is you want to create the signature file yourself. Generally you should use the SignatureFileContents value.

signatureFileContents

String signatureFileContents

An encrypted code used to authenticate the request and response, for example, "DV+TpDfx1/TdSE9ktyK9k/bDTVI=". Only use this value is you want to create the signature file yourself. Generally you should use the SignatureFileContents value.

currentManifest

String currentManifest

The last manifest submitted, which will be used to process the job.

creationDate

Date creationDate

Timestamp of the CreateJob request in ISO8601 date format. For example "2010-03-28T20:27:35Z".

Class com.amazonaws.services.importexport.model.InvalidAccessKeyIdException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.importexport.model.InvalidAddressException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.importexport.model.InvalidCustomsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.importexport.model.InvalidFileSystemException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.importexport.model.InvalidJobIdException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.importexport.model.InvalidManifestFieldException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.importexport.model.InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.importexport.model.Job extends Object implements Serializable

Serialized Fields

jobId

String jobId

A unique identifier which refers to a particular job.

creationDate

Date creationDate

Timestamp of the CreateJob request in ISO8601 date format. For example "2010-03-28T20:27:35Z".

isCanceled

Boolean isCanceled

Indicates whether the job was canceled.

jobType

String jobType

Specifies whether the job to initiate is an import or export job.

Constraints:
Allowed Values: Import, Export

Class com.amazonaws.services.importexport.model.ListJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxJobs

Integer maxJobs

Sets the maximum number of jobs returned in the response. If there are additional jobs that were not returned because MaxJobs was exceeded, the response contains true. To return the additional jobs, see Marker.

marker

String marker

Specifies the JOBID to start after when listing the jobs created with your account. AWS Import/Export lists your jobs in reverse chronological order. See MaxJobs.

Class com.amazonaws.services.importexport.model.ListJobsResult extends Object implements Serializable

Serialized Fields

jobs

List<E> jobs

A list container for Jobs returned by the ListJobs operation.

isTruncated

Boolean isTruncated

Indicates whether the list of jobs was truncated. If true, then call ListJobs again using the last JobId element as the marker.

Class com.amazonaws.services.importexport.model.MalformedManifestException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.importexport.model.MissingCustomsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.importexport.model.MissingManifestFieldException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.importexport.model.MissingParameterException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.importexport.model.MultipleRegionsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.importexport.model.NoSuchBucketException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.importexport.model.UnableToCancelJobIdException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.importexport.model.UpdateJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

String jobId

A unique identifier which refers to a particular job.

manifest

String manifest

The UTF-8 encoded text of the manifest file.

jobType

String jobType

Specifies whether the job to initiate is an import or export job.

Constraints:
Allowed Values: Import, Export

validateOnly

Boolean validateOnly

Validate the manifest and parameter values in the request but do not actually create a job.

Class com.amazonaws.services.importexport.model.UpdateJobResult extends Object implements Serializable

Serialized Fields

success

Boolean success

Specifies whether (true) or not (false) AWS Import/Export updated your job.

warningMessage

String warningMessage

An optional message notifying you of non-fatal issues with the job, such as use of an incompatible Amazon S3 bucket name.

Package com.amazonaws.services.opsworks.model

Class com.amazonaws.services.opsworks.model.App extends Object implements Serializable

Serialized Fields

appId

String appId

The app ID.

stackId

String stackId

The app stack ID.

shortname

String shortname

The app's short name.

name

String name

The app name.

description

String description

A description of the app.

type

String type

The app type.

Constraints:
Allowed Values: rails, php, nodejs, static, other

appSource

Source appSource

A Source object that describes the app repository.

domains

List<E> domains

The app vhost settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

enableSsl

Boolean enableSsl

Whether to enable SSL for the app.

sslConfiguration

SslConfiguration sslConfiguration

An SslConfiguration object with the SSL configuration.

attributes

Map<K,V> attributes

The contents of the stack attributes bag.

createdAt

String createdAt

When the app was created.

Class com.amazonaws.services.opsworks.model.AttachElasticLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

elasticLoadBalancerName

String elasticLoadBalancerName

The Elastic Load Balancing instance's name.

layerId

String layerId

The ID of the layer that the Elastic Load Balancing instance is to be attached to.

Class com.amazonaws.services.opsworks.model.AutoScalingThresholds extends Object implements Serializable

Serialized Fields

instanceCount

Integer instanceCount

The number of instances to add or remove when the load exceeds a threshold.

thresholdsWaitTime

Integer thresholdsWaitTime

The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

Constraints:
Range: 1 - 100

ignoreMetricsTime

Integer ignoreMetricsTime

The amount of time (in minutes) after a scaling event occurs that OpsWorks should ignore metrics and not raise any additional scaling events. For example, OpsWorks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct OpsWorks to not raise any scaling events long enough to get the new instances online.

Constraints:
Range: 1 - 100

cpuThreshold

Double cpuThreshold

The CPU utilization threshold, as a percent of the available CPU.

memoryThreshold

Double memoryThreshold

The memory utilization threshold, as a percent of the available memory.

loadThreshold

Double loadThreshold

The load threshold. For more information about how load is computed, see Load (computing).

Class com.amazonaws.services.opsworks.model.CloneStackRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sourceStackId

String sourceStackId

The source stack ID.

name

String name

The cloned stack name.

region

String region

The cloned stack AWS region, such as "us-east-1". For more information about AWS regions, see Regions and Endpoints.

attributes

Map<K,V> attributes

A list of stack attributes and values as key/value pairs to be added to the cloned stack.

serviceRoleArn

String serviceRoleArn

The stack AWS Identity and Access Management (IAM) role, which allows OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you create a stack by using the OpsWorks console, it creates the role for you. You can obtain an existing stack's IAM ARN programmatically by calling DescribePermissions. For more information about IAM ARNs, see Using Identifiers. You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.

defaultInstanceProfileArn

String defaultInstanceProfileArn

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

defaultOs

String defaultOs

The cloned stack default operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

hostnameTheme

String hostnameTheme

The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate hostnames for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates hostnames by appending integers to the layer's shortname. The other themes are:

• Baked_Goods
• Clouds
• European_Cities
• Fruits
• Greek_Deities
• Legendary_Creatures_from_Japan
• Planets_and_Moons
• Roman_Deities
• Scottish_Islands
• US_Cities
• Wild_Cats

To obtain a generated hostname, call GetHostNameSuggestion, which returns a hostname based on the current theme.

defaultAvailabilityZone

String defaultAvailabilityZone

The cloned stack's Availability Zone. For more information, see Regions and Endpoints.

customJson

String customJson

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '"'.: "{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information on custom JSON, see . Use Custom JSON to Modify the Stack Configuration JSON

useCustomCookbooks

Boolean useCustomCookbooks

Whether to use custom cookbooks.

customCookbooksSource

Source customCookbooksSource

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.

defaultSshKeyName

String defaultSshKeyName

A default SSH key for the stack instances. You can override this value when you create or update an instance.

clonePermissions

Boolean clonePermissions

Whether to clone the source stack's permissions.

cloneAppIds

List<E> cloneAppIds

A list of source stack app IDs to be included in the cloned stack.

defaultRootDeviceType

String defaultRootDeviceType

The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

Constraints:
Allowed Values: ebs, instance-store

Class com.amazonaws.services.opsworks.model.CloneStackResult extends Object implements Serializable

Serialized Fields

stackId

String stackId

The cloned stack ID.

Class com.amazonaws.services.opsworks.model.Command extends Object implements Serializable

Serialized Fields

commandId

String commandId

The command ID.

instanceId

String instanceId

The ID of the instance where the command was executed.

deploymentId

String deploymentId

The command deployment ID.

createdAt

String createdAt

Date and time when the command was run.

acknowledgedAt

String acknowledgedAt

Date and time when the command was acknowledged.

completedAt

String completedAt

Date when the command completed.

status

String status

The command status:

• failed
• successful
• skipped
• pending

exitCode

Integer exitCode

The command exit code.

logUrl

String logUrl

The URL of the command log.

type

String type

The command type:

• deploy
• rollback
• start
• stop
• restart
• undeploy
• update_dependencies
• install_dependencies
• update_custom_cookbooks
• execute_recipes

Class com.amazonaws.services.opsworks.model.CreateAppRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackId

String stackId

The stack ID.

shortname

String shortname

The app's short name.

name

String name

The app name.

description

String description

A description of the app.

type

String type

The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. OpsWorks deploys an application to those instances that are members of the corresponding layer.

Constraints:
Allowed Values: rails, php, nodejs, static, other

appSource

Source appSource

A Source object that specifies the app repository.

domains

List<E> domains

The app virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

enableSsl

Boolean enableSsl

Whether to enable SSL for the app.

sslConfiguration

SslConfiguration sslConfiguration

An SslConfiguration object with the SSL configuration.

attributes

Map<K,V> attributes

One or more user-defined key/value pairs to be added to the stack attributes bag.

Class com.amazonaws.services.opsworks.model.CreateAppResult extends Object implements Serializable

Serialized Fields

appId

String appId

The app ID.

Class com.amazonaws.services.opsworks.model.CreateDeploymentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackId

String stackId

The stack ID.

appId

String appId

The app ID. This parameter is required for app deployments, but not for other deployment commands.

instanceIds

List<E> instanceIds

The instance IDs for the deployment targets.

command

DeploymentCommand command

A DeploymentCommand object that specifies the deployment command and any associated arguments.

comment

String comment

A user-defined comment.

customJson

String customJson

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '"'.: "{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.

Class com.amazonaws.services.opsworks.model.CreateDeploymentResult extends Object implements Serializable

Serialized Fields

deploymentId

String deploymentId

The deployment ID, which can be used with other requests to identify the deployment.

Class com.amazonaws.services.opsworks.model.CreateInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackId

String stackId

The stack ID.

layerIds

List<E> layerIds

An array that contains the instance layer IDs.

instanceType

String instanceType

The instance type. OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

autoScalingType

String autoScalingType

The instance auto scaling type, which has three possible values:

• AlwaysRunning: A 24/7 instance, which is not affected by auto scaling.
• TimeBasedAutoScaling: A time-based auto scaling instance, which is started and stopped based on a specified schedule. To specify the schedule, call SetTimeBasedAutoScaling.
• LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics. To use load-based auto scaling, you must enable it for the instance layer and configure the thresholds by calling SetLoadBasedAutoScaling.

Constraints:
Allowed Values: load, timer

hostname

String hostname

The instance host name.

os

String os

The instance's operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

sshKeyName

String sshKeyName

The instance SSH key name.

availabilityZone

String availabilityZone

The instance Availability Zone. For more information, see Regions and Endpoints.

architecture

String architecture

The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

Constraints:
Allowed Values: x86_64, i386

rootDeviceType

String rootDeviceType

The instance root device type. For more information, see Storage for the Root Device.

Constraints:
Allowed Values: ebs, instance-store

Class com.amazonaws.services.opsworks.model.CreateInstanceResult extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

The instance ID.

Class com.amazonaws.services.opsworks.model.CreateLayerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackId

String stackId

The layer stack ID.

type

String type

The layer type. A stack cannot have more than one layer of the same type. This parameter must be set to one of the following:

• lb: An HAProxy layer
• web: A Static Web Server layer
• rails-app: A Rails App Server layer
• php-app: A PHP App Server layer
• nodejs-app: A Node.js App Server layer
• memcached: A Memcached layer
• db-master: A MySQL layer
• monitoring-master: A Ganglia layer
• custom: A custom layer

Constraints:
Allowed Values: lb, web, php-app, rails-app, nodejs-app, memcached, db-master, monitoring-master, custom

name

String name

The layer name, which is used by the console.

shortname

String shortname

The layer short name, which is used internally by OpsWorks and by Chef recipes. The shortname is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.

attributes

Map<K,V> attributes

One or more user-defined key/value pairs to be added to the stack attributes bag.

customInstanceProfileArn

String customInstanceProfileArn

The ARN of an IAM profile that to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

customSecurityGroupIds

List<E> customSecurityGroupIds

An array containing the layer custom security group IDs.

packages

List<E> packages

An array of Package objects that describe the layer packages.

volumeConfigurations

List<E> volumeConfigurations

A VolumeConfigurations object that describes the layer Amazon EBS volumes.

enableAutoHealing

Boolean enableAutoHealing

Whether to disable auto healing for the layer.

autoAssignElasticIps

Boolean autoAssignElasticIps

Whether to automatically assign an Elastic IP address to the layer.

customRecipes

Recipes customRecipes

A LayerCustomRecipes object that specifies the layer custom recipes.

Class com.amazonaws.services.opsworks.model.CreateLayerResult extends Object implements Serializable

Serialized Fields

layerId

String layerId

The layer ID.

Class com.amazonaws.services.opsworks.model.CreateStackRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

The stack name.

region

String region

The stack AWS region, such as "us-east-1". For more information about Amazon regions, see Regions and Endpoints.

attributes

Map<K,V> attributes

One or more user-defined key/value pairs to be added to the stack attributes bag.

serviceRoleArn

String serviceRoleArn

The stack AWS Identity and Access Management (IAM) role, which allows OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.

defaultInstanceProfileArn

String defaultInstanceProfileArn

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

defaultOs

String defaultOs

The cloned stack default operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

hostnameTheme

String hostnameTheme

The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate hostnames for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates hostnames by appending integers to the layer's shortname. The other themes are:

• Baked_Goods
• Clouds
• European_Cities
• Fruits
• Greek_Deities
• Legendary_Creatures_from_Japan
• Planets_and_Moons
• Roman_Deities
• Scottish_Islands
• US_Cities
• Wild_Cats

To obtain a generated hostname, call GetHostNameSuggestion, which returns a hostname based on the current theme.

defaultAvailabilityZone

String defaultAvailabilityZone

The stack default Availability Zone. For more information, see Regions and Endpoints.

customJson

String customJson

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '"'.: "{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.

useCustomCookbooks

Boolean useCustomCookbooks

Whether the stack uses custom cookbooks.

customCookbooksSource

Source customCookbooksSource

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.

defaultSshKeyName

String defaultSshKeyName

A default SSH key for the stack instances. You can override this value when you create or update an instance.

defaultRootDeviceType

String defaultRootDeviceType

The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

Constraints:
Allowed Values: ebs, instance-store

Class com.amazonaws.services.opsworks.model.CreateStackResult extends Object implements Serializable

Serialized Fields

stackId

String stackId

The stack ID, which is an opaque string that you use to identify the stack when performing actions such as DescribeStacks.

Class com.amazonaws.services.opsworks.model.CreateUserProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

iamUserArn

String iamUserArn

The user's IAM ARN.

sshUsername

String sshUsername

The user's SSH user name.

sshPublicKey

String sshPublicKey

The user's public SSH key.

Class com.amazonaws.services.opsworks.model.CreateUserProfileResult extends Object implements Serializable

Serialized Fields

iamUserArn

String iamUserArn

The user's IAM ARN.

Class com.amazonaws.services.opsworks.model.DeleteAppRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

appId

String appId

The app ID.

Class com.amazonaws.services.opsworks.model.DeleteInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The instance ID.

deleteElasticIp

Boolean deleteElasticIp

Whether to delete the instance Elastic IP address.

deleteVolumes

Boolean deleteVolumes

Whether to delete the instance Amazon EBS volumes.

Class com.amazonaws.services.opsworks.model.DeleteLayerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

layerId

String layerId

The layer ID.

Class com.amazonaws.services.opsworks.model.DeleteStackRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackId

String stackId

The stack ID.

Class com.amazonaws.services.opsworks.model.DeleteUserProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

iamUserArn

String iamUserArn

The user's IAM ARN.

Class com.amazonaws.services.opsworks.model.Deployment extends Object implements Serializable

Serialized Fields

deploymentId

String deploymentId

The deployment ID.

stackId

String stackId

The stack ID.

appId

String appId

The app ID.

createdAt

String createdAt

Date when the deployment was created.

completedAt

String completedAt

Date when the deployment completed.

duration

Integer duration

The deployment duration.

iamUserArn

String iamUserArn

The user's IAM ARN.

comment

String comment

A user-defined comment.

command

DeploymentCommand command

Used to specify a deployment operation.

status

String status

The deployment status:

• running
• successful
• failed

customJson

String customJson

A string that contains user-defined custom JSON. It is used to override the corresponding default stack configuration JSON values for stack. The string should be in the following format and must escape characters such as '"'.: "{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.

instanceIds

List<E> instanceIds

The IDs of the target instances.

Class com.amazonaws.services.opsworks.model.DeploymentCommand extends Object implements Serializable

Serialized Fields

name

String name

Specifies the deployment operation. You can specify only one command.

For stacks, the available commands are:

• execute_recipes: Execute the recipes that are specified by the Args parameter.
• install_dependencies: Installs the stack's dependencies.
• update_custom_cookbooks: Update the stack's custom cookbooks.
• update_dependencies: Update the stack's dependencies.

For apps, the available commands are:

• deploy: Deploy the app.
• rollback Roll the app back to the previous version. When you update an app, OpsWorks stores the previous version, up to a maximum of five versions. You can use this command to roll an app back as many as four versions.
• start: Start the app's web or application server.
• stop: Stop the app's web or application server.
• restart: Restart the app's web or application server.
• undeploy: Undeploy the app.

Constraints:
Allowed Values: install_dependencies, update_dependencies, update_custom_cookbooks, execute_recipes, deploy, rollback, start, stop, restart, undeploy

args

Map<K,V> args

An array of command arguments. This parameter is currently used only to specify the list of recipes to be executed by the ExecuteRecipes command.

Class com.amazonaws.services.opsworks.model.DescribeAppsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackId

String stackId

The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.

appIds

List<E> appIds

An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

Class com.amazonaws.services.opsworks.model.DescribeAppsResult extends Object implements Serializable

Serialized Fields

apps

List<E> apps

An array of App objects that describe the specified apps.

Class com.amazonaws.services.opsworks.model.DescribeCommandsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deploymentId

String deploymentId

The deployment ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified deployment.

instanceId

String instanceId

The instance ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified instance.

commandIds

List<E> commandIds

An array of command IDs. If you include this parameter, DescribeCommands returns a description of the specified commands. Otherwise, it returns a description of every command.

Class com.amazonaws.services.opsworks.model.DescribeCommandsResult extends Object implements Serializable

Serialized Fields

commands

List<E> commands

An array of Command objects that describe each of the specified commands.

Class com.amazonaws.services.opsworks.model.DescribeDeploymentsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackId

String stackId

The stack ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified stack.

appId

String appId

The app ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified app.

deploymentIds

List<E> deploymentIds

An array of deployment IDs to be described. If you include this parameter, DescribeDeployments returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

Class com.amazonaws.services.opsworks.model.DescribeDeploymentsResult extends Object implements Serializable

Serialized Fields

deployments

List<E> deployments

An array of Deployment objects that describe the deployments.

Class com.amazonaws.services.opsworks.model.DescribeElasticIpsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.

ips

List<E> ips

An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.

Class com.amazonaws.services.opsworks.model.DescribeElasticIpsResult extends Object implements Serializable

Serialized Fields

elasticIps

List<E> elasticIps

An ElasticIps object that describes the specified Elastic IP addresses.

Class com.amazonaws.services.opsworks.model.DescribeElasticLoadBalancersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackId

String stackId

A stack ID. The action describes the Elastic Load Balancing instances for the stack.

layerIds

List<E> layerIds

A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.

Class com.amazonaws.services.opsworks.model.DescribeElasticLoadBalancersResult extends Object implements Serializable

Serialized Fields

elasticLoadBalancers

List<E> elasticLoadBalancers

A list of ElasticLoadBalancer objects that describe the specified Elastic Load Balancing instances.

Class com.amazonaws.services.opsworks.model.DescribeInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackId

String stackId

A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.

layerId

String layerId

A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.

instanceIds

List<E> instanceIds

An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

Class com.amazonaws.services.opsworks.model.DescribeInstancesResult extends Object implements Serializable

Serialized Fields

instances

List<E> instances

An array of Instance objects that describe the instances.

Class com.amazonaws.services.opsworks.model.DescribeLayersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackId

String stackId

The stack ID.

layerIds

List<E> layerIds

An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack.

Class com.amazonaws.services.opsworks.model.DescribeLayersResult extends Object implements Serializable

Serialized Fields

layers

List<E> layers

An array of Layer objects that describe the layers.

Class com.amazonaws.services.opsworks.model.DescribeLoadBasedAutoScalingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

layerIds

List<E> layerIds

An array of layer IDs.

Class com.amazonaws.services.opsworks.model.DescribeLoadBasedAutoScalingResult extends Object implements Serializable

Serialized Fields

loadBasedAutoScalingConfigurations

List<E> loadBasedAutoScalingConfigurations

An array of LoadBasedAutoScalingConfiguration objects that describe each layer's configuration.

Class com.amazonaws.services.opsworks.model.DescribePermissionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

iamUserArn

String iamUserArn

The user's IAM ARN. For more information about IAM ARNs, see Using Identifiers.

stackId

String stackId

The stack ID.

Class com.amazonaws.services.opsworks.model.DescribePermissionsResult extends Object implements Serializable

Serialized Fields

permissions

List<E> permissions

An array of Permission objects that describe the stack permissions.

• If the request object contains only a stack ID, the array contains a Permission object with permissions for each of the stack IAM ARNs.
• If the request object contains only an IAM ARN, the array contains a Permission object with permissions for each of the user's stack IDs.
• If the request contains a stack ID and an IAM ARN, the array contains a single Permission object with permissions for the specified stack and IAM ARN.

Class com.amazonaws.services.opsworks.model.DescribeRaidArraysRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The instance ID. If you use this parameter, DescribeRaidArrays returns descriptions of the RAID arrays associated with the specified instance.

raidArrayIds

List<E> raidArrayIds

An array of RAID array IDs. If you use this parameter, DescribeRaidArrays returns descriptions of the specified arrays. Otherwise, it returns a description of every array.

Class com.amazonaws.services.opsworks.model.DescribeRaidArraysResult extends Object implements Serializable

Serialized Fields

raidArrays

List<E> raidArrays

A RaidArrays object that describes the specified RAID arrays.

Class com.amazonaws.services.opsworks.model.DescribeServiceErrorsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackId

String stackId

The stack ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified stack.

instanceId

String instanceId

The instance ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified instance.

serviceErrorIds

List<E> serviceErrorIds

An array of service error IDs. If you use this parameter, DescribeServiceErrors returns descriptions of the specified errors. Otherwise, it returns a description of every error.

Class com.amazonaws.services.opsworks.model.DescribeServiceErrorsResult extends Object implements Serializable

Serialized Fields

serviceErrors

List<E> serviceErrors

An array of ServiceError objects that describe the specified service errors.

Class com.amazonaws.services.opsworks.model.DescribeStacksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackIds

List<E> stackIds

An array of stack IDs that specify the stacks to be described. If you omit this parameter, DescribeStacks returns a description of every stack.

Class com.amazonaws.services.opsworks.model.DescribeStacksResult extends Object implements Serializable

Serialized Fields

stacks

List<E> stacks

An array of Stack objects that describe the stacks.

Class com.amazonaws.services.opsworks.model.DescribeTimeBasedAutoScalingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceIds

List<E> instanceIds

An array of instance IDs.

Class com.amazonaws.services.opsworks.model.DescribeTimeBasedAutoScalingResult extends Object implements Serializable

Serialized Fields

timeBasedAutoScalingConfigurations

List<E> timeBasedAutoScalingConfigurations

An array of TimeBasedAutoScalingConfiguration objects that describe the configuration for the specified instances.

Class com.amazonaws.services.opsworks.model.DescribeUserProfilesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

iamUserArns

List<E> iamUserArns

An array of IAM user ARNs that identify the users to be described.

Class com.amazonaws.services.opsworks.model.DescribeUserProfilesResult extends Object implements Serializable

Serialized Fields

userProfiles

List<E> userProfiles

A Users object that describes the specified users.

Class com.amazonaws.services.opsworks.model.DescribeVolumesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.

raidArrayId

String raidArrayId

The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.

volumeIds

List<E> volumeIds

Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.

Class com.amazonaws.services.opsworks.model.DescribeVolumesResult extends Object implements Serializable

Serialized Fields

volumes

List<E> volumes

An array of volume IDs.

Class com.amazonaws.services.opsworks.model.DetachElasticLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

elasticLoadBalancerName

String elasticLoadBalancerName

The Elastic Load Balancing instance's name.

layerId

String layerId

The ID of the layer that the Elastic Load Balancing instance is attached to.

Class com.amazonaws.services.opsworks.model.ElasticIp extends Object implements Serializable

Serialized Fields

ip

String ip

The Elastic IP address

name

String name

The Elastic IP address name.

region

String region

The AWS region. For more information, see Regions and Endpoints.

Class com.amazonaws.services.opsworks.model.ElasticLoadBalancer extends Object implements Serializable

Serialized Fields

elasticLoadBalancerName

String elasticLoadBalancerName

The Elastic Load Balancing instance's name.

region

String region

The instance's AWS region.

dnsName

String dnsName

The instance's public DNS name.

stackId

String stackId

The ID of the stack that the instance is associated with.

layerId

String layerId

The ID of the layer that the instance is attached to.

availabilityZones

List<E> availabilityZones

The instance's Availability Zones.

ec2InstanceIds

List<E> ec2InstanceIds

A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.

Class com.amazonaws.services.opsworks.model.GetHostnameSuggestionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

layerId

String layerId

The layer ID.

Class com.amazonaws.services.opsworks.model.GetHostnameSuggestionResult extends Object implements Serializable

Serialized Fields

layerId

String layerId

The layer ID.

hostname

String hostname

The generated hostname.

Class com.amazonaws.services.opsworks.model.Instance extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

The instance ID.

ec2InstanceId

String ec2InstanceId

The ID of the associated Amazon EC2 instance.

hostname

String hostname

The instance host name.

stackId

String stackId

The stack ID.

layerIds

List<E> layerIds

An array containing the instance layer IDs.

securityGroupIds

List<E> securityGroupIds

An array containing the instance security group IDs.

instanceType

String instanceType

The instance type. OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. For more information, see Instance Families and Types. The parameter values that specify the various types are in the API Name column of the Available Instance Types table.

instanceProfileArn

String instanceProfileArn

The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.

status

String status

The instance status:

• requested
• booting
• running_setup
• online
• setup_failed
• start_failed
• terminating
• terminated
• stopped
• connection_lost

os

String os

The instance operating system.

availabilityZone

String availabilityZone

The instance Availability Zone. For more information, see Regions and Endpoints.

publicDns

String publicDns

The instance public DNS name.

privateDns

String privateDns

The instance private DNS name.

publicIp

String publicIp

The instance public IP address.

privateIp

String privateIp

The instance private IP address.

elasticIp

String elasticIp

The instance Elastic IP address .

autoScalingType

String autoScalingType

The instance's auto scaling type, which has three possible values:

• AlwaysRunning: A 24/7 instance, which is not affected by auto scaling.
• TimeBasedAutoScaling: A time-based auto scaling instance, which is started and stopped based on a specified schedule.
• LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics.

Constraints:
Allowed Values: load, timer

sshKeyName

String sshKeyName

The instance SSH key name.

sshHostRsaKeyFingerprint

String sshHostRsaKeyFingerprint

The SSH key's RSA fingerprint.

sshHostDsaKeyFingerprint

String sshHostDsaKeyFingerprint

The SSH key's DSA fingerprint.

createdAt

String createdAt

The time that the instance was created.

lastServiceErrorId

String lastServiceErrorId

The ID of the last service error. For more information, call DescribeServiceErrors.

architecture

String architecture

The instance architecture, "i386" or "x86_64".

Constraints:
Allowed Values: x86_64, i386

rootDeviceType

String rootDeviceType

The instance root device type. For more information, see Storage for the Root Device.

Constraints:
Allowed Values: ebs, instance-store

rootDeviceVolumeId

String rootDeviceVolumeId

The root device volume ID.

Class com.amazonaws.services.opsworks.model.Layer extends Object implements Serializable

Serialized Fields

stackId

String stackId

The layer stack ID.

layerId

String layerId

The layer ID.

type

String type

The layer type, which must be one of the following:

• Custom
• GangliaMonitoringMaster
• HaProxy
• MemcachedServer
• MySqlMaster
• NodeJsAppServer
• PhpAppServer
• RailsAppServer
• WebServer

Constraints:
Allowed Values: lb, web, php-app, rails-app, nodejs-app, memcached, db-master, monitoring-master, custom

name

String name

The layer name.

shortname

String shortname

The layer short name.

attributes

Map<K,V> attributes

The layer attributes.

customInstanceProfileArn

String customInstanceProfileArn

The ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

customSecurityGroupIds

List<E> customSecurityGroupIds

An array containing the layer's custom security group IDs.

defaultSecurityGroupNames

List<E> defaultSecurityGroupNames

An array containing the layer's security group names.

packages

List<E> packages

An array of Package objects that describe the layer's packages.

volumeConfigurations

List<E> volumeConfigurations

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

enableAutoHealing

Boolean enableAutoHealing

Whether auto healing is disabled for the layer.

autoAssignElasticIps

Boolean autoAssignElasticIps

Whether the layer has an automatically assigned Elastic IP address.

defaultRecipes

Recipes defaultRecipes

OpsWorks supports five lifecycle events, setup, configuration, deploy, undeploy, and shutdown. For each layer, OpsWorks runs a set of standard recipes for each event. In addition, you can provide custom recipes for any or all layers and events. OpsWorks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.

customRecipes

Recipes customRecipes

A LayerCustomRecipes object that specifies the layer's custom recipes.

createdAt

String createdAt

Date when the layer was created.

Class com.amazonaws.services.opsworks.model.LoadBasedAutoScalingConfiguration extends Object implements Serializable

Serialized Fields

layerId

String layerId

The layer ID.

enable

Boolean enable

Whether load-based auto scaling is enabled for the layer.

upScaling

AutoScalingThresholds upScaling

A LoadBasedAutoscalingInstruction object that describes the upscaling configuration, which defines how and when OpsWorks increases the number of instances.

downScaling

AutoScalingThresholds downScaling

A LoadBasedAutoscalingInstruction object that describes the downscaling configuration, which defines how and when OpsWorks reduces the number of instances.

Class com.amazonaws.services.opsworks.model.Permission extends Object implements Serializable

Serialized Fields

stackId

String stackId

A stack ID.

iamUserArn

String iamUserArn

The Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) role. For more information about IAM ARNs, see Using Identifiers.

allowSsh

Boolean allowSsh

Whether the user can use SSH.

allowSudo

Boolean allowSudo

Whether the user can use sudo.

Class com.amazonaws.services.opsworks.model.RaidArray extends Object implements Serializable

Serialized Fields

raidArrayId

String raidArrayId

The array ID.

instanceId

String instanceId

The instance ID.

name

String name

The array name.

raidLevel

Integer raidLevel

The RAID level.

numberOfDisks

Integer numberOfDisks

The number of disks in the array.

size

Integer size

The array's size.

device

String device

The array's Linux device. For example /dev/mdadm0.

mountPoint

String mountPoint

The array's mount point.

availabilityZone

String availabilityZone

The array's Availability Zone. For more information, see Regions and Endpoints.

createdAt

String createdAt

When the RAID array was created.

Class com.amazonaws.services.opsworks.model.RebootInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The instance ID.

Class com.amazonaws.services.opsworks.model.Recipes extends Object implements Serializable

Serialized Fields

setup

List<E> setup

An array of custom recipe names to be run following a setup event.

configure

List<E> configure

An array of custom recipe names to be run following a configure event.

deploy

List<E> deploy

An array of custom recipe names to be run following a deploy event.

undeploy

List<E> undeploy

An array of custom recipe names to be run following a undeploy event.

shutdown

List<E> shutdown

An array of custom recipe names to be run following a shutdown event.

Class com.amazonaws.services.opsworks.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.opsworks.model.ServiceError extends Object implements Serializable

Serialized Fields

serviceErrorId

String serviceErrorId

The error ID.

stackId

String stackId

The stack ID.

instanceId

String instanceId

The instance ID.

type

String type

The error type.

message

String message

A message that describes the error.

createdAt

String createdAt

When the error occurred.

Class com.amazonaws.services.opsworks.model.SetLoadBasedAutoScalingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

layerId

String layerId

The layer ID.

enable

Boolean enable

Enables load-based auto scaling for the layer.

upScaling

AutoScalingThresholds upScaling

An AutoScalingThresholds object with the upscaling threshold configuration. If the load exceeds these thresholds for a specified amount of time, OpsWorks starts a specified number of instances.

downScaling

AutoScalingThresholds downScaling

An AutoScalingThresholds object with the downscaling threshold configuration. If the load falls below these thresholds for a specified amount of time, OpsWorks stops a specified number of instances.

Class com.amazonaws.services.opsworks.model.SetPermissionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackId

String stackId

The stack ID.

iamUserArn

String iamUserArn

The user's IAM ARN.

allowSsh

Boolean allowSsh

The user is allowed to use SSH to communicate with the instance.

allowSudo

Boolean allowSudo

The user is allowed to use sudo to elevate privileges.

Class com.amazonaws.services.opsworks.model.SetTimeBasedAutoScalingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The instance ID.

autoScalingSchedule

WeeklyAutoScalingSchedule autoScalingSchedule

An AutoScalingSchedule with the instance schedule.

Class com.amazonaws.services.opsworks.model.Source extends Object implements Serializable

Serialized Fields

type

String type

The repository type.

Constraints:
Allowed Values: git, svn, archive, s3

url

String url

The source URL.

username

String username

This parameter depends on the repository type.

• For Amazon S3 bundles, set Username to the appropriate AWS access key.
• For HTTP bundles, Git repositories, and Subversion repositories, set Username to the user name.

password

String password

This parameter depends on the repository type.

• For Amazon S3 bundles, set Password to the appropriate AWS secret key.
• For HTTP bundles, Git repositories, and Subversion repositories, set Password to the password.

sshKey

String sshKey

The repository's SSH key.

revision

String revision

The application's version. OpsWorks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.

Class com.amazonaws.services.opsworks.model.SslConfiguration extends Object implements Serializable

Serialized Fields

certificate

String certificate

The contents of the certificate's domain.crt file.

privateKey

String privateKey

The private key; the contents of the certificate's domain.kex file.

chain

String chain

Optional. Can be used to specify an intermediate certificate authority key or client authentication.

Class com.amazonaws.services.opsworks.model.Stack extends Object implements Serializable

Serialized Fields

stackId

String stackId

The stack ID.

name

String name

The stack name.

region

String region

The stack AWS region, such as "us-east-1". For more information about AWS regions, see Regions and Endpoints.

attributes

Map<K,V> attributes

The contents of the stack's attributes bag.

serviceRoleArn

String serviceRoleArn

The stack AWS Identity and Access Management (IAM) role.

defaultInstanceProfileArn

String defaultInstanceProfileArn

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

defaultOs

String defaultOs

The cloned stack default operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

hostnameTheme

String hostnameTheme

The stack host name theme, with spaces replaced by underscores.

defaultAvailabilityZone

String defaultAvailabilityZone

The stack's default Availability Zone. For more information, see Regions and Endpoints.

customJson

String customJson

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '"'.: "{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.

useCustomCookbooks

Boolean useCustomCookbooks

Whether the stack uses custom cookbooks.

customCookbooksSource

Source customCookbooksSource

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.

defaultSshKeyName

String defaultSshKeyName

A default SSH key for the stack's instances. You can override this value when you create or update an instance.

createdAt

String createdAt

Date when the stack was created.

defaultRootDeviceType

String defaultRootDeviceType

The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

Constraints:
Allowed Values: ebs, instance-store

Class com.amazonaws.services.opsworks.model.StartInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The instance ID.

Class com.amazonaws.services.opsworks.model.StartStackRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackId

String stackId

The stack ID.

Class com.amazonaws.services.opsworks.model.StopInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The instance ID.

Class com.amazonaws.services.opsworks.model.StopStackRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackId

String stackId

The stack ID.

Class com.amazonaws.services.opsworks.model.TimeBasedAutoScalingConfiguration extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

The instance ID.

autoScalingSchedule

WeeklyAutoScalingSchedule autoScalingSchedule

A WeeklyAutoScalingSchedule object with the instance schedule.

Class com.amazonaws.services.opsworks.model.UpdateAppRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

appId

String appId

The app ID.

name

String name

The app name.

description

String description

A description of the app.

type

String type

The app type.

Constraints:
Allowed Values: rails, php, nodejs, static, other

appSource

Source appSource

A Source object that specifies the app repository.

domains

List<E> domains

The app's virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

enableSsl

Boolean enableSsl

Whether SSL is enabled for the app.

sslConfiguration

SslConfiguration sslConfiguration

An SslConfiguration object with the SSL configuration.

attributes

Map<K,V> attributes

One or more user-defined key/value pairs to be added to the stack attributes bag.

Class com.amazonaws.services.opsworks.model.UpdateInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The instance ID.

layerIds

List<E> layerIds

The instance's layer IDs.

instanceType

String instanceType

The instance type. OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

autoScalingType

String autoScalingType

The instance's auto scaling type, which has three possible values:

• AlwaysRunning: A 24/7 instance, which is not affected by auto scaling.
• TimeBasedAutoScaling: A time-based auto scaling instance, which is started and stopped based on a specified schedule.
• LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics.

Constraints:
Allowed Values: load, timer

hostname

String hostname

The instance host name.

os

String os

The instance operating system.

sshKeyName

String sshKeyName

The instance SSH key name.

architecture

String architecture

The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

Constraints:
Allowed Values: x86_64, i386

Class com.amazonaws.services.opsworks.model.UpdateLayerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

layerId

String layerId

The layer ID.

name

String name

The layer name, which is used by the console.

shortname

String shortname

The layer short name, which is used internally by OpsWorksand by Chef. The shortname is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\A[a-z0-9\-\_\.]+\Z/.

attributes

Map<K,V> attributes

One or more user-defined key/value pairs to be added to the stack attributes bag.

customInstanceProfileArn

String customInstanceProfileArn

The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

customSecurityGroupIds

List<E> customSecurityGroupIds

An array containing the layer's custom security group IDs.

packages

List<E> packages

An array of Package objects that describe the layer's packages.

volumeConfigurations

List<E> volumeConfigurations

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

enableAutoHealing

Boolean enableAutoHealing

Whether to disable auto healing for the layer.

autoAssignElasticIps

Boolean autoAssignElasticIps

Whether to automatically assign an Elastic IP address to the layer.

customRecipes

Recipes customRecipes

A LayerCustomRecipes object that specifies the layer's custom recipes.

Class com.amazonaws.services.opsworks.model.UpdateStackRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackId

String stackId

The stack ID.

name

String name

The stack's new name.

attributes

Map<K,V> attributes

One or more user-defined key/value pairs to be added to the stack attributes bag.

serviceRoleArn

String serviceRoleArn

The stack AWS Identity and Access Management (IAM) role, which allows OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers. You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the stack's current service role ARN, if you prefer, but you must do so explicitly.

defaultInstanceProfileArn

String defaultInstanceProfileArn

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

defaultOs

String defaultOs

The cloned stack default operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

hostnameTheme

String hostnameTheme

The stack's new host name theme, with spaces are replaced by underscores. The theme is used to generate hostnames for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates hostnames by appending integers to the layer's shortname. The other themes are:

• Baked_Goods
• Clouds
• European_Cities
• Fruits
• Greek_Deities
• Legendary_Creatures_from_Japan
• Planets_and_Moons
• Roman_Deities
• Scottish_Islands
• US_Cities
• Wild_Cats

To obtain a generated hostname, call GetHostNameSuggestion, which returns a hostname based on the current theme.

defaultAvailabilityZone

String defaultAvailabilityZone

The stack new default Availability Zone. For more information, see Regions and Endpoints.

customJson

String customJson

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '"'.: "{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.

useCustomCookbooks

Boolean useCustomCookbooks

Whether the stack uses custom cookbooks.

customCookbooksSource

Source customCookbooksSource

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.

defaultSshKeyName

String defaultSshKeyName

A default SSH key for the stack instances. You can override this value when you create or update an instance.

defaultRootDeviceType

String defaultRootDeviceType

The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

Constraints:
Allowed Values: ebs, instance-store

Class com.amazonaws.services.opsworks.model.UpdateUserProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

iamUserArn

String iamUserArn

The user IAM ARN.

sshUsername

String sshUsername

The user's new SSH user name.

sshPublicKey

String sshPublicKey

The user's new SSH public key.

Class com.amazonaws.services.opsworks.model.UserProfile extends Object implements Serializable

Serialized Fields

iamUserArn

String iamUserArn

The user IAM ARN.

name

String name

The user name.

sshUsername

String sshUsername

The user's SSH user name.

sshPublicKey

String sshPublicKey

The user's SSH public key.

Class com.amazonaws.services.opsworks.model.ValidationException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.opsworks.model.Volume extends Object implements Serializable

Serialized Fields

volumeId

String volumeId

The volume ID.

ec2VolumeId

String ec2VolumeId

The Amazon EC2 volume ID.

name

String name

The volume name.

raidArrayId

String raidArrayId

The RAID array ID.

instanceId

String instanceId

The instance ID.

status

String status

The value returned by DescribeVolumes.

size

Integer size

The volume size.

device

String device

The device name.

mountPoint

String mountPoint

The volume mount point. For example "/dev/sdh".

region

String region

The AWS region. For more information about AWS regions, see Regions and Endpoints.

availabilityZone

String availabilityZone

The volume Availability Zone. For more information, see Regions and Endpoints.

Class com.amazonaws.services.opsworks.model.VolumeConfiguration extends Object implements Serializable

Serialized Fields

mountPoint

String mountPoint

The volume mount point. For example "/dev/sdh".

raidLevel

Integer raidLevel

The volume RAID level.

numberOfDisks

Integer numberOfDisks

The number of disks in the volume.

size

Integer size

The volume size.

Class com.amazonaws.services.opsworks.model.WeeklyAutoScalingSchedule extends Object implements Serializable

Serialized Fields

monday

Map<K,V> monday

The schedule for Monday.

tuesday

Map<K,V> tuesday

The schedule for Tuesday.

wednesday

Map<K,V> wednesday

The schedule for Wednesday.

thursday

Map<K,V> thursday

The schedule for Thursday.

friday

Map<K,V> friday

The schedule for Friday.

saturday

Map<K,V> saturday

The schedule for Saturday.

sunday

Map<K,V> sunday

The schedule for Sunday.

Package com.amazonaws.services.rds.model

Class com.amazonaws.services.rds.model.AddSourceIdentifierToSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

subscriptionName

String subscriptionName

The name of the RDS event notification subscription you want to add a source identifier to.

sourceIdentifier

String sourceIdentifier

The identifier of the event source to be added. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

Constraints:

• If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.
• If the source type is a DB security group, a DBSecurityGroupName must be supplied.
• If the source type is a DB parameter group, a DBParameterGroupName must be supplied.
• If the source type is a DB Snapshot, a DBSnapshotIdentifier must be supplied.

Class com.amazonaws.services.rds.model.AddTagsToResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceName

String resourceName

The DB Instance the tags will be added to.

tags

List<E> tags

The tags to be assigned to the DB Instance.

Class com.amazonaws.services.rds.model.AuthorizationAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.AuthorizationNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.AuthorizationQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.AuthorizeDBSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBSecurityGroupName

String dBSecurityGroupName

The name of the DB Security Group to add authorization to.

cIDRIP

String cIDRIP

The IP range to authorize.

eC2SecurityGroupName

String eC2SecurityGroupName

Name of the EC2 Security Group to authorize. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

eC2SecurityGroupId

String eC2SecurityGroupId

Id of the EC2 Security Group to authorize. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

eC2SecurityGroupOwnerId

String eC2SecurityGroupOwnerId

AWS Account Number of the owner of the EC2 Security Group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

Class com.amazonaws.services.rds.model.AvailabilityZone extends Object implements Serializable

Serialized Fields

name

String name

The name of the availability zone.

provisionedIopsCapable

Boolean provisionedIopsCapable

True indicates the availability zone is capable of provisioned IOPs.

Class com.amazonaws.services.rds.model.CharacterSet extends Object implements Serializable

Serialized Fields

characterSetName

String characterSetName

The name of the character set.

characterSetDescription

String characterSetDescription

The description of the character set.

Class com.amazonaws.services.rds.model.CopyDBSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sourceDBSnapshotIdentifier

String sourceDBSnapshotIdentifier

The identifier for the source DB snapshot.

Constraints:

• Must be the identifier for a valid system snapshot in the "available" state.

Example: rds:mydb-2012-04-02-00-01

targetDBSnapshotIdentifier

String targetDBSnapshotIdentifier

The identifier for the copied snapshot.

Constraints:

• Cannot be null, empty, or blank
• Must contain from 1 to 255 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

Class com.amazonaws.services.rds.model.CreateDBInstanceReadReplicaRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBInstanceIdentifier

String dBInstanceIdentifier

The DB Instance identifier of the Read Replica. This is the unique key that identifies a DB Instance. This parameter is stored as a lowercase string.

sourceDBInstanceIdentifier

String sourceDBInstanceIdentifier

The identifier of the DB Instance that will act as the source for the Read Replica. Each DB Instance can have up to five Read Replicas.

Constraints: Must be the identifier of an existing DB Instance that is not already a Read Replica DB Instance.

dBInstanceClass

String dBInstanceClass

The compute and memory capacity of the Read Replica.

Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge

Default: Inherits from the source DB Instance.

availabilityZone

String availabilityZone

The Amazon EC2 Availability Zone that the Read Replica will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

port

Integer port

The port number that the DB Instance uses for connections.

Default: Inherits from the source DB Instance

Valid Values: 1150-65535

autoMinorVersionUpgrade

Boolean autoMinorVersionUpgrade

Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB Instance

iops

Integer iops

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.

optionGroupName

String optionGroupName

The option group the DB instance will be associated with. If omitted, the default Option Group for the engine specified will be used.

publiclyAccessible

Boolean publiclyAccessible

Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true
• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

Class com.amazonaws.services.rds.model.CreateDBInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBName

String dBName

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the DB Instance is created. If this parameter is not specified, no database is created in the DB Instance.

Constraints:

• Must contain 1 to 64 alphanumeric characters
• Cannot be a word reserved by the specified database engine

Type: String

Oracle

The Oracle System ID (SID) of the created DB Instance.

Default: ORCL

Constraints:

• Cannot be longer than 8 characters

SQL Server

Not applicable. Must be null.

dBInstanceIdentifier

String dBInstanceIdentifier

The DB Instance identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server).
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

allocatedStorage

Integer allocatedStorage

The amount of storage (in gigabytes) to be initially allocated for the database instance.

MySQL

Constraints: Must be an integer from 5 to 1024.

Type: Integer

Oracle

Constraints: Must be an integer from 10 to 1024.

SQL Server

Constraints: Must be an integer from 200 to 1024 (Standard Edition and Enterprise Edition) or from 30 to 1024 (Express Edition and Web Edition)

dBInstanceClass

String dBInstanceClass

The compute and memory capacity of the DB Instance.

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge

engine

String engine

The name of the database engine to be used for this instance.

Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web

masterUsername

String masterUsername

The name of master user for the client DB Instance.

MySQL

Constraints:

• Must be 1 to 16 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word for the chosen database engine.

Type: String

Oracle

Constraints:

• Must be 1 to 30 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word for the chosen database engine.

SQL Server

Constraints:

• Must be 1 to 128 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word for the chosen database engine.

masterUserPassword

String masterUserPassword

The password for the master database user. Can be any printable ASCII character except "/", "\", or "@".

Type: String

MySQL

Constraints: Must contain from 8 to 41 alphanumeric characters.

Oracle

Constraints: Must contain from 8 to 30 alphanumeric characters.

SQL Server

Constraints: Must contain from 8 to 128 alphanumeric characters.

dBSecurityGroups

List<E> dBSecurityGroups

A list of DB Security Groups to associate with this DB Instance.

Default: The default DB Security Group for the database engine.

vpcSecurityGroupIds

List<E> vpcSecurityGroupIds

A list of EC2 VPC Security Groups to associate with this DB Instance.

Default: The default EC2 VPC Security Group for the DB Subnet group's VPC.

availabilityZone

String availabilityZone

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.

dBSubnetGroupName

String dBSubnetGroupName

A DB Subnet Group to associate with this DB Instance.

If there is no DB Subnet Group, then it is a non-VPC DB instance.

preferredMaintenanceWindow

String preferredMaintenanceWindow

The weekly time range (in UTC) during which system maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

dBParameterGroupName

String dBParameterGroupName

The name of the DB Parameter Group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

backupRetentionPeriod

Integer backupRetentionPeriod

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

• Must be a value from 0 to 8
• Cannot be set to 0 if the DB Instance is a master instance with read replicas

preferredBackupWindow

String preferredBackupWindow

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned.

• US-East (Northern Virginia) Region: 03:00-11:00 UTC
• US-West (Northern California) Region: 06:00-14:00 UTC
• EU (Ireland) Region: 22:00-06:00 UTC
• Asia Pacific (Singapore) Region: 14:00-22:00 UTC
• Asia Pacific (Tokyo) Region: 17:00-03:00 UTC

Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.

port

Integer port

The port number on which the database accepts connections.

MySQL

Default: 3306

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

SQL Server

Default: 1433

Valid Values: 1150-65535 except for 1434 and 3389.

multiAZ

Boolean multiAZ

Specifies if the DB Instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

engineVersion

String engineVersion

The version number of the database engine to use.

MySQL

Example: 5.1.42

Type: String

Oracle

Example: 11.2.0.2.v2

Type: String

SQL Server

Example: 10.50.2789.0.v1

autoMinorVersionUpgrade

Boolean autoMinorVersionUpgrade

Indicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window.

Default: true

licenseModel

String licenseModel

License model information for this DB Instance.

Valid values: license-included | bring-your-own-license | general-public-license

iops

Integer iops

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.

Constraints: Must be an integer greater than 1000.

optionGroupName

String optionGroupName

Indicates that the DB Instance should be associated with the specified option group.

characterSetName

String characterSetName

For supported engines, indicates that the DB Instance should be associated with the specified CharacterSet.

publiclyAccessible

Boolean publiclyAccessible

Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true
• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

Class com.amazonaws.services.rds.model.CreateDBParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBParameterGroupName

String dBParameterGroupName

The name of the DB Parameter Group.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

This value is stored as a lower-case string.

dBParameterGroupFamily

String dBParameterGroupFamily

The DB Parameter Group Family name. A DB Parameter Group can be associated with one and only one DB Parameter Group Family, and can be applied only to a DB Instance running a database engine and engine version compatible with that DB Parameter Group Family.

description

String description

The description for the DB Parameter Group.

Class com.amazonaws.services.rds.model.CreateDBSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBSecurityGroupName

String dBSecurityGroupName

The name for the DB Security Group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".

Example: mysecuritygroup

dBSecurityGroupDescription

String dBSecurityGroupDescription

The description for the DB Security Group.

Class com.amazonaws.services.rds.model.CreateDBSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBSnapshotIdentifier

String dBSnapshotIdentifier

The identifier for the DB Snapshot.

Constraints:

• Cannot be null, empty, or blank
• Must contain from 1 to 255 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

dBInstanceIdentifier

String dBInstanceIdentifier

The DB Instance identifier. This is the unique key that identifies a DB Instance. This parameter isn't case sensitive.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Class com.amazonaws.services.rds.model.CreateDBSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBSubnetGroupName

String dBSubnetGroupName

The name for the DB Subnet Group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".

Example: mySubnetgroup

dBSubnetGroupDescription

String dBSubnetGroupDescription

The description for the DB Subnet Group.

subnetIds

List<E> subnetIds

The EC2 Subnet IDs for the DB Subnet Group.

Class com.amazonaws.services.rds.model.CreateEventSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

subscriptionName

String subscriptionName

The name of the subscription.

Constraints: The name must be less than 255 characters.

snsTopicArn

String snsTopicArn

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

sourceType

String sourceType

The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

eventCategories

List<E> eventCategories

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

sourceIds

List<E> sourceIds

The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

Constraints:

• If SourceIds are supplied, SourceType must also be provided.
• If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.
• If the source type is a DB security group, a DBSecurityGroupName must be supplied.
• If the source type is a DB parameter group, a DBParameterGroupName must be supplied.
• If the source type is a DB Snapshot, a DBSnapshotIdentifier must be supplied.

enabled

Boolean enabled

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

Class com.amazonaws.services.rds.model.CreateOptionGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

optionGroupName

String optionGroupName

Specifies the name of the option group to be created.

Constraints:

• Must be 1 to 255 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Example: myOptiongroup

engineName

String engineName

Specifies the name of the engine that this option group should be associated with.

majorEngineVersion

String majorEngineVersion

Specifies the major version of the engine that this option group should be associated with.

optionGroupDescription

String optionGroupDescription

The description of the option group.

Class com.amazonaws.services.rds.model.DBEngineVersion extends Object implements Serializable

Serialized Fields

engine

String engine

The name of the database engine.

engineVersion

String engineVersion

The version number of the database engine.

dBParameterGroupFamily

String dBParameterGroupFamily

The name of the DBParameterGroupFamily for the database engine.

dBEngineDescription

String dBEngineDescription

The description of the database engine.

dBEngineVersionDescription

String dBEngineVersionDescription

The description of the database engine version.

defaultCharacterSet

CharacterSet defaultCharacterSet

The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.

supportedCharacterSets

List<E> supportedCharacterSets

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance API.

Class com.amazonaws.services.rds.model.DBInstance extends Object implements Serializable

Serialized Fields

dBInstanceIdentifier

String dBInstanceIdentifier

Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance.

dBInstanceClass

String dBInstanceClass

Contains the name of the compute and memory capacity class of the DB Instance.

engine

String engine

Provides the name of the database engine to be used for this DB Instance.

dBInstanceStatus

String dBInstanceStatus

Specifies the current state of this database.

masterUsername

String masterUsername

Contains the master username for the DB Instance.

dBName

String dBName

The meaning of this parameter differs according to the database engine you use.

MySQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created. This same name is returned for the life of the DB Instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB Instance.

endpoint

Endpoint endpoint

Specifies the connection endpoint.

allocatedStorage

Integer allocatedStorage

Specifies the allocated storage size specified in gigabytes.

instanceCreateTime

Date instanceCreateTime

Provides the date and time the DB Instance was created.

preferredBackupWindow

String preferredBackupWindow

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

backupRetentionPeriod

Integer backupRetentionPeriod

Specifies the number of days for which automatic DB Snapshots are retained.

dBSecurityGroups

List<E> dBSecurityGroups

Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

vpcSecurityGroups

List<E> vpcSecurityGroups

Provides List of VPC security group elements that the DB Instance belongs to.

dBParameterGroups

List<E> dBParameterGroups

Provides the list of DB Parameter Groups applied to this DB Instance.

availabilityZone

String availabilityZone

Specifies the name of the Availability Zone the DB Instance is located in.

dBSubnetGroup

DBSubnetGroup dBSubnetGroup

Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.

preferredMaintenanceWindow

String preferredMaintenanceWindow

Specifies the weekly time range (in UTC) during which system maintenance can occur.

pendingModifiedValues

PendingModifiedValues pendingModifiedValues

Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

latestRestorableTime

Date latestRestorableTime

Specifies the latest time to which a database can be restored with point-in-time restore.

multiAZ

Boolean multiAZ

Specifies if the DB Instance is a Multi-AZ deployment.

engineVersion

String engineVersion

Indicates the database engine version.

autoMinorVersionUpgrade

Boolean autoMinorVersionUpgrade

Indicates that minor version patches are applied automatically.

readReplicaSourceDBInstanceIdentifier

String readReplicaSourceDBInstanceIdentifier

Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.

readReplicaDBInstanceIdentifiers

List<E> readReplicaDBInstanceIdentifiers

Contains one or more identifiers of the Read Replicas associated with this DB Instance.

licenseModel

String licenseModel

License model information for this DB Instance.

iops

Integer iops

Specifies the Provisioned IOPS (I/O operations per second) value.

optionGroupMemberships

List<E> optionGroupMemberships

Provides the list of option group memberships for this DB Instance.

characterSetName

String characterSetName

If present, specifies the name of the character set that this instance is associated with.

secondaryAvailabilityZone

String secondaryAvailabilityZone

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

publiclyAccessible

Boolean publiclyAccessible

Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true
• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

Class com.amazonaws.services.rds.model.DBInstanceAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.DBInstanceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.DBParameterGroup extends Object implements Serializable

Serialized Fields

dBParameterGroupName

String dBParameterGroupName

Provides the name of the DB Parameter Group.

dBParameterGroupFamily

String dBParameterGroupFamily

Provides the name of the DB Parameter Group Family that this DB Parameter Group is compatible with.

description

String description

Provides the customer-specified description for this DB Parameter Group.

Class com.amazonaws.services.rds.model.DBParameterGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.DBParameterGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.DBParameterGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.DBParameterGroupStatus extends Object implements Serializable

Serialized Fields

dBParameterGroupName

String dBParameterGroupName

The name of the DP Parameter Group.

parameterApplyStatus

String parameterApplyStatus

The status of parameter updates.

Class com.amazonaws.services.rds.model.DBSecurityGroup extends Object implements Serializable

Serialized Fields

ownerId

String ownerId

Provides the AWS ID of the owner of a specific DB Security Group.

dBSecurityGroupName

String dBSecurityGroupName

Specifies the name of the DB Security Group.

dBSecurityGroupDescription

String dBSecurityGroupDescription

Provides the description of the DB Security Group.

vpcId

String vpcId

Provides the VpcId of the DB Security Group.

eC2SecurityGroups

List<E> eC2SecurityGroups

Contains a list of EC2SecurityGroup elements.

iPRanges

List<E> iPRanges

Contains a list of IPRange elements.

Class com.amazonaws.services.rds.model.DBSecurityGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.DBSecurityGroupMembership extends Object implements Serializable

Serialized Fields

dBSecurityGroupName

String dBSecurityGroupName

The name of the DB Security Group.

status

String status

The status of the DB Security Group.

Class com.amazonaws.services.rds.model.DBSecurityGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.DBSecurityGroupNotSupportedException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.DBSecurityGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.DBSnapshot extends Object implements Serializable

Serialized Fields

dBSnapshotIdentifier

String dBSnapshotIdentifier

Specifies the identifier for the DB Snapshot.

dBInstanceIdentifier

String dBInstanceIdentifier

Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from.

snapshotCreateTime

Date snapshotCreateTime

Provides the time (UTC) when the snapshot was taken.

engine

String engine

Specifies the name of the database engine.

allocatedStorage

Integer allocatedStorage

Specifies the allocated storage size in gigabytes (GB).

status

String status

Specifies the status of this DB Snapshot.

port

Integer port

Specifies the port that the database engine was listening on at the time of the snapshot.

availabilityZone

String availabilityZone

Specifies the name of the Availability Zone the DB Instance was located in at the time of the DB Snapshot.

vpcId

String vpcId

Provides the Vpc Id associated with the DB Snapshot.

instanceCreateTime

Date instanceCreateTime

Specifies the time (UTC) when the snapshot was taken.

masterUsername

String masterUsername

Provides the master username for the DB Snapshot.

engineVersion

String engineVersion

Specifies the version of the database engine.

licenseModel

String licenseModel

License model information for the restored DB Instance.

snapshotType

String snapshotType

Provides the type of the DB Snapshot.

iops

Integer iops

Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot.

optionGroupName

String optionGroupName

Provides the option group name for the DB Snapshot.

Class com.amazonaws.services.rds.model.DBSnapshotAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.DBSnapshotNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.DBSubnetGroup extends Object implements Serializable

Serialized Fields

dBSubnetGroupName

String dBSubnetGroupName

Specifies the name of the DB Subnet Group.

dBSubnetGroupDescription

String dBSubnetGroupDescription

Provides the description of the DB Subnet Group.

vpcId

String vpcId

Provides the VpcId of the DB Subnet Group.

subnetGroupStatus

String subnetGroupStatus

Provides the status of the DB Subnet Group.

subnets

List<E> subnets

Contains a list of Subnet elements.

Class com.amazonaws.services.rds.model.DBSubnetGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.DBSubnetGroupDoesNotCoverEnoughAZsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.DBSubnetGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.DBSubnetGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.DBSubnetQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.DeleteDBInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBInstanceIdentifier

String dBInstanceIdentifier

The DB Instance identifier for the DB Instance to be deleted. This parameter isn't case sensitive.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

skipFinalSnapshot

Boolean skipFinalSnapshot

Determines whether a final DB Snapshot is created before the DB Instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB Snapshot is created before the DB Instance is deleted. The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

Default: false

finalDBSnapshotIdentifier

String finalDBSnapshotIdentifier

The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false. Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Class com.amazonaws.services.rds.model.DeleteDBParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBParameterGroupName

String dBParameterGroupName

The name of the DB Parameter Group.

Constraints:

• Must be the name of an existing DB Parameter Group
• You cannot delete a default DB Parameter Group
• Cannot be associated with any DB Instances

Class com.amazonaws.services.rds.model.DeleteDBSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBSecurityGroupName

String dBSecurityGroupName

The name of the DB Security Group to delete. You cannot delete the default DB Security Group.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Class com.amazonaws.services.rds.model.DeleteDBSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBSnapshotIdentifier

String dBSnapshotIdentifier

The DBSnapshot identifier.

Constraints: Must be the name of an existing DB Snapshot in the available state.

Class com.amazonaws.services.rds.model.DeleteDBSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBSubnetGroupName

String dBSubnetGroupName

The name of the database subnet group to delete. You cannot delete the default subnet group.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Class com.amazonaws.services.rds.model.DeleteEventSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

subscriptionName

String subscriptionName

The name of the RDS event notification subscription you want to delete.

Class com.amazonaws.services.rds.model.DeleteOptionGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

optionGroupName

String optionGroupName

The name of the option group to be deleted. You cannot delete default Option Groups.

Class com.amazonaws.services.rds.model.DescribeDBEngineVersionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

engine

String engine

The database engine to return.

engineVersion

String engineVersion

The database engine version to return.

Example: 5.1.49

dBParameterGroupFamily

String dBParameterGroupFamily

The name of a specific DB Parameter Group family to return details for.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

marker

String marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

defaultOnly

Boolean defaultOnly

Indicates that only the default version of the specified engine or engine and major version combination is returned.

listSupportedCharacterSets

Boolean listSupportedCharacterSets

If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

Class com.amazonaws.services.rds.model.DescribeDBEngineVersionsResult extends Object implements Serializable

Serialized Fields

marker

String marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

dBEngineVersions

List<E> dBEngineVersions

A list of DBEngineVersion elements.

Class com.amazonaws.services.rds.model.DescribeDBInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBInstanceIdentifier

String dBInstanceIdentifier

The user-supplied instance identifier. If this parameter is specified, information from only the specific DB Instance is returned. This parameter isn't case sensitive.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

marker

String marker

An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

Class com.amazonaws.services.rds.model.DescribeDBInstancesResult extends Object implements Serializable

Serialized Fields

marker

String marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

dBInstances

List<E> dBInstances

A list of DBInstance instances.

Class com.amazonaws.services.rds.model.DescribeDBLogFilesDetails extends Object implements Serializable

Serialized Fields

logFileName

String logFileName

The name of the log file for the specified DB instance.

lastWritten

Long lastWritten

The date and time that the last log entry was written.

size

Long size

The size, in bytes, of the log file for the specified DB instance.

Class com.amazonaws.services.rds.model.DescribeDBLogFilesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBInstanceIdentifier

String dBInstanceIdentifier

The customer-assigned name of the DB Instance that contains the log files you want to list.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

filenameContains

String filenameContains

Filters the available log files for log file names that contain the specified string.

fileLastWritten

Long fileLastWritten

Filters the available log files for files written since the specified date.

fileSize

Long fileSize

Filters the available log files for files larger than the specified size.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

marker

String marker

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

Class com.amazonaws.services.rds.model.DescribeDBLogFilesResult extends Object implements Serializable

Serialized Fields

describeDBLogFiles

List<E> describeDBLogFiles

The DB log files returned.

marker

String marker

An optional paging token.

Class com.amazonaws.services.rds.model.DescribeDBParameterGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBParameterGroupName

String dBParameterGroupName

The name of a specific DB Parameter Group to return details for.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

marker

String marker

An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.rds.model.DescribeDBParameterGroupsResult extends Object implements Serializable

Serialized Fields

marker

String marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

dBParameterGroups

List<E> dBParameterGroups

A list of DBParameterGroup instances.

Class com.amazonaws.services.rds.model.DescribeDBParametersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBParameterGroupName

String dBParameterGroupName

The name of a specific DB Parameter Group to return details for.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

source

String source

The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

marker

String marker

An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.rds.model.DescribeDBParametersResult extends Object implements Serializable

Serialized Fields

parameters

List<E> parameters

A list of Parameter instances.

marker

String marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.rds.model.DescribeDBSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBSecurityGroupName

String dBSecurityGroupName

The name of the DB Security Group to return details for.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

marker

String marker

An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.rds.model.DescribeDBSecurityGroupsResult extends Object implements Serializable

Serialized Fields

marker

String marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

dBSecurityGroups

List<E> dBSecurityGroups

A list of DBSecurityGroup instances.

Class com.amazonaws.services.rds.model.DescribeDBSnapshotsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBInstanceIdentifier

String dBInstanceIdentifier

A DB Instance Identifier to retrieve the list of DB Snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter isn't case sensitive.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

dBSnapshotIdentifier

String dBSnapshotIdentifier

A specific DB Snapshot Identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens
• If this is the identifier of an automated snapshot, the SnapshotType parameter must also be specified.

snapshotType

String snapshotType

An optional snapshot type for which snapshots will be returned. If not specified, the returned results will include snapshots of all types.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

marker

String marker

An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.rds.model.DescribeDBSnapshotsResult extends Object implements Serializable

Serialized Fields

marker

String marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

dBSnapshots

List<E> dBSnapshots

A list of DBSnapshot instances.

Class com.amazonaws.services.rds.model.DescribeDBSubnetGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBSubnetGroupName

String dBSubnetGroupName

The name of the DB Subnet Group to return details for.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

marker

String marker

An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.rds.model.DescribeDBSubnetGroupsResult extends Object implements Serializable

Serialized Fields

marker

String marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

dBSubnetGroups

List<E> dBSubnetGroups

A list of DBSubnetGroup instances.

Class com.amazonaws.services.rds.model.DescribeEngineDefaultParametersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBParameterGroupFamily

String dBParameterGroupFamily

The name of the DB Parameter Group Family.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

marker

String marker

An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.rds.model.DescribeEventCategoriesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sourceType

String sourceType

The type of source that will be generating the events.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

Class com.amazonaws.services.rds.model.DescribeEventCategoriesResult extends Object implements Serializable

Serialized Fields

eventCategoriesMapList

List<E> eventCategoriesMapList

A list of EventCategoriesMap data types.

Class com.amazonaws.services.rds.model.DescribeEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sourceIdentifier

String sourceIdentifier

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

Constraints:

• If SourceIdentifier is supplied, SourceType must also be provided.
• If the source type is DBInstance, then a DBInstanceIdentifier must be supplied.
• If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied.
• If the source type is DBParameterGroup, a DBParameterGroupName must be supplied.
• If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied.
• Cannot end with a hyphen or contain two consecutive hyphens.

sourceType

String sourceType

The event source to retrieve events for. If no value is specified, all events are returned.

Constraints:
Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot

startTime

Date startTime

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

endTime

Date endTime

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

duration

Integer duration

The number of minutes to retrieve events for.

Default: 60

eventCategories

List<E> eventCategories

A list of event categories that trigger notifications for a event notification subscription.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

marker

String marker

An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.rds.model.DescribeEventsResult extends Object implements Serializable

Serialized Fields

marker

String marker

An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

events

List<E> events

A list of Event instances.

Class com.amazonaws.services.rds.model.DescribeEventSubscriptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

subscriptionName

String subscriptionName

The name of the RDS event notification subscription you want to describe.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

marker

String marker

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

Class com.amazonaws.services.rds.model.DescribeEventSubscriptionsResult extends Object implements Serializable

Serialized Fields

marker

String marker

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

eventSubscriptionsList

List<E> eventSubscriptionsList

A list of EventSubscriptions data types.

Class com.amazonaws.services.rds.model.DescribeOptionGroupOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

engineName

String engineName

A required parameter. Options available for the given Engine name will be described.

majorEngineVersion

String majorEngineVersion

If specified, filters the results to include only options for the specified major engine version.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

marker

String marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.rds.model.DescribeOptionGroupOptionsResult extends Object implements Serializable

Serialized Fields

optionGroupOptions

List<E> optionGroupOptions

List of available option group options.

marker

String marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.rds.model.DescribeOptionGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

optionGroupName

String optionGroupName

The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.

marker

String marker

An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

engineName

String engineName

Filters the list of option groups to only include groups associated with a specific database engine.

majorEngineVersion

String majorEngineVersion

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

Class com.amazonaws.services.rds.model.DescribeOptionGroupsResult extends Object implements Serializable

Serialized Fields

optionGroupsList

List<E> optionGroupsList

List of option groups.

marker

String marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.rds.model.DescribeOrderableDBInstanceOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

engine

String engine

The name of the engine to retrieve DB Instance options for.

engineVersion

String engineVersion

The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

dBInstanceClass

String dBInstanceClass

The DB Instance class filter value. Specify this parameter to show only the available offerings matching the specified DB Instance class.

licenseModel

String licenseModel

The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

vpc

Boolean vpc

The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

marker

String marker

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

Class com.amazonaws.services.rds.model.DescribeOrderableDBInstanceOptionsResult extends Object implements Serializable

Serialized Fields

orderableDBInstanceOptions

List<E> orderableDBInstanceOptions

An OrderableDBInstanceOption structure containing information about orderable options for the DB Instance.

marker

String marker

An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

Class com.amazonaws.services.rds.model.DescribeReservedDBInstancesOfferingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

reservedDBInstancesOfferingId

String reservedDBInstancesOfferingId

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

dBInstanceClass

String dBInstanceClass

The DB Instance class filter value. Specify this parameter to show only the available offerings matching the specified DB Instance class.

duration

String duration

Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

productDescription

String productDescription

Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.

offeringType

String offeringType

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Light Utilization" | "Medium Utilization" | "Heavy Utilization"

multiAZ

Boolean multiAZ

The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

marker

String marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.rds.model.DescribeReservedDBInstancesOfferingsResult extends Object implements Serializable

Serialized Fields

marker

String marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

reservedDBInstancesOfferings

List<E> reservedDBInstancesOfferings

A list of reserved DB Instance offerings.

Class com.amazonaws.services.rds.model.DescribeReservedDBInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

reservedDBInstanceId

String reservedDBInstanceId

The reserved DB Instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

reservedDBInstancesOfferingId

String reservedDBInstancesOfferingId

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

dBInstanceClass

String dBInstanceClass

The DB Instance class filter value. Specify this parameter to show only those reservations matching the specified DB Instances class.

duration

String duration

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

productDescription

String productDescription

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

offeringType

String offeringType

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Light Utilization" | "Medium Utilization" | "Heavy Utilization"

multiAZ

Boolean multiAZ

The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

marker

String marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.rds.model.DescribeReservedDBInstancesResult extends Object implements Serializable

Serialized Fields

marker

String marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

reservedDBInstances

List<E> reservedDBInstances

A list of of reserved DB Instances.

Class com.amazonaws.services.rds.model.DownloadDBLogFilePortionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBInstanceIdentifier

String dBInstanceIdentifier

The customer-assigned name of the DB Instance that contains the log files you want to list.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

logFileName

String logFileName

The name of the log file to be downloaded.

marker

String marker

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

numberOfLines

Integer numberOfLines

The number of lines remaining to be downloaded.

Class com.amazonaws.services.rds.model.DownloadDBLogFilePortionResult extends Object implements Serializable

Serialized Fields

logFileData

String logFileData

Entries from the specified log file.

marker

String marker

An optional pagination token provided by a previous DownloadDBLogFilePortion request.

additionalDataPending

Boolean additionalDataPending

Boolean value that if true, indicates there is more data to be downloaded.

Class com.amazonaws.services.rds.model.EC2SecurityGroup extends Object implements Serializable

Serialized Fields

status

String status

Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".

eC2SecurityGroupName

String eC2SecurityGroupName

Specifies the name of the EC2 Security Group.

eC2SecurityGroupId

String eC2SecurityGroupId

Specifies the id of the EC2 Security Group.

eC2SecurityGroupOwnerId

String eC2SecurityGroupOwnerId

Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

Class com.amazonaws.services.rds.model.Endpoint extends Object implements Serializable

Serialized Fields

address

String address

Specifies the DNS address of the DB Instance.

port

Integer port

Specifies the port that the database engine is listening on.

Class com.amazonaws.services.rds.model.EngineDefaults extends Object implements Serializable

Serialized Fields

dBParameterGroupFamily

String dBParameterGroupFamily

Specifies the name of the DB Parameter Group Family which the engine default parameters apply to.

marker

String marker

An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

parameters

List<E> parameters

Contains a list of engine default parameters.

Class com.amazonaws.services.rds.model.Event extends Object implements Serializable

Serialized Fields

sourceIdentifier

String sourceIdentifier

Provides the identifier for the source of the event.

sourceType

String sourceType

Specifies the source type for this event.

Constraints:
Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot

message

String message

Provides the text of this event.

eventCategories

List<E> eventCategories

Specifies the category for the event.

date

Date date

Specifies the date and time of the event.

Class com.amazonaws.services.rds.model.EventCategoriesMap extends Object implements Serializable

Serialized Fields

sourceType

String sourceType

The source type that the returned categories belong to

eventCategories

List<E> eventCategories

The event categories for the specified source type

Class com.amazonaws.services.rds.model.EventSubscription extends Object implements Serializable

Serialized Fields

customerAwsId

String customerAwsId

The AWS customer account associated with the RDS event notification subscription.

custSubscriptionId

String custSubscriptionId

The RDS event notification subscription Id.

snsTopicArn

String snsTopicArn

The topic ARN of the RDS event notification subscription.

status

String status

The status of the RDS event notification subscription.

Constraints:

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

subscriptionCreationTime

String subscriptionCreationTime

The time the RDS event notification subscription was created.

sourceType

String sourceType

The source type for the RDS event notification subscription.

sourceIdsList

List<E> sourceIdsList

A list of source Ids for the RDS event notification subscription.

eventCategoriesList

List<E> eventCategoriesList

A list of event categories for the RDS event notification subscription.

enabled

Boolean enabled

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

Class com.amazonaws.services.rds.model.EventSubscriptionQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.InstanceQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.InsufficientDBInstanceCapacityException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.InvalidDBInstanceStateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.InvalidDBParameterGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.InvalidDBSecurityGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.InvalidDBSnapshotStateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.InvalidDBSubnetGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.InvalidDBSubnetStateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.InvalidEventSubscriptionStateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.InvalidOptionGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.InvalidRestoreException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.InvalidSubnetException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.InvalidVPCNetworkStateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.IPRange extends Object implements Serializable

Serialized Fields

status

String status

Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".

cIDRIP

String cIDRIP

Specifies the IP range.

Class com.amazonaws.services.rds.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceName

String resourceName

The DB Instance with tags to be listed.

Class com.amazonaws.services.rds.model.ListTagsForResourceResult extends Object implements Serializable

Serialized Fields

tagList

List<E> tagList

List of tags returned by the ListTagsForResource operation.

Class com.amazonaws.services.rds.model.ModifyDBInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBInstanceIdentifier

String dBInstanceIdentifier

The DB Instance identifier. This value is stored as a lowercase string.

Constraints:

• Must be the identifier for an existing DB Instance
• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

allocatedStorage

Integer allocatedStorage

The new storage capacity of the RDS instance. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

MySQL

Default: Uses existing setting

Valid Values: 5-1024

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Type: Integer

Oracle

Default: Uses existing setting

Valid Values: 10-1024

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

SQL Server

Cannot be modified.

dBInstanceClass

String dBInstanceClass

The new compute and memory capacity of the DB Instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.

Passing a value for this parameter causes an outage during the change and is applied during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request.

Default: Uses existing setting

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge

dBSecurityGroups

List<E> dBSecurityGroups

A list of DB Security Groups to authorize on this DB Instance. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

vpcSecurityGroupIds

List<E> vpcSecurityGroupIds

A list of EC2 VPC Security Groups to authorize on this DB Instance. This change is asynchronously applied as soon as possible.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

applyImmediately

Boolean applyImmediately

Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance.

If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first. See each parameter to determine when a change is applied.

Default: false

masterUserPassword

String masterUserPassword

The new password for the DB Instance master user. Can be any printable ASCII character except "/", "\", or "@".

Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Default: Uses existing setting

Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server). Amazon RDS API actions never return the password, so this action provides a way to regain access to a master instance user if the password is lost.

dBParameterGroupName

String dBParameterGroupName

The name of the DB Parameter Group to apply to this DB Instance. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Default: Uses existing setting

Constraints: The DB Parameter Group must be in the same DB Parameter Group family as this DB Instance.

backupRetentionPeriod

Integer backupRetentionPeriod

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

Default: Uses existing setting

Constraints:

• Must be a value from 0 to 8
• Cannot be set to 0 if the DB Instance is a master instance with read replicas or if the DB Instance is a read replica

preferredBackupWindow

String preferredBackupWindow

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

• Must be in the format hh24:mi-hh24:mi
• Times should be Universal Time Coordinated (UTC)
• Must not conflict with the preferred maintenance window
• Must be at least 30 minutes

preferredMaintenanceWindow

String preferredMaintenanceWindow

The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB Instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

Format: ddd:hh24:mi-ddd:hh24:mi

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

multiAZ

Boolean multiAZ

Specifies if the DB Instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Constraints: Cannot be specified if the DB Instance is a read replica.

engineVersion

String engineVersion

The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

For major version upgrades, if a nondefault DB Parameter Group is currently in use, a new DB Parameter Group in the DB Parameter Group Family for the new engine version must be specified. The new DB Parameter Group can be the default for that DB Parameter Group Family.

Example: 5.1.42

allowMajorVersionUpgrade

Boolean allowMajorVersionUpgrade

Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB Instance's current version.

autoMinorVersionUpgrade

Boolean autoMinorVersionUpgrade

Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

iops

Integer iops

The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Default: Uses existing setting

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Type: Integer

optionGroupName

String optionGroupName

Indicates that the DB Instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

newDBInstanceIdentifier

String newDBInstanceIdentifier

The new DB Instance identifier for the DB Instance when renaming a DB Instance. This value is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Class com.amazonaws.services.rds.model.ModifyDBParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBParameterGroupName

String dBParameterGroupName

The name of the DB Parameter Group.

Constraints:

• Must be the name of an existing DB Parameter Group
• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

parameters

List<E> parameters

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.

Valid Values (for the application method): immediate | pending-reboot You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB Instance reboots.

Class com.amazonaws.services.rds.model.ModifyDBParameterGroupResult extends Object implements Serializable

Serialized Fields

dBParameterGroupName

String dBParameterGroupName

The name of the DB Parameter Group.

Class com.amazonaws.services.rds.model.ModifyDBSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBSubnetGroupName

String dBSubnetGroupName

The name for the DB Subnet Group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".

Example: mySubnetgroup

dBSubnetGroupDescription

String dBSubnetGroupDescription

The description for the DB Subnet Group.

subnetIds

List<E> subnetIds

The EC2 Subnet IDs for the DB Subnet Group.

Class com.amazonaws.services.rds.model.ModifyEventSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

subscriptionName

String subscriptionName

The name of the RDS event notification subscription.

snsTopicArn

String snsTopicArn

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

sourceType

String sourceType

The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

eventCategories

List<E> eventCategories

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

enabled

Boolean enabled

A Boolean value; set to true to activate the subscription.

Class com.amazonaws.services.rds.model.ModifyOptionGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

optionGroupName

String optionGroupName

The name of the option group to be modified.

optionsToInclude

List<E> optionsToInclude

Options in this list are added to the Option Group or, if already present, the specified configuration is used to update the existing configuration.

optionsToRemove

List<E> optionsToRemove

Options in this list are removed from the Option Group.

applyImmediately

Boolean applyImmediately

Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the Option Group.

Class com.amazonaws.services.rds.model.Option extends Object implements Serializable

Serialized Fields

optionName

String optionName

The name of the option.

optionDescription

String optionDescription

The description of the option.

persistent

Boolean persistent

Indicate if this option is persistent.

port

Integer port

If required, the port configured for this option to use.

optionSettings

List<E> optionSettings

The option settings for this option.

dBSecurityGroupMemberships

List<E> dBSecurityGroupMemberships

If the option requires access to a port, then this DB Security Group allows access to the port.

vpcSecurityGroupMemberships

List<E> vpcSecurityGroupMemberships

If the option requires access to a port, then this VPC Security Group allows access to the port.

Class com.amazonaws.services.rds.model.OptionConfiguration extends Object implements Serializable

Serialized Fields

optionName

String optionName

The configuration of options to include in a group.

port

Integer port

The optional port for the option.

dBSecurityGroupMemberships

List<E> dBSecurityGroupMemberships

A list of DBSecurityGroupMemebrship name strings used for this option.

vpcSecurityGroupMemberships

List<E> vpcSecurityGroupMemberships

A list of VpcSecurityGroupMemebrship name strings used for this option.

optionSettings

List<E> optionSettings

The option settings to include in an option group.

Class com.amazonaws.services.rds.model.OptionGroup extends Object implements Serializable

Serialized Fields

optionGroupName

String optionGroupName

Specifies the name of the option group.

optionGroupDescription

String optionGroupDescription

Provides the description of the option group.

engineName

String engineName

Engine name that this option group can be applied to.

majorEngineVersion

String majorEngineVersion

Indicates the major engine version associated with this option group.

options

List<E> options

Indicates what options are available in the option group.

allowsVpcAndNonVpcInstanceMemberships

Boolean allowsVpcAndNonVpcInstanceMemberships

Indicates whether this option group can be applied to both VPC and non-VPC instances. The value 'true' indicates the option group can be applied to both VPC and non-VPC instances.

vpcId

String vpcId

If AllowsVpcAndNonVpcInstanceMemberships is 'false', this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is 'true' and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

Class com.amazonaws.services.rds.model.OptionGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.OptionGroupMembership extends Object implements Serializable

Serialized Fields

optionGroupName

String optionGroupName

The name of the option group that the instance belongs to.

status

String status

The status of the DB Instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).

Class com.amazonaws.services.rds.model.OptionGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.OptionGroupOption extends Object implements Serializable

Serialized Fields

name

String name

The name of the option.

description

String description

The description of the option.

engineName

String engineName

Engine name that this option can be applied to.

majorEngineVersion

String majorEngineVersion

Indicates the major engine version that the option is available for.

minimumRequiredMinorEngineVersion

String minimumRequiredMinorEngineVersion

The minimum required engine version for the option to be applied.

portRequired

Boolean portRequired

Specifies whether the option requires a port.

defaultPort

Integer defaultPort

If the option requires a port, specifies the default port for the option.

optionsDependedOn

List<E> optionsDependedOn

List of all options that are prerequisites for this option.

persistent

Boolean persistent

Specifies whether the option is persistent in an option group.

optionGroupOptionSettings

List<E> optionGroupOptionSettings

Specifies the option settings that are available (and the default value) for each option in an option group.

Class com.amazonaws.services.rds.model.OptionGroupOptionSetting extends Object implements Serializable

Serialized Fields

settingName

String settingName

The name of the option group option.

settingDescription

String settingDescription

The description of the option group option.

defaultValue

String defaultValue

The default value for the option group option.

applyType

String applyType

The DB engine specific parameter type for the option group option.

allowedValues

String allowedValues

Indicates the acceptable values for the option group option.

isModifiable

Boolean isModifiable

Boolean value where true indicates that this option group option can be changed from the default value.

Class com.amazonaws.services.rds.model.OptionGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.OptionSetting extends Object implements Serializable

Serialized Fields

name

String name

The name of the option that has settings that you can set.

value

String value

The current value of the option setting.

defaultValue

String defaultValue

The default value of the option setting.

description

String description

The description of the option setting.

applyType

String applyType

The DB engine specific parameter type.

dataType

String dataType

The data type of the option setting.

allowedValues

String allowedValues

The allowed values of the option setting.

isModifiable

Boolean isModifiable

A Boolean value that, when true, indicates the option setting can be modified from the default.

isCollection

Boolean isCollection

Indicates if the option setting is part of a collection.

Class com.amazonaws.services.rds.model.OrderableDBInstanceOption extends Object implements Serializable

Serialized Fields

engine

String engine

The engine type of the orderable DB Instance.

engineVersion

String engineVersion

The engine version of the orderable DB Instance.

dBInstanceClass

String dBInstanceClass

The DB Instance Class for the orderable DB Instance

licenseModel

String licenseModel

The license model for the orderable DB Instance.

availabilityZones

List<E> availabilityZones

A list of availability zones for the orderable DB Instance.

multiAZCapable

Boolean multiAZCapable

Indicates whether this orderable DB Instance is multi-AZ capable.

readReplicaCapable

Boolean readReplicaCapable

Indicates whether this orderable DB Instance can have a read replica.

vpc

Boolean vpc

Indicates whether this is a VPC orderable DB Instance.

Class com.amazonaws.services.rds.model.Parameter extends Object implements Serializable

Serialized Fields

parameterName

String parameterName

Specifies the name of the parameter.

parameterValue

String parameterValue

Specifies the value of the parameter.

description

String description

Provides a description of the parameter.

source

String source

Indicates the source of the parameter value.

applyType

String applyType

Specifies the engine specific parameters type.

dataType

String dataType

Specifies the valid data type for the parameter.

allowedValues

String allowedValues

Specifies the valid range of values for the parameter.

isModifiable

Boolean isModifiable

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

minimumEngineVersion

String minimumEngineVersion

The earliest engine version to which the parameter can apply.

applyMethod

String applyMethod

Indicates when to apply parameter updates.

Constraints:
Allowed Values: immediate, pending-reboot

Class com.amazonaws.services.rds.model.PendingModifiedValues extends Object implements Serializable

Serialized Fields

dBInstanceClass

String dBInstanceClass

Contains the new DBInstanceClass for the DB Instance that will be applied or is in progress.

allocatedStorage

Integer allocatedStorage

Contains the new AllocatedStorage size for the DB Instance that will be applied or is in progress.

masterUserPassword

String masterUserPassword

Contains the pending or in-progress change of the master credentials for the DB Instance.

port

Integer port

Specifies the pending port for the DB Instance.

backupRetentionPeriod

Integer backupRetentionPeriod

Specifies the pending number of days for which automated backups are retained.

multiAZ

Boolean multiAZ

Indicates that the Single-AZ DB Instance is to change to a Multi-AZ deployment.

engineVersion

String engineVersion

Indicates the database engine version.

iops

Integer iops

Specifies the new Provisioned IOPS value for the DB Instance that will be applied or is being applied.

dBInstanceIdentifier

String dBInstanceIdentifier

Contains the new DBInstanceIdentifier for the DB Instance that will be applied or is in progress.

Class com.amazonaws.services.rds.model.PointInTimeRestoreNotEnabledException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.PromoteReadReplicaRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBInstanceIdentifier

String dBInstanceIdentifier

The DB Instance identifier. This value is stored as a lowercase string.

Constraints:

• Must be the identifier for an existing Read Replica DB Instance
• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Example: mydbinstance

backupRetentionPeriod

Integer backupRetentionPeriod

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

• Must be a value from 0 to 8

preferredBackupWindow

String preferredBackupWindow

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned.

• US-East (Northern Virginia) Region: 03:00-11:00 UTC
• US-West (Northern California) Region: 06:00-14:00 UTC
• EU (Ireland) Region: 22:00-06:00 UTC
• Asia Pacific (Singapore) Region: 14:00-22:00 UTC
• Asia Pacific (Tokyo) Region: 17:00-03:00 UTC

Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.

Class com.amazonaws.services.rds.model.ProvisionedIopsNotAvailableInAZException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.PurchaseReservedDBInstancesOfferingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

reservedDBInstancesOfferingId

String reservedDBInstancesOfferingId

The ID of the Reserved DB Instance offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

reservedDBInstanceId

String reservedDBInstanceId

Customer-specified identifier to track this reservation.

Example: myreservationID

dBInstanceCount

Integer dBInstanceCount

The number of instances to reserve.

Default: 1

Class com.amazonaws.services.rds.model.RebootDBInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBInstanceIdentifier

String dBInstanceIdentifier

The DB Instance identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

forceFailover

Boolean forceFailover

When true, the reboot will be conducted through a MultiAZ failover.

Constraint: You cannot specify true if the instance is not configured for MultiAZ.

Class com.amazonaws.services.rds.model.RecurringCharge extends Object implements Serializable

Serialized Fields

recurringChargeAmount

Double recurringChargeAmount

The amount of the recurring charge.

recurringChargeFrequency

String recurringChargeFrequency

The frequency of the recurring charge.

Class com.amazonaws.services.rds.model.RemoveSourceIdentifierFromSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

subscriptionName

String subscriptionName

The name of the RDS event notification subscription you want to remove a source identifier from.

sourceIdentifier

String sourceIdentifier

The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.

Class com.amazonaws.services.rds.model.RemoveTagsFromResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceName

String resourceName

The DB Instance the tags will be removed from.

tagKeys

List<E> tagKeys

The tag key (name) of the tag to be removed.

Class com.amazonaws.services.rds.model.ReservedDBInstance extends Object implements Serializable

Serialized Fields

reservedDBInstanceId

String reservedDBInstanceId

The unique identifier for the reservation.

reservedDBInstancesOfferingId

String reservedDBInstancesOfferingId

The offering identifier.

dBInstanceClass

String dBInstanceClass

The DB instance class for the reserved DB Instance.

startTime

Date startTime

The time the reservation started.

duration

Integer duration

The duration of the reservation in seconds.

fixedPrice

Double fixedPrice

The fixed price charged for this reserved DB Instance.

usagePrice

Double usagePrice

The hourly price charged for this reserved DB Instance.

currencyCode

String currencyCode

The currency code for the reserved DB Instance.

dBInstanceCount

Integer dBInstanceCount

The number of reserved DB Instances.

productDescription

String productDescription

The description of the reserved DB Instance.

offeringType

String offeringType

The offering type of this reserved DB Instance.

multiAZ

Boolean multiAZ

Indicates if the reservation applies to Multi-AZ deployments.

state

String state

The state of the reserved DB Instance.

recurringCharges

List<E> recurringCharges

The recurring price charged to run this reserved DB Instance.

Class com.amazonaws.services.rds.model.ReservedDBInstanceAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.ReservedDBInstanceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.ReservedDBInstanceQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.ReservedDBInstancesOffering extends Object implements Serializable

Serialized Fields

reservedDBInstancesOfferingId

String reservedDBInstancesOfferingId

The offering identifier.

dBInstanceClass

String dBInstanceClass

The DB instance class for the reserved DB Instance.

duration

Integer duration

The duration of the offering in seconds.

fixedPrice

Double fixedPrice

The fixed price charged for this offering.

usagePrice

Double usagePrice

The hourly price charged for this offering.

currencyCode

String currencyCode

The currency code for the reserved DB Instance offering.

productDescription

String productDescription

The database engine used by the offering.

offeringType

String offeringType

The offering type.

multiAZ

Boolean multiAZ

Indicates if the offering applies to Multi-AZ deployments.

recurringCharges

List<E> recurringCharges

The recurring price charged to run this reserved DB Instance.

Class com.amazonaws.services.rds.model.ReservedDBInstancesOfferingNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.ResetDBParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBParameterGroupName

String dBParameterGroupName

The name of the DB Parameter Group.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

resetAllParameters

Boolean resetAllParameters

Specifies whether (true) or not (false) to reset all parameters in the DB Parameter Group to default values.

Default: true

parameters

List<E> parameters

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.

MySQL

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB Instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

Class com.amazonaws.services.rds.model.ResetDBParameterGroupResult extends Object implements Serializable

Serialized Fields

dBParameterGroupName

String dBParameterGroupName

The name of the DB Parameter Group.

Class com.amazonaws.services.rds.model.RestoreDBInstanceFromDBSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBInstanceIdentifier

String dBInstanceIdentifier

The identifier for the DB Snapshot to restore from.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

dBSnapshotIdentifier

String dBSnapshotIdentifier

Name of the DB Instance to create from the DB Snapshot. This parameter isn't case sensitive.

Constraints:

• Must contain from 1 to 255 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

dBInstanceClass

String dBInstanceClass

The compute and memory capacity of the Amazon RDS DB instance.

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge

port

Integer port

The port number on which the database accepts connections.

Default: The same port as the original DB Instance

Constraints: Value must be 1150-65535

availabilityZone

String availabilityZone

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

dBSubnetGroupName

String dBSubnetGroupName

The DB Subnet Group name to use for the new instance.

multiAZ

Boolean multiAZ

Specifies if the DB Instance is a Multi-AZ deployment.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

publiclyAccessible

Boolean publiclyAccessible

Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true
• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

autoMinorVersionUpgrade

Boolean autoMinorVersionUpgrade

Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.

licenseModel

String licenseModel

License model information for the restored DB Instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

dBName

String dBName

The database name for the restored DB Instance.

This parameter doesn't apply to the MySQL engine.

engine

String engine

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Example: oracle-ee

iops

Integer iops

Specifies the amount of provisioned IOPS for the DB Instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.

Constraints: Must be an integer greater than 1000.

optionGroupName

String optionGroupName

The name of the option group to be used for the restored DB instance.

Class com.amazonaws.services.rds.model.RestoreDBInstanceToPointInTimeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sourceDBInstanceIdentifier

String sourceDBInstanceIdentifier

The identifier of the source DB Instance from which to restore.

Constraints:

• Must be the identifier of an existing database instance
• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

targetDBInstanceIdentifier

String targetDBInstanceIdentifier

The name of the new database instance to be created.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

restoreTime

Date restoreTime

The date and time to restore from.

Valid Values: Value must be a UTC time

Constraints:

• Must be before the latest restorable time for the DB Instance
• Cannot be specified if UseLatestRestorableTime parameter is true

Example: 2009-09-07T23:45:00Z

useLatestRestorableTime

Boolean useLatestRestorableTime

Specifies whether (true) or not (false) the DB Instance is restored from the latest backup time.

Default: false

Constraints: Cannot be specified if RestoreTime parameter is provided.

dBInstanceClass

String dBInstanceClass

The compute and memory capacity of the Amazon RDS DB instance.

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge

Default: The same DBInstanceClass as the original DB Instance.

port

Integer port

The port number on which the database accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB Instance.

availabilityZone

String availabilityZone

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

dBSubnetGroupName

String dBSubnetGroupName

The DB subnet group name to use for the new instance.

multiAZ

Boolean multiAZ

Specifies if the DB Instance is a Multi-AZ deployment.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

publiclyAccessible

Boolean publiclyAccessible

Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true
• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

autoMinorVersionUpgrade

Boolean autoMinorVersionUpgrade

Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.

licenseModel

String licenseModel

License model information for the restored DB Instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

dBName

String dBName

The database name for the restored DB Instance.

This parameter is not used for the MySQL engine.

engine

String engine

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Example: oracle-ee

iops

Integer iops

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.

Constraints: Must be an integer greater than 1000.

optionGroupName

String optionGroupName

The name of the option group to be used for the restored DB instance.

Class com.amazonaws.services.rds.model.RevokeDBSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBSecurityGroupName

String dBSecurityGroupName

The name of the DB Security Group to revoke ingress from.

cIDRIP

String cIDRIP

The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId cannot be provided.

eC2SecurityGroupName

String eC2SecurityGroupName

The name of the EC2 Security Group to revoke access from. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

eC2SecurityGroupId

String eC2SecurityGroupId

The id of the EC2 Security Group to revoke access from. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

eC2SecurityGroupOwnerId

String eC2SecurityGroupOwnerId

The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

Class com.amazonaws.services.rds.model.SnapshotQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.SNSInvalidTopicException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.SNSNoAuthorizationException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.SNSTopicArnNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.SourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.StorageQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.Subnet extends Object implements Serializable

Serialized Fields

subnetIdentifier

String subnetIdentifier

Specifies the identifier of the subnet.

subnetAvailabilityZone

AvailabilityZone subnetAvailabilityZone

Contains Availability Zone information.

This data type is used as an element in the following data type:

• OrderableDBInstanceOption

subnetStatus

String subnetStatus

Specifies the status of the subnet.

Class com.amazonaws.services.rds.model.SubnetAlreadyInUseException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.SubscriptionAlreadyExistException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.SubscriptionCategoryNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.SubscriptionNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.rds.model.Tag extends Object implements Serializable

Serialized Fields

key

String key

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with "aws:". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

value

String value

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with "aws:". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

Class com.amazonaws.services.rds.model.VpcSecurityGroupMembership extends Object implements Serializable

Serialized Fields

vpcSecurityGroupId

String vpcSecurityGroupId

The name of the VPC security group.

status

String status

The status of the VPC Security Group.

Package com.amazonaws.services.redshift.model

Class com.amazonaws.services.redshift.model.AuthorizationAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.AuthorizationNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.AuthorizationQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.AuthorizeClusterSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterSecurityGroupName

String clusterSecurityGroupName

The name of the security group to which the ingress rule is added.

cIDRIP

String cIDRIP

The IP range to be added the Amazon Redshift security group.

eC2SecurityGroupName

String eC2SecurityGroupName

The EC2 security group to be added the Amazon Redshift security group.

eC2SecurityGroupOwnerId

String eC2SecurityGroupOwnerId

The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.

Example: 111122223333

Class com.amazonaws.services.redshift.model.AvailabilityZone extends Object implements Serializable

Serialized Fields

name

String name

The name of the availability zone.

Class com.amazonaws.services.redshift.model.Cluster extends Object implements Serializable

Serialized Fields

clusterIdentifier

String clusterIdentifier

The unique identifier of the cluster.

nodeType

String nodeType

The node type for the nodes in the cluster.

clusterStatus

String clusterStatus

The current state of this cluster. Possible values include available, creating, deleting, rebooting, and resizing.

modifyStatus

String modifyStatus

The status of a modify operation, if any, initiated for the cluster.

masterUsername

String masterUsername

The master user name for the cluster. This name is used to connect to the database that is specified in DBName.

dBName

String dBName

The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.

endpoint

Endpoint endpoint

The connection endpoint.

clusterCreateTime

Date clusterCreateTime

The date and time that the cluster was created.

automatedSnapshotRetentionPeriod

Integer automatedSnapshotRetentionPeriod

The number of days that automatic cluster snapshots are retained.

clusterSecurityGroups

List<E> clusterSecurityGroups

A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.

Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

vpcSecurityGroups

List<E> vpcSecurityGroups

A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.

clusterParameterGroups

List<E> clusterParameterGroups

The list of cluster parameter groups that are associated with this cluster.

clusterSubnetGroupName

String clusterSubnetGroupName

The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.

vpcId

String vpcId

The identifier of the VPC the cluster is in, if the cluster is in a VPC.

availabilityZone

String availabilityZone

The name of the Availability Zone in which the cluster is located.

preferredMaintenanceWindow

String preferredMaintenanceWindow

The weekly time range (in UTC) during which system maintenance can occur.

pendingModifiedValues

PendingModifiedValues pendingModifiedValues

If present, changes to the cluster are pending. Specific pending changes are identified by subelements.

clusterVersion

String clusterVersion

The version ID of the Amazon Redshift engine that is running on the cluster.

allowVersionUpgrade

Boolean allowVersionUpgrade

If true, version upgrades will be applied automatically to the cluster during the maintenance window.

numberOfNodes

Integer numberOfNodes

The number of compute nodes in the cluster.

publiclyAccessible

Boolean publiclyAccessible

If true, the cluster can be accessed from a public network.

encrypted

Boolean encrypted

If true, data in cluster is encrypted at rest.

Class com.amazonaws.services.redshift.model.ClusterAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.ClusterNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.ClusterParameterGroup extends Object implements Serializable

Serialized Fields

parameterGroupName

String parameterGroupName

The name of the cluster parameter group.

parameterGroupFamily

String parameterGroupFamily

The name of the cluster parameter group family that this cluster parameter group is compatible with.

description

String description

The description of the parameter group.

Class com.amazonaws.services.redshift.model.ClusterParameterGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.ClusterParameterGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.ClusterParameterGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.ClusterParameterGroupStatus extends Object implements Serializable

Serialized Fields

parameterGroupName

String parameterGroupName

The name of the cluster parameter group.

parameterApplyStatus

String parameterApplyStatus

The status of parameter updates.

Class com.amazonaws.services.redshift.model.ClusterQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.ClusterSecurityGroup extends Object implements Serializable

Serialized Fields

clusterSecurityGroupName

String clusterSecurityGroupName

The name of the cluster security group to which the operation was applied.

description

String description

A description of the security group.

eC2SecurityGroups

List<E> eC2SecurityGroups

A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.

iPRanges

List<E> iPRanges

A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.

Class com.amazonaws.services.redshift.model.ClusterSecurityGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.ClusterSecurityGroupMembership extends Object implements Serializable

Serialized Fields

clusterSecurityGroupName

String clusterSecurityGroupName

The name of the cluster security group.

status

String status

The status of the cluster security group.

Class com.amazonaws.services.redshift.model.ClusterSecurityGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.ClusterSecurityGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.ClusterSnapshotAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.ClusterSnapshotNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.ClusterSnapshotQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.ClusterSubnetGroup extends Object implements Serializable

Serialized Fields

clusterSubnetGroupName

String clusterSubnetGroupName

The name of the cluster subnet group.

description

String description

The description of the cluster subnet group.

vpcId

String vpcId

The VPC ID of the cluster subnet group.

subnetGroupStatus

String subnetGroupStatus

The status of the cluster subnet group. Possible values are Complete, Incomplete and Invalid.

subnets

List<E> subnets

A list of the VPC Subnet elements.

Class com.amazonaws.services.redshift.model.ClusterSubnetGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.ClusterSubnetGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.ClusterSubnetGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.ClusterSubnetQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.ClusterVersion extends Object implements Serializable

Serialized Fields

clusterVersion

String clusterVersion

The version number used by the cluster.

clusterParameterGroupFamily

String clusterParameterGroupFamily

The name of the cluster parameter group family for the cluster.

description

String description

The description of the cluster version.

Class com.amazonaws.services.redshift.model.CopyClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sourceSnapshotIdentifier

String sourceSnapshotIdentifier

The identifier for the source snapshot.

Constraints:

• Must be the identifier for a valid automated snapshot whose state is "available".

targetSnapshotIdentifier

String targetSnapshotIdentifier

The identifier given to the new manual snapshot.

Constraints:

• Cannot be null, empty, or blank.
• Must contain from 1 to 255 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.
• Must be unique for the AWS account that is making the request.

Class com.amazonaws.services.redshift.model.CreateClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

parameterGroupName

String parameterGroupName

The name of the cluster parameter group.

Constraints:

• Must be 1 to 255 alphanumeric characters or hyphens
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.
• Must be unique withing your AWS account.

This value is stored as a lower-case string.

parameterGroupFamily

String parameterGroupFamily

The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.

To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift-1.0".

description

String description

A description of the parameter group.

Class com.amazonaws.services.redshift.model.CreateClusterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBName

String dBName

The name of the first database to be created when the cluster is created.

To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Developer Guide.

Default: dev

Constraints:

• Must contain 1 to 64 alphanumeric characters.
• Must contain only lowercase letters.
• Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Developer Guide.

clusterIdentifier

String clusterIdentifier

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens.
• Alphabetic characters must be lowercase.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.
• Must be unique for all clusters within an AWS account.

Example: myexamplecluster

clusterType

String clusterType

The type of the cluster. When cluster type is specified as

• single-node, the NumberOfNodes parameter is not required.
• multi-node, the NumberOfNodes parameter is required.

Valid Values: multi-node | single-node

Default: multi-node

nodeType

String nodeType

The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Management Guide.

Valid Values: dw.hs1.xlarge | dw.hs1.8xlarge.

masterUsername

String masterUsername

The user name associated with the master user account for the cluster that is being created.

Constraints:

• Must be 1 - 128 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Developer Guide.

masterUserPassword

String masterUserPassword

The password associated with the master user account for the cluster that is being created.

Constraints:

• Must be between 8 and 64 characters in length.
• Must contain at least one uppercase letter.
• Must contain at least one lowercase letter.
• Must contain one number.

clusterSecurityGroups

List<E> clusterSecurityGroups

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

vpcSecurityGroupIds

List<E> vpcSecurityGroupIds

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

clusterSubnetGroupName

String clusterSubnetGroupName

The name of a cluster subnet group to be associated with this cluster.

If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

availabilityZone

String availabilityZone

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

Example: us-east-1d

Constraint: The specified Availability Zone must be in the same region as the current endpoint.

preferredMaintenanceWindow

String preferredMaintenanceWindow

The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. The following list shows the time blocks for each region from which the default maintenance windows are assigned.

• US-East (Northern Virginia) Region: 03:00-11:00 UTC
• US-West (Northern California) Region: 06:00-14:00 UTC
• EU (Ireland) Region: 22:00-06:00 UTC
• Asia Pacific (Singapore) Region: 14:00-22:00 UTC
• Asia Pacific (Tokyo) Region: 17:00-03:00 UTC

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Minimum 30-minute window.

clusterParameterGroupName

String clusterParameterGroupName

The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

Constraints:

• Must be 1 to 255 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

automatedSnapshotRetentionPeriod

Integer automatedSnapshotRetentionPeriod

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

Default: 1

Constraints: Must be a value from 0 to 35.

port

Integer port

The port number on which the cluster accepts incoming connections.

The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.

Default: 5439

Valid Values: 1150-65535

clusterVersion

String clusterVersion

The version of the Amazon Redshift engine software that you want to deploy on the cluster.

The version selected runs on all the nodes in the cluster.

Constraints: Only version 1.0 is currently available.

Example: 1.0

allowVersionUpgrade

Boolean allowVersionUpgrade

If true, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

Default: true

numberOfNodes

Integer numberOfNodes

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Management Guide.

If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

Default: 1

Constraints: Value must be at least 1 and no more than 100.

publiclyAccessible

Boolean publiclyAccessible

If true, the cluster can be accessed from a public network.

encrypted

Boolean encrypted

If true, the data in cluster is encrypted at rest.

Default: false

Class com.amazonaws.services.redshift.model.CreateClusterSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterSecurityGroupName

String clusterSecurityGroupName

The name for the security group. Amazon Redshift stores the value as a lowercase string.

Constraints:

• Must contain no more than 255 alphanumeric characters or hyphens.
• Must not be "Default".
• Must be unique for all security groups that are created by your AWS account.

Example: examplesecuritygroup

description

String description

A description for the security group.

Class com.amazonaws.services.redshift.model.CreateClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

snapshotIdentifier

String snapshotIdentifier

A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account.

Constraints:

• Cannot be null, empty, or blank
• Must contain from 1 to 255 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

clusterIdentifier

String clusterIdentifier

The cluster identifier for which you want a snapshot.

Class com.amazonaws.services.redshift.model.CreateClusterSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterSubnetGroupName

String clusterSubnetGroupName

The name for the subnet group. Amazon Redshift stores the value as a lowercase string.

Constraints:

• Must contain no more than 255 alphanumeric characters or hyphens.
• Must not be "Default".
• Must be unique for all subnet groups that are created by your AWS account.

Example: examplesubnetgroup

description

String description

A description for the subnet group.

subnetIds

List<E> subnetIds

An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

Class com.amazonaws.services.redshift.model.DefaultClusterParameters extends Object implements Serializable

Serialized Fields

parameterGroupFamily

String parameterGroupFamily

The name of the cluster parameter group family to which the engine default parameters apply.

marker

String marker

An identifier to allow retrieval of paginated results.

parameters

List<E> parameters

The list of cluster default parameters.

Class com.amazonaws.services.redshift.model.DeleteClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

parameterGroupName

String parameterGroupName

The name of the parameter group to be deleted.

Constraints:

• Must be the name of an existing cluster parameter group.
• Cannot delete a default cluster parameter group.

Class com.amazonaws.services.redshift.model.DeleteClusterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterIdentifier

String clusterIdentifier

The identifier of the cluster to be deleted.

Constraints:

• Must contain lowercase characters.
• Must contain from 1 to 63 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

skipFinalClusterSnapshot

Boolean skipFinalClusterSnapshot

Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted. The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

Default: false

finalClusterSnapshotIdentifier

String finalClusterSnapshotIdentifier

The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

Constraints:

• Must be 1 to 255 alphanumeric characters.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Class com.amazonaws.services.redshift.model.DeleteClusterSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterSecurityGroupName

String clusterSecurityGroupName

The name of the cluster security group to be deleted.

Class com.amazonaws.services.redshift.model.DeleteClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

snapshotIdentifier

String snapshotIdentifier

The unique identifier of the manual snapshot to be deleted.

Constraints: Must be the name of an existing snapshot that is in the available state.

Class com.amazonaws.services.redshift.model.DeleteClusterSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterSubnetGroupName

String clusterSubnetGroupName

The name of the cluster subnet group name to be deleted.

Class com.amazonaws.services.redshift.model.DescribeClusterParameterGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

parameterGroupName

String parameterGroupName

The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.

maxRecords

Integer maxRecords

The maximum number of parameter group records to include in the response. If more records exist than the specified MaxRecords value, the response includes a marker that you can use in a subsequent DescribeClusterParameterGroups request to retrieve the next set of records.

Default: 100

Constraints: Value must be at least 20 and no more than 100.

marker

String marker

An optional marker returned by a previous DescribeClusterParameterGroups request to indicate the first parameter group that the current request will return.

Class com.amazonaws.services.redshift.model.DescribeClusterParameterGroupsResult extends Object implements Serializable

Serialized Fields

marker

String marker

A marker at which to continue listing cluster parameter groups in a new request. The response returns a marker if there are more parameter groups to list than returned in the response.

parameterGroups

List<E> parameterGroups

A list of ClusterParameterGroup instances. Each instance describes one cluster parameter group.

Class com.amazonaws.services.redshift.model.DescribeClusterParametersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

parameterGroupName

String parameterGroupName

The name of a cluster parameter group for which to return details.

source

String source

The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: user | engine-default

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, response includes a marker that you can specify in your subsequent request to retrieve remaining result.

Default: 100

Constraints: Value must be at least 20 and no more than 100.

marker

String marker

An optional marker returned from a previous DescribeClusterParameters request. If this parameter is specified, the response includes only records beyond the specified marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.redshift.model.DescribeClusterParametersResult extends Object implements Serializable

Serialized Fields

parameters

List<E> parameters

A list of Parameter instances. Each instance lists the parameters of one cluster parameter group.

marker

String marker

A marker that indicates the first parameter group that a subsequent DescribeClusterParameterGroups request will return. The response returns a marker only if there are more parameter groups details to list than the current response can return.

Class com.amazonaws.services.redshift.model.DescribeClusterSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterSecurityGroupName

String clusterSecurityGroupName

The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.

Example: securitygroup1

maxRecords

Integer maxRecords

The maximum number of records to be included in the response. If more records exist than the specified MaxRecords value, a marker is included in the response, which you can use in a subsequent DescribeClusterSecurityGroups request.

Default: 100

Constraints: Value must be at least 20 and no more than 100.

marker

String marker

An optional marker returned by a previous DescribeClusterSecurityGroups request to indicate the first security group that the current request will return. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.

Class com.amazonaws.services.redshift.model.DescribeClusterSecurityGroupsResult extends Object implements Serializable

Serialized Fields

marker

String marker

A marker at which to continue listing cluster security groups in a new request. The response returns a marker if there are more security groups to list than could be returned in the response.

clusterSecurityGroups

List<E> clusterSecurityGroups

A list of ClusterSecurityGroup instances.

Class com.amazonaws.services.redshift.model.DescribeClusterSnapshotsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterIdentifier

String clusterIdentifier

The identifier of the cluster for which information about snapshots is requested.

snapshotIdentifier

String snapshotIdentifier

The snapshot identifier of the snapshot about which to return information.

snapshotType

String snapshotType

The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.

Valid Values: automated | manual

startTime

Date startTime

A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2012-07-16T18:00:00Z

endTime

Date endTime

A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2012-07-16T18:00:00Z

maxRecords

Integer maxRecords

The maximum number of snapshot records to include in the response. If more records exist than the specified MaxRecords value, the response returns a marker that you can use in a subsequent DescribeClusterSnapshots request in order to retrieve the next set of snapshot records.

Default: 100

Constraints: Must be at least 20 and no more than 100.

marker

String marker

An optional marker returned by a previous DescribeClusterSnapshots request to indicate the first snapshot that the request will return.

Class com.amazonaws.services.redshift.model.DescribeClusterSnapshotsResult extends Object implements Serializable

Serialized Fields

marker

String marker

A marker that indicates the first snapshot that a subsequent DescribeClusterSnapshots request will return. The response returns a marker only if there are more snapshots to list than the current response can return.

snapshots

List<E> snapshots

A list of Snapshot instances.

Class com.amazonaws.services.redshift.model.DescribeClustersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterIdentifier

String clusterIdentifier

The unique identifier of a cluster whose properties you are requesting. This parameter isn't case sensitive.

The default is that all clusters defined for an account are returned.

maxRecords

Integer maxRecords

The maximum number of records that the response can include. If more records exist than the specified MaxRecords value, a marker is included in the response that can be used in a new DescribeClusters request to continue listing results.

Default: 100

Constraints: Value must be at least 20 and no more than 100.

marker

String marker

An optional marker returned by a previous DescribeClusters request to indicate the first cluster that the current DescribeClusters request will return.

You can specify either a Marker parameter or a ClusterIdentifier parameter in a DescribeClusters request, but not both.

Class com.amazonaws.services.redshift.model.DescribeClustersResult extends Object implements Serializable

Serialized Fields

marker

String marker

A marker at which to continue listing clusters in a new request. A marker is returned if there are more clusters to list than were returned in the response.

clusters

List<E> clusters

A list of Cluster objects, where each object describes one cluster.

Class com.amazonaws.services.redshift.model.DescribeClusterSubnetGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterSubnetGroupName

String clusterSubnetGroupName

The name of the cluster subnet group for which information is requested.

maxRecords

Integer maxRecords

The maximum number of cluster subnet group records to include in the response. If more records exist than the specified MaxRecords value, the response returns a marker that you can use in a subsequent DescribeClusterSubnetGroups request in order to retrieve the next set of cluster subnet group records.

Default: 100

Constraints: Must be at least 20 and no more than 100.

marker

String marker

An optional marker returned by a previous DescribeClusterSubnetGroups request to indicate the first cluster subnet group that the current request will return.

Class com.amazonaws.services.redshift.model.DescribeClusterSubnetGroupsResult extends Object implements Serializable

Serialized Fields

marker

String marker

A marker at which to continue listing cluster subnet groups in a new request. A marker is returned if there are more cluster subnet groups to list than were returned in the response.

clusterSubnetGroups

List<E> clusterSubnetGroups

A list of ClusterSubnetGroup instances.

Class com.amazonaws.services.redshift.model.DescribeClusterVersionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterVersion

String clusterVersion

The specific cluster version to return.

Example: 1.0

clusterParameterGroupFamily

String clusterParameterGroupFamily

The name of a specific cluster parameter group family to return details for.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more than the MaxRecords value is available, a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Value must be at least 20 and no more than 100.

marker

String marker

The marker returned from a previous request. If this parameter is specified, the response includes records beyond the marker only, up to MaxRecords.

Class com.amazonaws.services.redshift.model.DescribeClusterVersionsResult extends Object implements Serializable

Serialized Fields

marker

String marker

The identifier returned to allow retrieval of paginated results.

clusterVersions

List<E> clusterVersions

A list of Version elements.

Class com.amazonaws.services.redshift.model.DescribeDefaultClusterParametersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

parameterGroupFamily

String parameterGroupFamily

The name of the cluster parameter group family.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: Value must be at least 20 and no more than 100.

marker

String marker

An optional marker returned from a previous DescribeDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.redshift.model.DescribeEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sourceIdentifier

String sourceIdentifier

The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.

Constraints:

If SourceIdentifier is supplied, SourceType must also be provided.

• Specify a cluster identifier when SourceType is cluster.
• Specify a cluster security group name when SourceType is cluster-security-group.
• Specify a cluster parameter group name when SourceType is cluster-parameter-group.
• Specify a cluster snapshot identifier when SourceType is cluster-snapshot.

sourceType

String sourceType

The event source to retrieve events for. If no value is specified, all events are returned.

Constraints:

If SourceType is supplied, SourceIdentifier must also be provided.

• Specify cluster when SourceIdentifier is a cluster identifier.
• Specify cluster-security-group when SourceIdentifier is a cluster security group name.
• Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name.
• Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.

Constraints:
Allowed Values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot

startTime

Date startTime

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

endTime

Date endTime

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

duration

Integer duration

The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

Default: 60

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: Value must be at least 20 and no more than 100.

marker

String marker

An optional marker returned from a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.redshift.model.DescribeEventsResult extends Object implements Serializable

Serialized Fields

marker

String marker

A marker at which to continue listing events in a new request. The response returns a marker if there are more events to list than returned in the response.

events

List<E> events

A list of Event instances.

Class com.amazonaws.services.redshift.model.DescribeOrderableClusterOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterVersion

String clusterVersion

The version filter value. Specify this parameter to show only the available offerings matching the specified version.

Default: All versions.

Constraints: Must be one of the version returned from DescribeClusterVersions.

nodeType

String nodeType

The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100.

marker

String marker

An optional marker returned from a previous DescribeOrderableClusterOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Class com.amazonaws.services.redshift.model.DescribeOrderableClusterOptionsResult extends Object implements Serializable

Serialized Fields

orderableClusterOptions

List<E> orderableClusterOptions

An OrderableClusterOption structure containing information about orderable options for the Cluster.

marker

String marker

A marker that can be used to retrieve paginated results.

Class com.amazonaws.services.redshift.model.DescribeReservedNodeOfferingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

reservedNodeOfferingId

String reservedNodeOfferingId

The unique identifier for the offering.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100.

marker

String marker

An optional marker returned by a previous DescribeReservedNodeOfferings request to indicate the first offering that the request will return.

You can specify either a Marker parameter or a ClusterIdentifier parameter in a DescribeClusters request, but not both.

Class com.amazonaws.services.redshift.model.DescribeReservedNodeOfferingsResult extends Object implements Serializable

Serialized Fields

marker

String marker

An optional marker returned by a previous DescribeReservedNodeOfferings request to indicate the first reserved node offering that the request will return.

reservedNodeOfferings

List<E> reservedNodeOfferings

A list of reserved node offerings.

Class com.amazonaws.services.redshift.model.DescribeReservedNodesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

reservedNodeId

String reservedNodeId

Identifier for the node reservation.

maxRecords

Integer maxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100.

marker

String marker

An optional marker returned by a previous DescribeReservedNodes request to indicate the first parameter group that the current request will return.

Class com.amazonaws.services.redshift.model.DescribeReservedNodesResult extends Object implements Serializable

Serialized Fields

marker

String marker

A marker that can be used to retrieve paginated results.

reservedNodes

List<E> reservedNodes

The list of reserved nodes.

Class com.amazonaws.services.redshift.model.DescribeResizeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterIdentifier

String clusterIdentifier

The unique identifier of a cluster whose resize progress you are requesting. This parameter isn't case-sensitive.

By default, resize operations for all clusters defined for an AWS account are returned.

Class com.amazonaws.services.redshift.model.DescribeResizeResult extends Object implements Serializable

Serialized Fields

targetNodeType

String targetNodeType

The node type that the cluster will have after the resize is complete.

targetNumberOfNodes

Integer targetNumberOfNodes

The number of nodes that the cluster will have after the resize is complete.

targetClusterType

String targetClusterType

The cluster type after the resize is complete.

Valid Values: multi-node | single-node

status

String status

The status of the resize operation.

Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED

importTablesCompleted

List<E> importTablesCompleted

The names of tables that have been completely imported .

Valid Values: List of table names.

importTablesInProgress

List<E> importTablesInProgress

The names of tables that are being currently imported.

Valid Values: List of table names.

importTablesNotStarted

List<E> importTablesNotStarted

The names of tables that have not been yet imported.

Valid Values: List of table names

Class com.amazonaws.services.redshift.model.EC2SecurityGroup extends Object implements Serializable

Serialized Fields

status

String status

The status of the EC2 security group.

eC2SecurityGroupName

String eC2SecurityGroupName

The name of the EC2 Security Group.

eC2SecurityGroupOwnerId

String eC2SecurityGroupOwnerId

The AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

Class com.amazonaws.services.redshift.model.Endpoint extends Object implements Serializable

Serialized Fields

address

String address

The DNS address of the Cluster.

port

Integer port

The port that the database engine is listening on.

Class com.amazonaws.services.redshift.model.Event extends Object implements Serializable

Serialized Fields

sourceIdentifier

String sourceIdentifier

The identifier for the source of the event.

sourceType

String sourceType

The source type for this event.

Constraints:
Allowed Values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot

message

String message

The text of this event.

date

Date date

The date and time of the event.

Class com.amazonaws.services.redshift.model.InsufficientClusterCapacityException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.InvalidClusterParameterGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.InvalidClusterSecurityGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.InvalidClusterSnapshotStateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.InvalidClusterStateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.InvalidClusterSubnetGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.InvalidClusterSubnetStateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.InvalidRestoreException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.InvalidSubnetException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.InvalidVPCNetworkStateException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.IPRange extends Object implements Serializable

Serialized Fields

status

String status

The status of the IP range, for example, "authorized".

cIDRIP

String cIDRIP

The IP range in Classless Inter-Domain Routing (CIDR) notation.

Class com.amazonaws.services.redshift.model.ModifyClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

parameterGroupName

String parameterGroupName

The name of the parameter group to be modified.

parameters

List<E> parameters

An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.

For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.

Class com.amazonaws.services.redshift.model.ModifyClusterParameterGroupResult extends Object implements Serializable

Serialized Fields

parameterGroupName

String parameterGroupName

The name of the cluster parameter group.

parameterGroupStatus

String parameterGroupStatus

The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.

Class com.amazonaws.services.redshift.model.ModifyClusterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterIdentifier

String clusterIdentifier

The unique identifier of the cluster to be modified.

Example: examplecluster

clusterType

String clusterType

The new cluster type.

When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.

Valid Values: multi-node | single-node

nodeType

String nodeType

The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter also.

When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use the DescribeResize to track the progress of the resize request.

Valid Values: dw.hs1.xlarge | dw.hs1.8xlarge

numberOfNodes

Integer numberOfNodes

The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter also.

When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.

Valid Values: Integer greater than 0.

clusterSecurityGroups

List<E> clusterSecurityGroups

A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.

Security groups currently associated with the cluster and not in the list of groups to apply, will be revoked from the cluster.

Constraints:

• Must be 1 to 255 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

vpcSecurityGroupIds

List<E> vpcSecurityGroupIds

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

masterUserPassword

String masterUserPassword

The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response. Operations never return the password, so this operation provides a way to regain access to the master user account for a cluster if the password is lost.

Default: Uses existing setting.

Constraints:

• Must be between 8 and 64 characters in length.
• Must contain at least one uppercase letter.
• Must contain at least one lowercase letter.
• Must contain one number.

clusterParameterGroupName

String clusterParameterGroupName

The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster.

Default: Uses existing setting.

Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.

automatedSnapshotRetentionPeriod

Integer automatedSnapshotRetentionPeriod

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

If you decrease the automated snapshot retention period from its current value, existing automated snapshots which fall outside of the new retention period will be immediately deleted.

Default: Uses existing setting.

Constraints: Must be a value from 0 to 35.

preferredMaintenanceWindow

String preferredMaintenanceWindow

The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage.

This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.

Default: Uses existing setting.

Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes.

clusterVersion

String clusterVersion

The new version number of the Amazon Redshift engine to upgrade to.

For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide.

Example: 1.0

allowVersionUpgrade

Boolean allowVersionUpgrade

If true, upgrades will be applied automatically to the cluster during the maintenance window.

Default: false

Class com.amazonaws.services.redshift.model.ModifyClusterSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterSubnetGroupName

String clusterSubnetGroupName

The name of the subnet group to be modified.

description

String description

A text description of the subnet group to be modified.

subnetIds

List<E> subnetIds

An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

Class com.amazonaws.services.redshift.model.NumberOfNodesPerClusterLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.NumberOfNodesQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.OrderableClusterOption extends Object implements Serializable

Serialized Fields

clusterVersion

String clusterVersion

The version of the orderable cluster.

clusterType

String clusterType

The cluster type, for example multi-node.

nodeType

String nodeType

The node type for the orderable cluster.

availabilityZones

List<E> availabilityZones

A list of availability zones for the orderable cluster.

Class com.amazonaws.services.redshift.model.Parameter extends Object implements Serializable

Serialized Fields

parameterName

String parameterName

The name of the parameter.

parameterValue

String parameterValue

The value of the parameter.

description

String description

A description of the parameter.

source

String source

The source of the parameter value, such as "engine-default" or "user".

dataType

String dataType

The data type of the parameter.

allowedValues

String allowedValues

The valid range of values for the parameter.

isModifiable

Boolean isModifiable

If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

minimumEngineVersion

String minimumEngineVersion

The earliest engine version to which the parameter can apply.

Class com.amazonaws.services.redshift.model.PendingModifiedValues extends Object implements Serializable

Serialized Fields

masterUserPassword

String masterUserPassword

The pending or in-progress change of the master credentials for the cluster.

nodeType

String nodeType

The pending or in-progress change of the cluster's node type.

numberOfNodes

Integer numberOfNodes

The pending or in-progress change of the number nodes in the cluster.

clusterType

String clusterType

The pending or in-progress change of the cluster type.

clusterVersion

String clusterVersion

The pending or in-progress change of the service version.

automatedSnapshotRetentionPeriod

Integer automatedSnapshotRetentionPeriod

The pending or in-progress change of the automated snapshot retention period.

Class com.amazonaws.services.redshift.model.PurchaseReservedNodeOfferingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

reservedNodeOfferingId

String reservedNodeOfferingId

The unique identifier of the reserved node offering you want to purchase.

nodeCount

Integer nodeCount

The number of reserved nodes you want to purchase.

Default: 1

Class com.amazonaws.services.redshift.model.RebootClusterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterIdentifier

String clusterIdentifier

The cluster identifier.

Class com.amazonaws.services.redshift.model.RecurringCharge extends Object implements Serializable

Serialized Fields

recurringChargeAmount

Double recurringChargeAmount

The amount charged per the period of time specified by the recurring charge frequency.

recurringChargeFrequency

String recurringChargeFrequency

The frequency at which the recurring charge amount is applied.

Class com.amazonaws.services.redshift.model.ReservedNode extends Object implements Serializable

Serialized Fields

reservedNodeId

String reservedNodeId

The unique identifier for the reservation.

reservedNodeOfferingId

String reservedNodeOfferingId

The identifier for the reserved node offering.

nodeType

String nodeType

The node type of the reserved node.

startTime

Date startTime

The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.

duration

Integer duration

The duration of the node reservation in seconds.

fixedPrice

Double fixedPrice

The fixed cost Amazon Redshift charged you for this reserved node.

usagePrice

Double usagePrice

The hourly rate Amazon Redshift charge you for this reserved node.

currencyCode

String currencyCode

The currency code for the reserved cluster.

nodeCount

Integer nodeCount

The number of reserved compute nodes.

state

String state

The state of the reserved Compute Node.

Possible Values:

• pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed.
• active-This reserved node is owned by the caller and is available for use.
• payment-failed-Payment failed for the purchase attempt.

offeringType

String offeringType

The anticipated utilization of the reserved node, as defined in the reserved node offering.

recurringCharges

List<E> recurringCharges

The recurring charges for the reserved node.

Class com.amazonaws.services.redshift.model.ReservedNodeAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.ReservedNodeNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.ReservedNodeOffering extends Object implements Serializable

Serialized Fields

reservedNodeOfferingId

String reservedNodeOfferingId

The offering identifier.

nodeType

String nodeType

The node type offered by the reserved node offering.

duration

Integer duration

The duration, in seconds, for which the offering will reserve the node.

fixedPrice

Double fixedPrice

The upfront fixed charge you will pay to purchase the specific reserved node offering.

usagePrice

Double usagePrice

The rate you are charged for each hour the cluster that is using the offering is running.

currencyCode

String currencyCode

The currency code for the compute nodes offering.

offeringType

String offeringType

The anticipated utilization of the reserved node, as defined in the reserved node offering.

recurringCharges

List<E> recurringCharges

The charge to your account regardless of whether you are creating any clusters using the node offering. Recurring charges are only in effect for heavy-utilization reserved nodes.

Class com.amazonaws.services.redshift.model.ReservedNodeOfferingNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.ReservedNodeQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.ResetClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

parameterGroupName

String parameterGroupName

The name of the cluster parameter group to be reset.

resetAllParameters

Boolean resetAllParameters

If true, all parameters in the specified parameter group will be reset to their default values.

Default: true

parameters

List<E> parameters

An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied.

Constraints: A maximum of 20 parameters can be reset in a single request.

Class com.amazonaws.services.redshift.model.ResetClusterParameterGroupResult extends Object implements Serializable

Serialized Fields

parameterGroupName

String parameterGroupName

The name of the cluster parameter group.

parameterGroupStatus

String parameterGroupStatus

The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.

Class com.amazonaws.services.redshift.model.ResizeNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.RestoreFromClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterIdentifier

String clusterIdentifier

The identifier of the cluster that will be created from restoring the snapshot.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens.
• Alphabetic characters must be lowercase.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.
• Must be unique for all clusters within an AWS account.

snapshotIdentifier

String snapshotIdentifier

The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.

Example: my-snapshot-id

port

Integer port

The port number on which the cluster accepts connections.

Default: The same port as the original cluster.

Constraints: Must be between 1115 and 65535.

availabilityZone

String availabilityZone

The Amazon EC2 Availability Zone in which to restore the cluster.

Default: A random, system-chosen Availability Zone.

Example: us-east-1a

allowVersionUpgrade

Boolean allowVersionUpgrade

If true, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

Default: true

clusterSubnetGroupName

String clusterSubnetGroupName

The name of the subnet group where you want to cluster restored.

A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.

publiclyAccessible

Boolean publiclyAccessible

If true, the cluster can be accessed from a public network.

Class com.amazonaws.services.redshift.model.RevokeClusterSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterSecurityGroupName

String clusterSecurityGroupName

The name of the security Group from which to revoke the ingress rule.

cIDRIP

String cIDRIP

The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.

eC2SecurityGroupName

String eC2SecurityGroupName

The name of the EC2 Security Group whose access is to be revoked. If EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must also be provided and CIDRIP cannot be provided.

eC2SecurityGroupOwnerId

String eC2SecurityGroupOwnerId

The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.

Example: 111122223333

Class com.amazonaws.services.redshift.model.Snapshot extends Object implements Serializable

Serialized Fields

snapshotIdentifier

String snapshotIdentifier

The snapshot identifier that is provided in the request.

clusterIdentifier

String clusterIdentifier

The identifier of the cluster for which the snapshot was taken.

snapshotCreateTime

Date snapshotCreateTime

The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

status

String status

The snapshot status. The value of the status depends on the API operation used.

• CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
• DescribeClusterSnapshots returns status as "creating", "available", or "failed".
• DeleteClusterSnapshot returns status as "deleted".

port

Integer port

The port that the cluster is listening on.

availabilityZone

String availabilityZone

The Availability Zone in which the cluster was created.

clusterCreateTime

Date clusterCreateTime

The time (UTC) when the cluster was originally created.

masterUsername

String masterUsername

The master user name for the cluster.

clusterVersion

String clusterVersion

The version ID of the Amazon Redshift engine that is running on the cluster.

snapshotType

String snapshotType

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".

nodeType

String nodeType

The node type of the nodes in the cluster.

numberOfNodes

Integer numberOfNodes

The number of nodes in the cluster.

dBName

String dBName

The name of the database that was created when the cluster was created.

vpcId

String vpcId

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

encrypted

Boolean encrypted

If true, the data in the snapshot is encrypted at rest.

Class com.amazonaws.services.redshift.model.Subnet extends Object implements Serializable

Serialized Fields

subnetIdentifier

String subnetIdentifier

The identifier of the subnet.

subnetAvailabilityZone

AvailabilityZone subnetAvailabilityZone

Describes an availability zone.

subnetStatus

String subnetStatus

The status of the subnet.

Class com.amazonaws.services.redshift.model.SubnetAlreadyInUseException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.UnsupportedOptionException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.redshift.model.VpcSecurityGroupMembership extends Object implements Serializable

Serialized Fields

vpcSecurityGroupId

String vpcSecurityGroupId

status

String status

Package com.amazonaws.services.route53.model

Class com.amazonaws.services.route53.model.AliasTarget extends Object implements Serializable

Serialized Fields

hostedZoneId

String hostedZoneId

Alias resource record sets only: The value of the hosted zone ID for the AWS resource.

For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide.

Constraints:
Length: 0 - 32

dNSName

String dNSName

Alias resource record sets only: The external DNS name associated with the AWS Resource.

For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide.

Constraints:
Length: 0 - 1024

evaluateTargetHealth

Boolean evaluateTargetHealth

Alias resource record sets only: A boolean value that indicates whether this Resource Record Set should respect the health status of any health checks associated with the ALIAS target record which it is linked to.

For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide.

Class com.amazonaws.services.route53.model.Change extends Object implements Serializable

Serialized Fields

action

String action

The action to perform.

Valid values: CREATE | DELETE

Constraints:
Allowed Values: CREATE, DELETE

resourceRecordSet

ResourceRecordSet resourceRecordSet

Information about the resource record set to create or delete.

Class com.amazonaws.services.route53.model.ChangeBatch extends Object implements Serializable

Serialized Fields

comment

String comment

Optional: Any comments you want to include about a change batch request.

Constraints:
Length: 0 - 256

changes

List<E> changes

A complex type that contains one Change element for each resource record set that you want to create or delete.

Constraints:
Length: 1 -

Class com.amazonaws.services.route53.model.ChangeInfo extends Object implements Serializable

Serialized Fields

id

String id

The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.

Constraints:
Length: 0 - 32

status

String status

The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.

Valid Values: PENDING | INSYNC

Constraints:
Allowed Values: PENDING, INSYNC

submittedAt

Date submittedAt

The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.

comment

String comment

A complex type that describes change information about changes made to your hosted zone.

This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

Constraints:
Length: 0 - 256

Class com.amazonaws.services.route53.model.ChangeResourceRecordSetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

hostedZoneId

String hostedZoneId

Alias resource record sets only: The value of the hosted zone ID for the AWS resource.

For more information, an example, and several ways to get the hosted zone ID for the LoadBalancer, see Creating Alias Resource Record Sets for Elastic Load Balancing in the Amazon Route 53 Developer Guide.

Constraints:
Length: 0 - 32

changeBatch

ChangeBatch changeBatch

A complex type that contains an optional comment and the Changes element.

Class com.amazonaws.services.route53.model.ChangeResourceRecordSetsResult extends Object implements Serializable

Serialized Fields

changeInfo

ChangeInfo changeInfo

A complex type that contains information about changes made to your hosted zone.

This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

Class com.amazonaws.services.route53.model.CreateHealthCheckRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

callerReference

String callerReference

A unique string that identifies the request and that allows failed CreateHealthCheck requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a health check. CallerReference can be any unique string; you might choose to use a string that identifies your project.

Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.

Constraints:
Length: 1 - 64

healthCheckConfig

HealthCheckConfig healthCheckConfig

A complex type that contains health check configuration.

Class com.amazonaws.services.route53.model.CreateHealthCheckResult extends Object implements Serializable

Serialized Fields

healthCheck

HealthCheck healthCheck

A complex type that contains identifying information about the health check.

location

String location

The unique URL representing the new health check.

Constraints:
Length: 0 - 1024

Class com.amazonaws.services.route53.model.CreateHostedZoneRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.

Constraints:
Length: 0 - 1024

callerReference

String callerReference

A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a hosted zone. CallerReference can be any unique string; you might choose to use a string that identifies your project, such as DNSMigration_01.

Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.

Constraints:
Length: 1 - 128

hostedZoneConfig

HostedZoneConfig hostedZoneConfig

A complex type that contains an optional comment about your hosted zone.

Class com.amazonaws.services.route53.model.CreateHostedZoneResult extends Object implements Serializable

Serialized Fields

hostedZone

HostedZone hostedZone

A complex type that contains identifying information about the hosted zone.

changeInfo

ChangeInfo changeInfo

A complex type that contains information about the request to create a hosted zone. This includes an ID that you use when you call the GetChange action to get the current status of the change request.

delegationSet

DelegationSet delegationSet

A complex type that contains name server information.

location

String location

The unique URL representing the new hosted zone.

Constraints:
Length: 0 - 1024

Class com.amazonaws.services.route53.model.DelegationSet extends Object implements Serializable

Serialized Fields

nameServers

List<E> nameServers

A complex type that contains the authoritative name servers for the hosted zone. Use the method provided by your domain registrar to add an NS record to your domain for each NameServer that is assigned to your hosted zone.

Constraints:
Length: 1 -

Class com.amazonaws.services.route53.model.DelegationSetNotAvailableException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.route53.model.DeleteHealthCheckRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

healthCheckId

String healthCheckId

The ID of the health check to delete.

Constraints:
Length: 0 - 64

Class com.amazonaws.services.route53.model.DeleteHealthCheckResult extends Object implements Serializable

Class com.amazonaws.services.route53.model.DeleteHostedZoneRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The ID of the request. Include this ID in a call to GetChange to track when the change has propagated to all Route 53 DNS servers.

Constraints:
Length: 0 - 32

Class com.amazonaws.services.route53.model.DeleteHostedZoneResult extends Object implements Serializable

Serialized Fields

changeInfo

ChangeInfo changeInfo

A complex type that contains the ID, the status, and the date and time of your delete request.

Class com.amazonaws.services.route53.model.GetChangeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The ID of the change batch request. The value that you specify here is the value that ChangeResourceRecordSets returned in the Id element when you submitted the request.

Constraints:
Length: 0 - 32

Class com.amazonaws.services.route53.model.GetChangeResult extends Object implements Serializable

Serialized Fields

changeInfo

ChangeInfo changeInfo

A complex type that contains information about the specified change batch, including the change batch ID, the status of the change, and the date and time of the request.

Class com.amazonaws.services.route53.model.GetHealthCheckRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

healthCheckId

String healthCheckId

The ID of the health check to retrieve.

Constraints:
Length: 0 - 64

Class com.amazonaws.services.route53.model.GetHealthCheckResult extends Object implements Serializable

Serialized Fields

healthCheck

HealthCheck healthCheck

A complex type that contains the information about the specified health check.

Class com.amazonaws.services.route53.model.GetHostedZoneRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The ID of the hosted zone for which you want to get a list of the name servers in the delegation set.

Constraints:
Length: 0 - 32

Class com.amazonaws.services.route53.model.GetHostedZoneResult extends Object implements Serializable

Serialized Fields

hostedZone

HostedZone hostedZone

A complex type that contains the information about the specified hosted zone.

delegationSet

DelegationSet delegationSet

A complex type that contains information about the name servers for the specified hosted zone.

Class com.amazonaws.services.route53.model.HealthCheck extends Object implements Serializable

Serialized Fields

id

String id

The ID of the specified health check.

Constraints:
Length: 0 - 64

callerReference

String callerReference

A unique string that identifies the request to create the health check.

Constraints:
Length: 1 - 64

healthCheckConfig

HealthCheckConfig healthCheckConfig

A complex type that contains the health check configuration.

Class com.amazonaws.services.route53.model.HealthCheckAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.route53.model.HealthCheckConfig extends Object implements Serializable

Serialized Fields

iPAddress

String iPAddress

IP Address of the instance being checked.

Constraints:
Length: 0 - 15
Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$

port

Integer port

Port on which connection will be opened to the instance to health check. For HTTP this defaults to 80 if the port is not specified.

Constraints:
Range: 1 - 65535

type

String type

The type of health check to be performed. Currently supported protocols are TCP and HTTP.

Constraints:
Allowed Values: HTTP, TCP

resourcePath

String resourcePath

Path to ping on the instance to check the health. Required only for HTTP health checks, HTTP request is issued to the instance on the given port and path.

Constraints:
Length: 0 - 255

fullyQualifiedDomainName

String fullyQualifiedDomainName

Fully qualified domain name of the instance to be health checked.

Constraints:
Length: 0 - 255

Class com.amazonaws.services.route53.model.HealthCheckInUseException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.route53.model.HostedZone extends Object implements Serializable

Serialized Fields

id

String id

The ID of the specified hosted zone.

Constraints:
Length: 0 - 32

name

String name

The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.

Constraints:
Length: 0 - 1024

callerReference

String callerReference

A unique string that identifies the request to create the hosted zone.

Constraints:
Length: 1 - 128

config

HostedZoneConfig config

A complex type that contains the Comment element.

resourceRecordSetCount

Long resourceRecordSetCount

Total number of resource record sets in the hosted zone.

Class com.amazonaws.services.route53.model.HostedZoneAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.route53.model.HostedZoneConfig extends Object implements Serializable

Serialized Fields

comment

String comment

An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.

Constraints:
Length: 0 - 256

Class com.amazonaws.services.route53.model.HostedZoneNotEmptyException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.route53.model.InvalidChangeBatchException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.route53.model.InvalidDomainNameException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.route53.model.InvalidInputException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.route53.model.ListHealthChecksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

marker

String marker

If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.

Constraints:
Length: 0 - 64

maxItems

String maxItems

Specify the maximum number of health checks to return per page of results.

Class com.amazonaws.services.route53.model.ListHealthChecksResult extends Object implements Serializable

Serialized Fields

healthChecks

List<E> healthChecks

A complex type that contains information about the health checks associated with the current AWS account.

marker

String marker

If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.

Constraints:
Length: 0 - 64

isTruncated

Boolean isTruncated

A flag indicating whether there are more health checks to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.

Valid Values: true | false

nextMarker

String nextMarker

Indicates where to continue listing health checks. If ListHealthChecksResponse$IsTruncated is true, make another request to ListHealthChecks and include the value of the NextMarker element in the Marker element to get the next page of results.

Constraints:
Length: 0 - 64

maxItems

String maxItems

The maximum number of health checks to be included in the response body. If the number of health checks associated with this AWS account exceeds MaxItems, the value of ListHealthChecksResponse$IsTruncated in the response is true. Call ListHealthChecks again and specify the value of ListHealthChecksResponse$NextMarker in the ListHostedZonesRequest$Marker element to get the next page of results.

Class com.amazonaws.services.route53.model.ListHostedZonesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

marker

String marker

If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.

Constraints:
Length: 0 - 64

maxItems

String maxItems

Specify the maximum number of hosted zones to return per page of results.

Class com.amazonaws.services.route53.model.ListHostedZonesResult extends Object implements Serializable

Serialized Fields

hostedZones

List<E> hostedZones

A complex type that contains information about the hosted zones associated with the current AWS account.

marker

String marker

If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.

Constraints:
Length: 0 - 64

isTruncated

Boolean isTruncated

A flag indicating whether there are more hosted zones to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.

Valid Values: true | false

nextMarker

String nextMarker

Indicates where to continue listing hosted zones. If ListHostedZonesResponse$IsTruncated is true, make another request to ListHostedZones and include the value of the NextMarker element in the Marker element to get the next page of results.

Constraints:
Length: 0 - 64

maxItems

String maxItems

The maximum number of hosted zones to be included in the response body. If the number of hosted zones associated with this AWS account exceeds MaxItems, the value of ListHostedZonesResponse$IsTruncated in the response is true. Call ListHostedZones again and specify the value of ListHostedZonesResponse$NextMarker in the ListHostedZonesRequest$Marker element to get the next page of results.

Class com.amazonaws.services.route53.model.ListResourceRecordSetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

hostedZoneId

String hostedZoneId

The ID of the hosted zone that contains the resource record sets that you want to get.

Constraints:
Length: 0 - 32

startRecordName

String startRecordName

The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets request to list.

Constraints:
Length: 0 - 1024

startRecordType

String startRecordType

The DNS type at which to begin the listing of resource record sets.

Valid values: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT

Values for Weighted Resource Record Sets: A | AAAA | CNAME | TXT

Values for Regional Resource Record Sets: A | AAAA | CNAME | TXT

Values for Alias Resource Record Sets: A | AAAA

Constraint: Specifying type without specifying name returns an InvalidInput error.

Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA

startRecordIdentifier

String startRecordIdentifier

Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of ListResourceRecordSetsResponse$NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.

Constraints:
Length: 1 - 128

maxItems

String maxItems

The maximum number of records you want in the response body.

Class com.amazonaws.services.route53.model.ListResourceRecordSetsResult extends Object implements Serializable

Serialized Fields

resourceRecordSets

List<E> resourceRecordSets

A complex type that contains information about the resource record sets that are returned by the request.

isTruncated

Boolean isTruncated

A flag that indicates whether there are more resource record sets to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the ListResourceRecordSetsResponse$NextRecordName element.

Valid Values: true | false

nextRecordName

String nextRecordName

If the results were truncated, the name of the next record in the list. This element is present only if ListResourceRecordSetsResponse$IsTruncated is true.

Constraints:
Length: 0 - 1024

nextRecordType

String nextRecordType

If the results were truncated, the type of the next record in the list. This element is present only if ListResourceRecordSetsResponse$IsTruncated is true.

Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA

nextRecordIdentifier

String nextRecordIdentifier

Weighted resource record sets only: If results were truncated for a given DNS name and type, the value of SetIdentifier for the next resource record set that has the current DNS name and type.

Constraints:
Length: 1 - 128

maxItems

String maxItems

The maximum number of records you requested. The maximum value of MaxItems is 100.

Class com.amazonaws.services.route53.model.NoSuchChangeException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.route53.model.NoSuchHealthCheckException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.route53.model.NoSuchHostedZoneException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.route53.model.PriorRequestNotCompleteException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.route53.model.ResourceRecord extends Object implements Serializable

Serialized Fields

value

String value

The value of the Value element for the current resource record set.

Constraints:
Length: 0 - 4000

Class com.amazonaws.services.route53.model.ResourceRecordSet extends Object implements Serializable

Serialized Fields

name

String name

The domain name of the current resource record set.

Constraints:
Length: 0 - 1024

type

String type

The type of the current resource record set.

Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA

setIdentifier

String setIdentifier

Weighted, Regional, and Failover resource record sets only: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type.

Constraints:
Length: 1 - 128

weight

Long weight

Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines what portion of traffic for the current resource record set is routed to the associated location.

Constraints:
Range: 0 - 255

region

String region

Regional resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the AWS region for the current resource record set.

Constraints:
Length: 1 - 64
Allowed Values: us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1

failover

String failover

Failover resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that indicates whether the current resource record set is a primary or secondary resource record set. A failover set may contain at most one resource record set marked as primary and one resource record set marked as secondary. A resource record set marked as primary will be returned if any of the following are true: (1) an associated health check is passing, (2) if the resource record set is an alias with the evaluate target health and at least one target resource record set is healthy, (3) both the primary and secondary resource record set are failing health checks or (4) there is no secondary resource record set. A secondary resource record set will be returned if: (1) the primary is failing a health check and either the secondary is passing a health check or has no associated health check, or (2) there is no primary resource record set.

Valid values: PRIMARY | SECONDARY

Constraints:
Allowed Values: PRIMARY, SECONDARY

tTL

Long tTL

The cache time to live for the current resource record set.

Constraints:
Range: 0 - 2147483647

resourceRecords

List<E> resourceRecords

A complex type that contains the resource records for the current resource record set.

Constraints:
Length: 1 -

aliasTarget

AliasTarget aliasTarget

Alias resource record sets only: Information about the AWS resource to which you are redirecting traffic.

healthCheckId

String healthCheckId

Health Check resource record sets only, not required for alias resource record sets: An identifier that is used to identify health check associated with the resource record set.

Constraints:
Length: 0 - 64

Class com.amazonaws.services.route53.model.TooManyHealthChecksException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.route53.model.TooManyHostedZonesException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Package com.amazonaws.services.s3.model

Class com.amazonaws.services.s3.model.AccessControlList extends Object implements Serializable

serialVersionUID: 8095040648034788376L

Serialized Fields

grants

HashSet<E> grants

owner

Owner owner

Class com.amazonaws.services.s3.model.AmazonS3Exception extends AmazonServiceException implements Serializable

serialVersionUID: 7573680383273658477L

Serialized Fields

extendedRequestId

String extendedRequestId

An S3 specific request ID that provides additional debugging information.

Class com.amazonaws.services.s3.model.MultiObjectDeleteException extends AmazonS3Exception implements Serializable

serialVersionUID: -2004213552302446866L

Serialized Fields

errors

List<E> errors

deletedObjects

List<E> deletedObjects

Class com.amazonaws.services.s3.model.Owner extends Object implements Serializable

serialVersionUID: -8916731456944569115L

Serialized Fields

displayName

String displayName

id

String id

Package com.amazonaws.services.securitytoken.model

Class com.amazonaws.services.securitytoken.model.AssumedRoleUser extends Object implements Serializable

Serialized Fields

assumedRoleId

String assumedRoleId

A unique identifier that contains the role ID and the role session name of the role that is being assumed. The role ID was generated by AWS when the role was created.

Constraints:
Length: 2 - 96
Pattern: [\w+=,.@:-]*

arn

String arn

The ARN of the temporary security credentials that are returned from the AssumeRole action. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using IAM.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.securitytoken.model.AssumeRoleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

roleArn

String roleArn

The Amazon Resource Name (ARN) of the role that the caller is assuming.

Constraints:
Length: 20 - 2048

roleSessionName

String roleSessionName

An identifier for the assumed role session. The session name is included as part of the AssumedRoleUser.

Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*

policy

String policy

A supplemental policy that can be associated with the temporary security credentials. The caller can restrict the permissions that are available on the role's temporary security credentials to maintain the least amount of privileges. When a service call is made with the temporary security credentials, both the role's permission policy and supplemental policy are checked. For more information about how permissions work in the context of temporary credentials, see Controlling Permissions in Temporary Credentials.

Constraints:
Length: 1 - 2048
Pattern: [ -?]+

durationSeconds

Integer durationSeconds

The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds (1 hour).

Constraints:
Range: 900 - 3600

externalId

String externalId

A unique identifier that is generated by a third party for each of their customers. For each role that the third party can assume, they should instruct their customers to create a role with the external ID that was generated by the third party. Each time the third party assumes the role, they must pass the customer's correct external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see About the External ID in Using Temporary Security Credentials.

Constraints:
Length: 2 - 96
Pattern: [\w+=,.@:-]*

Class com.amazonaws.services.securitytoken.model.AssumeRoleResult extends Object implements Serializable

Serialized Fields

credentials

Credentials credentials

The temporary security credentials, which includes an Access Key ID, a Secret Access Key, and a security token.

assumedRoleUser

AssumedRoleUser assumedRoleUser

The Amazon Resource Name (ARN) and the assumed role ID for the temporary security credentials. The ARN and the role ID are identifiers for the temporary security credentials so that you can refer to the temporary credentials in a policy. For example, if you want to build a policy that applies to these temporary credentials, you would specify the AssumedRoleUser ARN or role ID in that policy.

packedPolicySize

Integer packedPolicySize

A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

Constraints:
Range: 0 -

Class com.amazonaws.services.securitytoken.model.Credentials extends Object implements Serializable

Serialized Fields

accessKeyId

String accessKeyId

AccessKeyId ID that identifies the temporary credentials.

Constraints:
Length: 16 - 32
Pattern: [\w]*

secretAccessKey

String secretAccessKey

The Secret Access Key to sign requests.

sessionToken

String sessionToken

The security token that users must pass to the service API to use the temporary credentials.

expiration

Date expiration

The date on which these credentials expire.

Class com.amazonaws.services.securitytoken.model.FederatedUser extends Object implements Serializable

Serialized Fields

federatedUserId

String federatedUserId

The string identifying the federated user associated with the credentials, similar to the UserId of an IAM user.

Constraints:
Length: 2 - 96
Pattern: [\w+=,.@\:-]*

arn

String arn

The ARN specifying the federated user associated with the credentials. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using IAM.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.securitytoken.model.GetFederationTokenRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

The name of the federated user associated with the credentials. For information about limitations on user names, go to Limitations on IAM Entities in Using IAM.

Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*

policy

String policy

A policy specifying the permissions to associate with the credentials. The caller can delegate their own permissions by specifying a policy, and both policies will be checked when a service call is made. For more information about how permissions work in the context of temporary credentials, see Controlling Permissions in Temporary Credentials in Using IAM.

Constraints:
Length: 1 - 2048
Pattern: [ -?]+

durationSeconds

Integer durationSeconds

The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900s (15 minutes) to 129600s (36 hours), with 43200s (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3600s (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour.

Constraints:
Range: 900 - 129600

Class com.amazonaws.services.securitytoken.model.GetFederationTokenResult extends Object implements Serializable

Serialized Fields

credentials

Credentials credentials

Credentials for the service API authentication.

federatedUser

FederatedUser federatedUser

Identifiers for the federated user associated with the credentials. You can use the federated user's ARN in your resource policies.

packedPolicySize

Integer packedPolicySize

A percentage value indicating the size of the policy in packed form. Policies for which the packed size is greater than 100% of the allowed value are rejected by the service.

Constraints:
Range: 0 -

Class com.amazonaws.services.securitytoken.model.GetSessionTokenRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

durationSeconds

Integer durationSeconds

The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900s (15 minutes) to 129600s (36 hours), with 43200s (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3600s (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour.

Constraints:
Range: 900 - 129600

serialNumber

String serialNumber

The identification number of the MFA device for the user. If the IAM user has a policy requiring MFA authentication (or is in a group requiring MFA authentication) to access resources, provide the device value here.

The value is in the Security Credentials tab of the user's details pane in the IAM console. If the IAM user has an active MFA device, the details pane displays a Multi-Factor Authentication Device value. The value is either for a virtual device, such as arn:aws:iam::123456789012:mfa/user, or it is the device serial number for a hardware device (usually the number from the back of the device), such as GAHT12345678. For more information, see Using Multi-Factor Authentication (MFA) Devices with AWS in Using IAM.

Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*

tokenCode

String tokenCode

The value provided by the MFA device. If the user has an access policy requiring an MFA code (or is in a group requiring an MFA code), provide the value here to get permission to resources as specified in the access policy. If MFA authentication is required, and the user does not provide a code when requesting a set of temporary security credentials, the user will receive an "access denied" response when requesting resources that require MFA authentication. For more information, see Using Multi-Factor Authentication (MFA) Devices with AWS in Using IAM.

Constraints:
Length: 6 - 6
Pattern: [\d]*

Class com.amazonaws.services.securitytoken.model.GetSessionTokenResult extends Object implements Serializable

Serialized Fields

credentials

Credentials credentials

The session credentials for API authentication.

Class com.amazonaws.services.securitytoken.model.MalformedPolicyDocumentException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.securitytoken.model.PackedPolicyTooLargeException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Package com.amazonaws.services.simpledb.model

Class com.amazonaws.services.simpledb.model.Attribute extends Object implements Serializable

Serialized Fields

name

String name

The name of the attribute.

alternateNameEncoding

String alternateNameEncoding

value

String value

The value of the attribute.

alternateValueEncoding

String alternateValueEncoding

Class com.amazonaws.services.simpledb.model.AttributeDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

boxUsage

Float boxUsage

Class com.amazonaws.services.simpledb.model.BatchDeleteAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

The name of the domain in which the attributes are being deleted.

items

List<E> items

A list of items on which to perform the operation.

Class com.amazonaws.services.simpledb.model.BatchPutAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

The name of the domain in which the attributes are being stored.

items

List<E> items

A list of items on which to perform the operation.

Class com.amazonaws.services.simpledb.model.CreateDomainRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

The name of the domain to create. The name can range between 3 and 255 characters and can contain the following characters: a-z, A-Z, 0-9, '_', '-', and '.'.

Class com.amazonaws.services.simpledb.model.DeletableItem extends Object implements Serializable

Serialized Fields

name

String name

attributes

List<E> attributes

Class com.amazonaws.services.simpledb.model.DeleteAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

The name of the domain in which to perform the operation.

itemName

String itemName

The name of the item. Similar to rows on a spreadsheet, items represent individual objects that contain one or more value-attribute pairs.

attributes

List<E> attributes

A list of Attributes. Similar to columns on a spreadsheet, attributes represent categories of data that can be assigned to items.

expected

UpdateCondition expected

The update condition which, if specified, determines whether the specified attributes will be deleted or not. The update condition must be satisfied in order for this request to be processed and the attributes to be deleted.

Class com.amazonaws.services.simpledb.model.DeleteDomainRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

The name of the domain to delete.

Class com.amazonaws.services.simpledb.model.DomainMetadataRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

The name of the domain for which to display the metadata of.

Class com.amazonaws.services.simpledb.model.DomainMetadataResult extends Object implements Serializable

Serialized Fields

itemCount

Integer itemCount

The number of all items in the domain.

itemNamesSizeBytes

Long itemNamesSizeBytes

The total size of all item names in the domain, in bytes.

attributeNameCount

Integer attributeNameCount

The number of unique attribute names in the domain.

attributeNamesSizeBytes

Long attributeNamesSizeBytes

The total size of all unique attribute names in the domain, in bytes.

attributeValueCount

Integer attributeValueCount

The number of all attribute name/value pairs in the domain.

attributeValuesSizeBytes

Long attributeValuesSizeBytes

The total size of all attribute values in the domain, in bytes.

timestamp

Integer timestamp

The data and time when metadata was calculated, in Epoch (UNIX) seconds.

Class com.amazonaws.services.simpledb.model.DuplicateItemNameException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

boxUsage

Float boxUsage

Class com.amazonaws.services.simpledb.model.GetAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

The name of the domain in which to perform the operation.

itemName

String itemName

The name of the item.

attributeNames

List<E> attributeNames

The names of the attributes.

consistentRead

Boolean consistentRead

Determines whether or not strong consistency should be enforced when data is read from SimpleDB. If true, any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read.

Class com.amazonaws.services.simpledb.model.GetAttributesResult extends Object implements Serializable

Serialized Fields

attributes

List<E> attributes

The list of attributes returned by the operation.

Class com.amazonaws.services.simpledb.model.InvalidNextTokenException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

boxUsage

Float boxUsage

Class com.amazonaws.services.simpledb.model.InvalidNumberPredicatesException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

boxUsage

Float boxUsage

Class com.amazonaws.services.simpledb.model.InvalidNumberValueTestsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

boxUsage

Float boxUsage

Class com.amazonaws.services.simpledb.model.InvalidParameterValueException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

boxUsage

Float boxUsage

Class com.amazonaws.services.simpledb.model.InvalidQueryExpressionException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

boxUsage

Float boxUsage

Class com.amazonaws.services.simpledb.model.Item extends Object implements Serializable

Serialized Fields

name

String name

The name of the item.

alternateNameEncoding

String alternateNameEncoding

attributes

List<E> attributes

A list of attributes.

Class com.amazonaws.services.simpledb.model.ListDomainsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxNumberOfDomains

Integer maxNumberOfDomains

The maximum number of domain names you want returned. The range is 1 to 100. The default setting is 100.

nextToken

String nextToken

A string informing Amazon SimpleDB where to start the next list of domain names.

Class com.amazonaws.services.simpledb.model.ListDomainsResult extends Object implements Serializable

Serialized Fields

domainNames

List<E> domainNames

A list of domain names that match the expression.

nextToken

String nextToken

An opaque token indicating that there are more domains than the specified MaxNumberOfDomains still available.

Class com.amazonaws.services.simpledb.model.MissingParameterException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

boxUsage

Float boxUsage

Class com.amazonaws.services.simpledb.model.NoSuchDomainException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

boxUsage

Float boxUsage

Class com.amazonaws.services.simpledb.model.NumberDomainAttributesExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

boxUsage

Float boxUsage

Class com.amazonaws.services.simpledb.model.NumberDomainBytesExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

boxUsage

Float boxUsage

Class com.amazonaws.services.simpledb.model.NumberDomainsExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

boxUsage

Float boxUsage

Class com.amazonaws.services.simpledb.model.NumberItemAttributesExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

boxUsage

Float boxUsage

Class com.amazonaws.services.simpledb.model.NumberSubmittedAttributesExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

boxUsage

Float boxUsage

Class com.amazonaws.services.simpledb.model.NumberSubmittedItemsExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

boxUsage

Float boxUsage

Class com.amazonaws.services.simpledb.model.PutAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

The name of the domain in which to perform the operation.

itemName

String itemName

The name of the item.

attributes

List<E> attributes

The list of attributes.

expected

UpdateCondition expected

The update condition which, if specified, determines whether the specified attributes will be updated or not. The update condition must be satisfied in order for this request to be processed and the attributes to be updated.

Class com.amazonaws.services.simpledb.model.ReplaceableAttribute extends Object implements Serializable

Serialized Fields

name

String name

The name of the replaceable attribute.

value

String value

The value of the replaceable attribute.

replace

Boolean replace

A flag specifying whether or not to replace the attribute/value pair or to add a new attribute/value pair. The default setting is false.

Class com.amazonaws.services.simpledb.model.ReplaceableItem extends Object implements Serializable

Serialized Fields

name

String name

The name of the replaceable item.

attributes

List<E> attributes

The list of attributes for a replaceable item.

Class com.amazonaws.services.simpledb.model.RequestTimeoutException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

boxUsage

Float boxUsage

Class com.amazonaws.services.simpledb.model.SelectRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

selectExpression

String selectExpression

The expression used to query the domain.

nextToken

String nextToken

A string informing Amazon SimpleDB where to start the next list of ItemNames.

consistentRead

Boolean consistentRead

Determines whether or not strong consistency should be enforced when data is read from SimpleDB. If true, any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read.

Class com.amazonaws.services.simpledb.model.SelectResult extends Object implements Serializable

Serialized Fields

items

List<E> items

A list of items that match the select expression.

nextToken

String nextToken

An opaque token indicating that more items than MaxNumberOfItems were matched, the response size exceeded 1 megabyte, or the execution time exceeded 5 seconds.

Class com.amazonaws.services.simpledb.model.TooManyRequestedAttributesException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

boxUsage

Float boxUsage

Class com.amazonaws.services.simpledb.model.UpdateCondition extends Object implements Serializable

Serialized Fields

name

String name

The name of the attribute involved in the condition.

value

String value

The value of an attribute. This value can only be specified when the Exists parameter is equal to true.

exists

Boolean exists

A value specifying whether or not the specified attribute must exist with the specified value in order for the update condition to be satisfied. Specify true if the attribute must exist for the update condition to be satisfied. Specify false if the attribute should not exist in order for the update condition to be satisfied.

Package com.amazonaws.services.simpleemail.model

Class com.amazonaws.services.simpleemail.model.Body extends Object implements Serializable

Serialized Fields

text

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).

html

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.

Class com.amazonaws.services.simpleemail.model.Content extends Object implements Serializable

Serialized Fields

data

String data

The textual data of the content.

charset

String charset

The character set of the content.

Class com.amazonaws.services.simpleemail.model.DeleteIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identity

String identity

The identity to be removed from the list of identities for the AWS Account.

Class com.amazonaws.services.simpleemail.model.DeleteIdentityResult extends Object implements Serializable

Class com.amazonaws.services.simpleemail.model.DeleteVerifiedEmailAddressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

emailAddress

String emailAddress

An email address to be removed from the list of verified addresses.

Class com.amazonaws.services.simpleemail.model.Destination extends Object implements Serializable

Serialized Fields

toAddresses

List<E> toAddresses

The To: field(s) of the message.

ccAddresses

List<E> ccAddresses

The CC: field(s) of the message.

bccAddresses

List<E> bccAddresses

The BCC: field(s) of the message.

Class com.amazonaws.services.simpleemail.model.GetIdentityDkimAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identities

List<E> identities

A list of one or more verified identities - email addresses, domains, or both.

Class com.amazonaws.services.simpleemail.model.GetIdentityDkimAttributesResult extends Object implements Serializable

Serialized Fields

dkimAttributes

Map<K,V> dkimAttributes

The DKIM attributes for an email address or a domain.

Class com.amazonaws.services.simpleemail.model.GetIdentityNotificationAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identities

List<E> identities

A list of one or more identities.

Class com.amazonaws.services.simpleemail.model.GetIdentityNotificationAttributesResult extends Object implements Serializable

Serialized Fields

notificationAttributes

Map<K,V> notificationAttributes

A map of Identity to IdentityNotificationAttributes.

Class com.amazonaws.services.simpleemail.model.GetIdentityVerificationAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identities

List<E> identities

A list of identities.

Class com.amazonaws.services.simpleemail.model.GetIdentityVerificationAttributesResult extends Object implements Serializable

Serialized Fields

verificationAttributes

Map<K,V> verificationAttributes

A map of Identities to IdentityVerificationAttributes objects.

Class com.amazonaws.services.simpleemail.model.GetSendQuotaRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.simpleemail.model.GetSendQuotaResult extends Object implements Serializable

Serialized Fields

max24HourSend

Double max24HourSend

The maximum number of emails the user is allowed to send in a 24-hour interval.

maxSendRate

Double maxSendRate

The maximum number of emails the user is allowed to send per second.

sentLast24Hours

Double sentLast24Hours

The number of emails sent during the previous 24 hours.

Class com.amazonaws.services.simpleemail.model.GetSendStatisticsRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.simpleemail.model.GetSendStatisticsResult extends Object implements Serializable

Serialized Fields

sendDataPoints

List<E> sendDataPoints

A list of data points, each of which represents 15 minutes of activity.

Class com.amazonaws.services.simpleemail.model.IdentityDkimAttributes extends Object implements Serializable

Serialized Fields

dkimEnabled

Boolean dkimEnabled

True if DKIM signing is enabled for email sent from the identity; false otherwise.

dkimVerificationStatus

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

dkimTokens

List<E> dkimTokens

A set of DNS records (tokens) that must be published in the domain name's DNS for DKIM verification to complete, and which must remain published in order for DKIM signing to succeed. The tokens are CNAME DNS records that point to DKIM public keys hosted by Amazon SES. (This only applies to domain entities, not email address identities.)

Class com.amazonaws.services.simpleemail.model.IdentityNotificationAttributes extends Object implements Serializable

Serialized Fields

bounceTopic

String bounceTopic

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic where Amazon SES will publish bounce notifications.

complaintTopic

String complaintTopic

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic where Amazon SES will publish complaint notifications.

forwardingEnabled

Boolean forwardingEnabled

Describes whether Amazon SES will forward feedback as email. true indicates that Amazon SES will forward feedback as email, while false indicates that feedback will be published only to the specified Bounce and Complaint topics.

Class com.amazonaws.services.simpleemail.model.IdentityVerificationAttributes extends Object implements Serializable

Serialized Fields

verificationStatus

String verificationStatus

The verification status of the identity: "Pending", "Success", "Failed", or "TemporaryFailure".

Constraints:
Allowed Values: Pending, Success, Failed, TemporaryFailure

verificationToken

String verificationToken

The verification token for a domain identity. Null for email address identities.

Class com.amazonaws.services.simpleemail.model.ListIdentitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identityType

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

nextToken

String nextToken

The token to use for pagination.

maxItems

Integer maxItems

The maximum number of identities per page. Possible values are 1-100 inclusive.

Class com.amazonaws.services.simpleemail.model.ListIdentitiesResult extends Object implements Serializable

Serialized Fields

identities

List<E> identities

A list of identities.

nextToken

String nextToken

The token used for pagination.

Class com.amazonaws.services.simpleemail.model.ListVerifiedEmailAddressesRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.simpleemail.model.ListVerifiedEmailAddressesResult extends Object implements Serializable

Serialized Fields

verifiedEmailAddresses

List<E> verifiedEmailAddresses

A list of email addresses that have been verified.

Class com.amazonaws.services.simpleemail.model.Message extends Object implements Serializable

Serialized Fields

subject

Content subject

The subject of the message: A short summary of the content, which will appear in the recipient's inbox.

body

Body body

The message body.

Class com.amazonaws.services.simpleemail.model.MessageRejectedException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.simpleemail.model.RawMessage extends Object implements Serializable

Serialized Fields

data

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).

For more information, go to theAmazon SES Developer Guide.

Class com.amazonaws.services.simpleemail.model.SendDataPoint extends Object implements Serializable

Serialized Fields

timestamp

Date timestamp

Time of the data point.

deliveryAttempts

Long deliveryAttempts

Number of emails that have been enqueued for sending.

bounces

Long bounces

Number of emails that have bounced.

complaints

Long complaints

Number of unwanted emails that were rejected by recipients.

rejects

Long rejects

Number of emails rejected by Amazon SES.

Class com.amazonaws.services.simpleemail.model.SendEmailRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

source

String source

The identity's email address.

destination

Destination destination

The destination for this email, composed of To:, CC:, and BCC: fields.

message

Message message

The message to be sent.

replyToAddresses

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.

returnPath

String returnPath

The email address to which bounce notifications are to be forwarded. 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.

Class com.amazonaws.services.simpleemail.model.SendEmailResult extends Object implements Serializable

Serialized Fields

messageId

String messageId

The unique message identifier returned from the SendEmail action.

Class com.amazonaws.services.simpleemail.model.SendRawEmailRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

source

String source

The identity's email address. If you specify the Source parameter, then bounce notifications and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.

destinations

List<E> destinations

A list of destinations for the message.

rawMessage

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. Refer to the Amazon SES Developer Guide for more details.
• Content must be base64-encoded, if MIME requires it.

Class com.amazonaws.services.simpleemail.model.SendRawEmailResult extends Object implements Serializable

Serialized Fields

messageId

String messageId

The unique message identifier returned from the SendRawEmail action.

Class com.amazonaws.services.simpleemail.model.SetIdentityDkimEnabledRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identity

String identity

The identity for which DKIM signing should be enabled or disabled.

dkimEnabled

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.

Class com.amazonaws.services.simpleemail.model.SetIdentityDkimEnabledResult extends Object implements Serializable

Class com.amazonaws.services.simpleemail.model.SetIdentityFeedbackForwardingEnabledRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identity

String identity

The identity for which to set feedback notification forwarding. Examples: [email protected], example.com.

forwardingEnabled

Boolean forwardingEnabled

Sets whether Amazon SES will forward feedback notifications as email. true specifies that Amazon SES will forward feedback notifications as email, in addition to any Amazon SNS topic publishing otherwise specified. false specifies that Amazon SES will publish feedback notifications only through Amazon SNS. This value can only be set to false when topics are specified for both Bounce and Complaint topic types.

Class com.amazonaws.services.simpleemail.model.SetIdentityFeedbackForwardingEnabledResult extends Object implements Serializable

Class com.amazonaws.services.simpleemail.model.SetIdentityNotificationTopicRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identity

String identity

The identity for which the topic will be set. Examples: [email protected], example.com.

notificationType

String notificationType

The type of feedback notifications that will be published to the specified topic.

Constraints:
Allowed Values: Bounce, Complaint

snsTopic

String snsTopic

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic. If the parameter is ommited from the request or a null value is passed, the topic is cleared and publishing is disabled.

Class com.amazonaws.services.simpleemail.model.SetIdentityNotificationTopicResult extends Object implements Serializable

Class com.amazonaws.services.simpleemail.model.VerifyDomainDkimRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain to be verified for Easy DKIM signing.

Class com.amazonaws.services.simpleemail.model.VerifyDomainDkimResult extends Object implements Serializable

Serialized Fields

dkimTokens

List<E> dkimTokens

A set of DNS records (tokens) that must be published in the domain name's DNS for DKIM verification to complete, and which must remain published in order for DKIM signing to succeed. The tokens are CNAME DNS records pointing to DKIM public keys hosted by Amazon SES.

Class com.amazonaws.services.simpleemail.model.VerifyDomainIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The domain to be verified.

Class com.amazonaws.services.simpleemail.model.VerifyDomainIdentityResult extends Object implements Serializable

Serialized Fields

verificationToken

String verificationToken

A TXT record that must be placed in the DNS settings for the domain, in order to complete domain verification.

Class com.amazonaws.services.simpleemail.model.VerifyEmailAddressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

emailAddress

String emailAddress

The email address to be verified.

Class com.amazonaws.services.simpleemail.model.VerifyEmailIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

emailAddress

String emailAddress

The email address to be verified.

Class com.amazonaws.services.simpleemail.model.VerifyEmailIdentityResult extends Object implements Serializable

Package com.amazonaws.services.simpleworkflow.flow

Class com.amazonaws.services.simpleworkflow.flow.ActivityFailureException extends RuntimeException implements Serializable

Serialized Fields

details

String details

Class com.amazonaws.services.simpleworkflow.flow.ActivityTaskException extends DecisionException implements Serializable

Serialized Fields

activityType

ActivityType activityType

activityId

String activityId

Class com.amazonaws.services.simpleworkflow.flow.ActivityTaskFailedException extends ActivityTaskException implements Serializable

Serialized Fields

details

String details

Class com.amazonaws.services.simpleworkflow.flow.ActivityTaskTimedOutException extends ActivityTaskException implements Serializable

Serialized Fields

timeoutType

ActivityTaskTimeoutType timeoutType

details

String details

Class com.amazonaws.services.simpleworkflow.flow.ChildWorkflowException extends DecisionException implements Serializable

Serialized Fields

workflowExecution

WorkflowExecution workflowExecution

workflowType

WorkflowType workflowType

Class com.amazonaws.services.simpleworkflow.flow.ChildWorkflowFailedException extends ChildWorkflowException implements Serializable

Serialized Fields

details

String details

Class com.amazonaws.services.simpleworkflow.flow.ChildWorkflowTerminatedException extends ChildWorkflowException implements Serializable

Class com.amazonaws.services.simpleworkflow.flow.ChildWorkflowTimedOutException extends ChildWorkflowException implements Serializable

Class com.amazonaws.services.simpleworkflow.flow.DataConverterException extends RuntimeException implements Serializable

Serialized Fields

key

String key

Class com.amazonaws.services.simpleworkflow.flow.DecisionException extends RuntimeException implements Serializable

Serialized Fields

eventId

long eventId

Class com.amazonaws.services.simpleworkflow.flow.ScheduleActivityTaskFailedException extends ActivityTaskException implements Serializable

Serialized Fields

failureCause

ScheduleActivityTaskFailedCause failureCause

Class com.amazonaws.services.simpleworkflow.flow.SignalExternalWorkflowException extends DecisionException implements Serializable

Serialized Fields

failureCause

SignalExternalWorkflowExecutionFailedCause failureCause

signaledExecution

WorkflowExecution signaledExecution

Class com.amazonaws.services.simpleworkflow.flow.StartChildWorkflowFailedException extends ChildWorkflowException implements Serializable

Serialized Fields

failureCause

StartChildWorkflowExecutionFailedCause failureCause

Class com.amazonaws.services.simpleworkflow.flow.StartTimerFailedException extends TimerException implements Serializable

Serialized Fields

failureCause

StartTimerFailedCause failureCause

Class com.amazonaws.services.simpleworkflow.flow.TimerException extends DecisionException implements Serializable

Serialized Fields

timerId

String timerId

createTimerUserContext

Object createTimerUserContext

Class com.amazonaws.services.simpleworkflow.flow.WorkflowException extends Exception implements Serializable

Serialized Fields

details

String details

Package com.amazonaws.services.simpleworkflow.model

Class com.amazonaws.services.simpleworkflow.model.ActivityTask extends Object implements Serializable

Serialized Fields

taskToken

String taskToken

The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

Constraints:
Length: 1 - 1024

activityId

String activityId

The unique ID of the task.

Constraints:
Length: 1 - 256

startedEventId

Long startedEventId

The id of the ActivityTaskStarted event recorded in the history.

workflowExecution

WorkflowExecution workflowExecution

The workflow execution that started this activity task.

activityType

ActivityType activityType

The type of this activity task.

input

String input

The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.

Constraints:
Length: 0 - 32768

Class com.amazonaws.services.simpleworkflow.model.ActivityTaskCanceledEventAttributes extends Object implements Serializable

Serialized Fields

details

String details

Details of the cancellation (if any).

Constraints:
Length: 0 - 32768

scheduledEventId

Long scheduledEventId

The id of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

startedEventId

Long startedEventId

The Id of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

latestCancelRequestedEventId

Long latestCancelRequestedEventId

If set, contains the Id of the last ActivityTaskCancelRequested event recorded for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Class com.amazonaws.services.simpleworkflow.model.ActivityTaskCancelRequestedEventAttributes extends Object implements Serializable

Serialized Fields

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the cause of events.

activityId

String activityId

The unique ID of the task.

Constraints:
Length: 1 - 256

Class com.amazonaws.services.simpleworkflow.model.ActivityTaskCompletedEventAttributes extends Object implements Serializable

Serialized Fields

result

String result

The results of the activity task (if any).

Constraints:
Length: 0 - 32768

scheduledEventId

Long scheduledEventId

The id of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

startedEventId

Long startedEventId

The Id of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Class com.amazonaws.services.simpleworkflow.model.ActivityTaskFailedEventAttributes extends Object implements Serializable

Serialized Fields

reason

String reason

The reason provided for the failure (if any).

Constraints:
Length: 0 - 256

details

String details

The details of the failure (if any).

Constraints:
Length: 0 - 32768

scheduledEventId

Long scheduledEventId

The id of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

startedEventId

Long startedEventId

The Id of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Class com.amazonaws.services.simpleworkflow.model.ActivityTaskScheduledEventAttributes extends Object implements Serializable

Serialized Fields

activityType

ActivityType activityType

The type of the activity task.

activityId

String activityId

The unique id of the activity task.

Constraints:
Length: 1 - 256

input

String input

The input provided to the activity task.

Constraints:
Length: 0 - 32768

control

String control

Optional data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.

Constraints:
Length: 0 - 32768

scheduleToStartTimeout

String scheduleToStartTimeout

The maximum amount of time the activity task can wait to be assigned to a worker.

Constraints:
Length: 0 - 8

scheduleToCloseTimeout

String scheduleToCloseTimeout

The maximum amount of time for this activity task.

Constraints:
Length: 0 - 8

startToCloseTimeout

String startToCloseTimeout

The maximum amount of time a worker may take to process the activity task.

Constraints:
Length: 0 - 8

taskList

TaskList taskList

The task list in which the activity task has been scheduled.

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

heartbeatTimeout

String heartbeatTimeout

The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it will be ignored.

Constraints:
Length: 0 - 8

Class com.amazonaws.services.simpleworkflow.model.ActivityTaskStartedEventAttributes extends Object implements Serializable

Serialized Fields

identity

String identity

Identity of the worker that was assigned this task. This aids diagnostics when problems arise. The form of this identity is user defined.

Constraints:
Length: 0 - 256

scheduledEventId

Long scheduledEventId

The id of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Class com.amazonaws.services.simpleworkflow.model.ActivityTaskStatus extends Object implements Serializable

Serialized Fields

cancelRequested

Boolean cancelRequested

Set to true if cancellation of the task is requested.

Class com.amazonaws.services.simpleworkflow.model.ActivityTaskTimedOutEventAttributes extends Object implements Serializable

Serialized Fields

timeoutType

String timeoutType

The type of the timeout that caused this event.

Constraints:
Allowed Values: START_TO_CLOSE, SCHEDULE_TO_START, SCHEDULE_TO_CLOSE, HEARTBEAT

scheduledEventId

Long scheduledEventId

The id of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

startedEventId

Long startedEventId

The Id of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

details

String details

Contains the content of the details parameter for the last call made by the activity to RecordActivityTaskHeartbeat.

Constraints:
Length: 0 - 2048

Class com.amazonaws.services.simpleworkflow.model.ActivityType extends Object implements Serializable

Serialized Fields

name

String name

The name of this activity. The combination of activity type name and version must be unique within a domain.

Constraints:
Length: 1 - 256

version

String version

The version of this activity. The combination of activity type name and version must be unique with in a domain.

Constraints:
Length: 1 - 64

Class com.amazonaws.services.simpleworkflow.model.ActivityTypeConfiguration extends Object implements Serializable

Serialized Fields

defaultTaskStartToCloseTimeout

String defaultTaskStartToCloseTimeout

The optional default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the ScheduleActivityTask Decision.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

defaultTaskHeartbeatTimeout

String defaultTaskHeartbeatTimeout

The optional default maximum time, specified when registering the activity type, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat. You can override this default when scheduling a task through the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

defaultTaskList

TaskList defaultTaskList

The optional default task list specified for this activity type at registration. This default task list is used if a task list is not provided when a task is scheduled through the ScheduleActivityTask Decision. You can override this default when scheduling a task through the ScheduleActivityTask Decision.

defaultTaskScheduleToStartTimeout

String defaultTaskScheduleToStartTimeout

The optional default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the ScheduleActivityTask Decision.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

defaultTaskScheduleToCloseTimeout

String defaultTaskScheduleToCloseTimeout

The optional default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the ScheduleActivityTask Decision.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

Class com.amazonaws.services.simpleworkflow.model.ActivityTypeDetail extends Object implements Serializable

Serialized Fields

typeInfo

ActivityTypeInfo typeInfo

General information about the activity type.

The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.

• REGISTERED: The type is registered and available. Workers supporting this type should be running.
• DEPRECATED: The type was deprecated using DeprecateActivityType, but is still in use. You should keep workers supporting this type running. You cannot create new tasks of this type.

configuration

ActivityTypeConfiguration configuration

The configuration settings registered with the activity type.

Class com.amazonaws.services.simpleworkflow.model.ActivityTypeInfo extends Object implements Serializable

Serialized Fields

activityType

ActivityType activityType

The ActivityType type structure representing the activity type.

status

String status

The current status of the activity type.

Constraints:
Allowed Values: REGISTERED, DEPRECATED

description

String description

The description of the activity type provided in RegisterActivityType.

Constraints:
Length: 0 - 1024

creationDate

Date creationDate

The date and time this activity type was created through RegisterActivityType.

deprecationDate

Date deprecationDate

If DEPRECATED, the date and time DeprecateActivityType was called.

Class com.amazonaws.services.simpleworkflow.model.ActivityTypeInfos extends Object implements Serializable

Serialized Fields

typeInfos

List<E> typeInfos

List of activity type information.

nextPageToken

String nextPageToken

Returns a value if the results are paginated. To get the next page of results, repeat the request specifying this token and all other arguments unchanged.

Constraints:
Length: 0 - 2048

Class com.amazonaws.services.simpleworkflow.model.CancelTimerDecisionAttributes extends Object implements Serializable

Serialized Fields

timerId

String timerId

The unique Id of the timer to cancel. This field is required.

Constraints:
Length: 1 - 256

Class com.amazonaws.services.simpleworkflow.model.CancelTimerFailedEventAttributes extends Object implements Serializable

Serialized Fields

timerId

String timerId

The timerId provided in the CancelTimer decision that failed.

Constraints:
Length: 1 - 256

cause

String cause

The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Constraints:
Allowed Values: TIMER_ID_UNKNOWN, OPERATION_NOT_PERMITTED

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the cause of events.

Class com.amazonaws.services.simpleworkflow.model.CancelWorkflowExecutionDecisionAttributes extends Object implements Serializable

Serialized Fields

details

String details

Optional details of the cancellation.

Constraints:
Length: 0 - 32768

Class com.amazonaws.services.simpleworkflow.model.CancelWorkflowExecutionFailedEventAttributes extends Object implements Serializable

Serialized Fields

cause

String cause

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Constraints:
Allowed Values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the cause of events.

Class com.amazonaws.services.simpleworkflow.model.ChildWorkflowExecutionCanceledEventAttributes extends Object implements Serializable

Serialized Fields

workflowExecution

WorkflowExecution workflowExecution

The child workflow execution that was canceled.

workflowType

WorkflowType workflowType

The type of the child workflow execution.

details

String details

Details of the cancellation (if provided).

Constraints:
Length: 0 - 32768

initiatedEventId

Long initiatedEventId

The id of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

startedEventId

Long startedEventId

The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Class com.amazonaws.services.simpleworkflow.model.ChildWorkflowExecutionCompletedEventAttributes extends Object implements Serializable

Serialized Fields

workflowExecution

WorkflowExecution workflowExecution

The child workflow execution that was completed.

workflowType

WorkflowType workflowType

The type of the child workflow execution.

result

String result

The result of the child workflow execution (if any).

Constraints:
Length: 0 - 32768

initiatedEventId

Long initiatedEventId

The id of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

startedEventId

Long startedEventId

The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Class com.amazonaws.services.simpleworkflow.model.ChildWorkflowExecutionFailedEventAttributes extends Object implements Serializable

Serialized Fields

workflowExecution

WorkflowExecution workflowExecution

The child workflow execution that failed.

workflowType

WorkflowType workflowType

The type of the child workflow execution.

reason

String reason

The reason for the failure (if provided).

Constraints:
Length: 0 - 256

details

String details

The details of the failure (if provided).

Constraints:
Length: 0 - 32768

initiatedEventId

Long initiatedEventId

The id of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

startedEventId

Long startedEventId

The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Class com.amazonaws.services.simpleworkflow.model.ChildWorkflowExecutionStartedEventAttributes extends Object implements Serializable

Serialized Fields

workflowExecution

WorkflowExecution workflowExecution

The child workflow execution that was started.

workflowType

WorkflowType workflowType

The type of the child workflow execution.

initiatedEventId

Long initiatedEventId

The id of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Class com.amazonaws.services.simpleworkflow.model.ChildWorkflowExecutionTerminatedEventAttributes extends Object implements Serializable

Serialized Fields

workflowExecution

WorkflowExecution workflowExecution

The child workflow execution that was terminated.

workflowType

WorkflowType workflowType

The type of the child workflow execution.

initiatedEventId

Long initiatedEventId

The id of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

startedEventId

Long startedEventId

The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Class com.amazonaws.services.simpleworkflow.model.ChildWorkflowExecutionTimedOutEventAttributes extends Object implements Serializable

Serialized Fields

workflowExecution

WorkflowExecution workflowExecution

The child workflow execution that timed out.

workflowType

WorkflowType workflowType

The type of the child workflow execution.

timeoutType

String timeoutType

The type of the timeout that caused the child workflow execution to time out.

Constraints:
Allowed Values: START_TO_CLOSE

initiatedEventId

Long initiatedEventId

The id of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

startedEventId

Long startedEventId

The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Class com.amazonaws.services.simpleworkflow.model.CloseStatusFilter extends Object implements Serializable

Serialized Fields

status

String status

The close status that must match the close status of an execution for it to meet the criteria of this filter. This field is required.

Constraints:
Allowed Values: COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT

Class com.amazonaws.services.simpleworkflow.model.CompleteWorkflowExecutionDecisionAttributes extends Object implements Serializable

Serialized Fields

result

String result

The result of the workflow execution. The form of the result is implementation defined.

Constraints:
Length: 0 - 32768

Class com.amazonaws.services.simpleworkflow.model.CompleteWorkflowExecutionFailedEventAttributes extends Object implements Serializable

Serialized Fields

cause

String cause

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Constraints:
Allowed Values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the cause of events.

Class com.amazonaws.services.simpleworkflow.model.ContinueAsNewWorkflowExecutionDecisionAttributes extends Object implements Serializable

Serialized Fields

input

String input

The input provided to the new workflow execution.

Constraints:
Length: 0 - 32768

executionStartToCloseTimeout

String executionStartToCloseTimeout

If set, specifies the total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration. An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field. If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned.

Constraints:
Length: 0 - 8

taskList

TaskList taskList

Represents a task list.

taskStartToCloseTimeout

String taskStartToCloseTimeout

Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration. A task start-to-close timeout for the new workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.

Constraints:
Length: 0 - 8

childPolicy

String childPolicy

If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType. The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

A child policy for the new workflow execution must be specified either as a default registered for its workflow type or through this field. If neither this field is set nor a default child policy was specified at registration time then a fault will be returned.

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

tagList

List<E> tagList

The list of tags to associate with the new workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

Constraints:
Length: 0 - 5

workflowTypeVersion

String workflowTypeVersion

Class com.amazonaws.services.simpleworkflow.model.ContinueAsNewWorkflowExecutionFailedEventAttributes extends Object implements Serializable

Serialized Fields

cause

String cause

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Constraints:
Allowed Values: UNHANDLED_DECISION, WORKFLOW_TYPE_DEPRECATED, WORKFLOW_TYPE_DOES_NOT_EXIST, DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_TASK_LIST_UNDEFINED, DEFAULT_CHILD_POLICY_UNDEFINED, OPERATION_NOT_PERMITTED

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the cause of events.

Class com.amazonaws.services.simpleworkflow.model.CountClosedWorkflowExecutionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain containing the workflow executions to count.

Constraints:
Length: 1 - 256

startTimeFilter

ExecutionTimeFilter startTimeFilter

If specified, only workflow executions that meet the start time criteria of the filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

closeTimeFilter

ExecutionTimeFilter closeTimeFilter

If specified, only workflow executions that meet the close time criteria of the filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

executionFilter

WorkflowExecutionFilter executionFilter

If specified, only workflow executions matching the WorkflowId in the filter are counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

typeFilter

WorkflowTypeFilter typeFilter

If specified, indicates the type of the workflow executions to be counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

tagFilter

TagFilter tagFilter

If specified, only executions that have a tag that matches the filter are counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

closeStatusFilter

CloseStatusFilter closeStatusFilter

If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Class com.amazonaws.services.simpleworkflow.model.CountOpenWorkflowExecutionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain containing the workflow executions to count.

Constraints:
Length: 1 - 256

startTimeFilter

ExecutionTimeFilter startTimeFilter

Specifies the start time criteria that workflow executions must meet in order to be counted.

typeFilter

WorkflowTypeFilter typeFilter

Specifies the type of the workflow executions to be counted. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

tagFilter

TagFilter tagFilter

If specified, only executions that have a tag that matches the filter are counted. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

executionFilter

WorkflowExecutionFilter executionFilter

If specified, only workflow executions matching the WorkflowId in the filter are counted. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Class com.amazonaws.services.simpleworkflow.model.CountPendingActivityTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain that contains the task list.

Constraints:
Length: 1 - 256

taskList

TaskList taskList

The name of the task list.

Class com.amazonaws.services.simpleworkflow.model.CountPendingDecisionTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain that contains the task list.

Constraints:
Length: 1 - 256

taskList

TaskList taskList

The name of the task list.

Class com.amazonaws.services.simpleworkflow.model.Decision extends Object implements Serializable

Serialized Fields

decisionType

String decisionType

Specifies the type of the decision.

Constraints:
Allowed Values: ScheduleActivityTask, RequestCancelActivityTask, CompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution, ContinueAsNewWorkflowExecution, RecordMarker, StartTimer, CancelTimer, SignalExternalWorkflowExecution, RequestCancelExternalWorkflowExecution, StartChildWorkflowExecution

scheduleActivityTaskDecisionAttributes

ScheduleActivityTaskDecisionAttributes scheduleActivityTaskDecisionAttributes

Provides details of the ScheduleActivityTask decision. It is not set for other decision types.

requestCancelActivityTaskDecisionAttributes

RequestCancelActivityTaskDecisionAttributes requestCancelActivityTaskDecisionAttributes

Provides details of the RequestCancelActivityTask decision. It is not set for other decision types.

completeWorkflowExecutionDecisionAttributes

CompleteWorkflowExecutionDecisionAttributes completeWorkflowExecutionDecisionAttributes

Provides details of the CompleteWorkflowExecution decision. It is not set for other decision types.

failWorkflowExecutionDecisionAttributes

FailWorkflowExecutionDecisionAttributes failWorkflowExecutionDecisionAttributes

Provides details of the FailWorkflowExecution decision. It is not set for other decision types.

cancelWorkflowExecutionDecisionAttributes

CancelWorkflowExecutionDecisionAttributes cancelWorkflowExecutionDecisionAttributes

Provides details of the CancelWorkflowExecution decision. It is not set for other decision types.

continueAsNewWorkflowExecutionDecisionAttributes

ContinueAsNewWorkflowExecutionDecisionAttributes continueAsNewWorkflowExecutionDecisionAttributes

Provides details of the ContinueAsNewWorkflowExecution decision. It is not set for other decision types.

recordMarkerDecisionAttributes

RecordMarkerDecisionAttributes recordMarkerDecisionAttributes

Provides details of the RecordMarker decision. It is not set for other decision types.

startTimerDecisionAttributes

StartTimerDecisionAttributes startTimerDecisionAttributes

Provides details of the StartTimer decision. It is not set for other decision types.

cancelTimerDecisionAttributes

CancelTimerDecisionAttributes cancelTimerDecisionAttributes

Provides details of the CancelTimer decision. It is not set for other decision types.

signalExternalWorkflowExecutionDecisionAttributes

SignalExternalWorkflowExecutionDecisionAttributes signalExternalWorkflowExecutionDecisionAttributes

Provides details of the SignalExternalWorkflowExecution decision. It is not set for other decision types.

requestCancelExternalWorkflowExecutionDecisionAttributes

RequestCancelExternalWorkflowExecutionDecisionAttributes requestCancelExternalWorkflowExecutionDecisionAttributes

Provides details of the RequestCancelExternalWorkflowExecution decision. It is not set for other decision types.

startChildWorkflowExecutionDecisionAttributes

StartChildWorkflowExecutionDecisionAttributes startChildWorkflowExecutionDecisionAttributes

Provides details of the StartChildWorkflowExecution decision. It is not set for other decision types.

Class com.amazonaws.services.simpleworkflow.model.DecisionTask extends Object implements Serializable

Serialized Fields

taskToken

String taskToken

The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

Constraints:
Length: 1 - 1024

startedEventId

Long startedEventId

The id of the DecisionTaskStarted event recorded in the history.

workflowExecution

WorkflowExecution workflowExecution

The workflow execution for which this decision task was created.

workflowType

WorkflowType workflowType

The type of the workflow execution for which this decision task was created.

events

List<E> events

A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.

nextPageToken

String nextPageToken

Returns a value if the results are paginated. To get the next page of results, repeat the request specifying this token and all other arguments unchanged.

Constraints:
Length: 0 - 2048

previousStartedEventId

Long previousStartedEventId

The id of the DecisionTaskStarted event of the previous decision task of this workflow execution that was processed by the decider. This can be used to determine the events in the history new since the last decision task received by the decider.

Class com.amazonaws.services.simpleworkflow.model.DecisionTaskCompletedEventAttributes extends Object implements Serializable

Serialized Fields

executionContext

String executionContext

User defined context for the workflow execution.

Constraints:
Length: 0 - 32768

scheduledEventId

Long scheduledEventId

The id of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

startedEventId

Long startedEventId

The Id of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Class com.amazonaws.services.simpleworkflow.model.DecisionTaskScheduledEventAttributes extends Object implements Serializable

Serialized Fields

taskList

TaskList taskList

The name of the task list in which the decision task was scheduled.

startToCloseTimeout

String startToCloseTimeout

The maximum duration for this decision task. The task is considered timed out if it does not completed within this duration.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

Class com.amazonaws.services.simpleworkflow.model.DecisionTaskStartedEventAttributes extends Object implements Serializable

Serialized Fields

identity

String identity

Identity of the decider making the request. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

Constraints:
Length: 0 - 256

scheduledEventId

Long scheduledEventId

The id of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Class com.amazonaws.services.simpleworkflow.model.DecisionTaskTimedOutEventAttributes extends Object implements Serializable

Serialized Fields

timeoutType

String timeoutType

The type of timeout that expired before the decision task could be completed.

Constraints:
Allowed Values: START_TO_CLOSE

scheduledEventId

Long scheduledEventId

The id of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

startedEventId

Long startedEventId

The Id of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Class com.amazonaws.services.simpleworkflow.model.DefaultUndefinedException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.simpleworkflow.model.DeprecateActivityTypeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain in which the activity type is registered.

Constraints:
Length: 1 - 256

activityType

ActivityType activityType

The activity type to deprecate.

Class com.amazonaws.services.simpleworkflow.model.DeprecateDomainRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

The name of the domain to deprecate.

Constraints:
Length: 1 - 256

Class com.amazonaws.services.simpleworkflow.model.DeprecateWorkflowTypeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain in which the workflow type is registered.

Constraints:
Length: 1 - 256

workflowType

WorkflowType workflowType

The workflow type to deprecate.

Class com.amazonaws.services.simpleworkflow.model.DescribeActivityTypeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain in which the activity type is registered.

Constraints:
Length: 1 - 256

activityType

ActivityType activityType

The activity type to describe.

Class com.amazonaws.services.simpleworkflow.model.DescribeDomainRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

The name of the domain to describe.

Constraints:
Length: 1 - 256

Class com.amazonaws.services.simpleworkflow.model.DescribeWorkflowExecutionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain containing the workflow execution.

Constraints:
Length: 1 - 256

execution

WorkflowExecution execution

The workflow execution to describe.

Class com.amazonaws.services.simpleworkflow.model.DescribeWorkflowTypeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain in which this workflow type is registered.

Constraints:
Length: 1 - 256

workflowType

WorkflowType workflowType

The workflow type to describe.

Class com.amazonaws.services.simpleworkflow.model.DomainAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.simpleworkflow.model.DomainConfiguration extends Object implements Serializable

Serialized Fields

workflowExecutionRetentionPeriodInDays

String workflowExecutionRetentionPeriodInDays

The retention period for workflow executions in this domain.

Constraints:
Length: 1 - 8

Class com.amazonaws.services.simpleworkflow.model.DomainDeprecatedException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.simpleworkflow.model.DomainDetail extends Object implements Serializable

Serialized Fields

domainInfo

DomainInfo domainInfo

Contains general information about a domain.

configuration

DomainConfiguration configuration

Contains the configuration settings of a domain.

Class com.amazonaws.services.simpleworkflow.model.DomainInfo extends Object implements Serializable

Serialized Fields

name

String name

The name of the domain. This name is unique within the account.

Constraints:
Length: 1 - 256

status

String status

The status of the domain:

• REGISTERED: The domain is properly registered and available. You can use this domain for registering types and creating new workflow executions.
• DEPRECATED: The domain was deprecated using DeprecateDomain, but is still in use. You should not create new workflow executions in this domain.

Constraints:
Allowed Values: REGISTERED, DEPRECATED

description

String description

The description of the domain provided through RegisterDomain.

Constraints:
Length: 0 - 1024

Class com.amazonaws.services.simpleworkflow.model.DomainInfos extends Object implements Serializable

Serialized Fields

domainInfos

List<E> domainInfos

A list of DomainInfo structures.

nextPageToken

String nextPageToken

Returns a value if the results are paginated. To get the next page of results, repeat the request specifying this token and all other arguments unchanged.

Constraints:
Length: 0 - 2048

Class com.amazonaws.services.simpleworkflow.model.ExecutionTimeFilter extends Object implements Serializable

Serialized Fields

oldestDate

Date oldestDate

Specifies the oldest start or close date and time to return.

latestDate

Date latestDate

Specifies the latest start or close date and time to return.

Class com.amazonaws.services.simpleworkflow.model.ExternalWorkflowExecutionCancelRequestedEventAttributes extends Object implements Serializable

Serialized Fields

workflowExecution

WorkflowExecution workflowExecution

The external workflow execution to which the cancellation request was delivered.

initiatedEventId

Long initiatedEventId

The id of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Class com.amazonaws.services.simpleworkflow.model.ExternalWorkflowExecutionSignaledEventAttributes extends Object implements Serializable

Serialized Fields

workflowExecution

WorkflowExecution workflowExecution

The external workflow execution that the signal was delivered to.

initiatedEventId

Long initiatedEventId

The id of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Class com.amazonaws.services.simpleworkflow.model.FailWorkflowExecutionDecisionAttributes extends Object implements Serializable

Serialized Fields

reason

String reason

A descriptive reason for the failure that may help in diagnostics.

Constraints:
Length: 0 - 256

details

String details

Optional details of the failure.

Constraints:
Length: 0 - 32768

Class com.amazonaws.services.simpleworkflow.model.FailWorkflowExecutionFailedEventAttributes extends Object implements Serializable

Serialized Fields

cause

String cause

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Constraints:
Allowed Values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the cause of events.

Class com.amazonaws.services.simpleworkflow.model.GetWorkflowExecutionHistoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain containing the workflow execution.

Constraints:
Length: 1 - 256

execution

WorkflowExecution execution

Specifies the workflow execution for which to return the history.

nextPageToken

String nextPageToken

If a NextPageToken is returned, the result has more than one pages. To get the next page, repeat the call and specify the nextPageToken with all other arguments unchanged.

Constraints:
Length: 0 - 2048

maximumPageSize

Integer maximumPageSize

Specifies the maximum number of history events returned in one page. The next page in the result is identified by the NextPageToken returned. By default 100 history events are returned in a page but the caller can override this value to a page size smaller than the default. You cannot specify a page size larger than 100. Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

Constraints:
Range: 0 - 1000

reverseOrder

Boolean reverseOrder

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

Class com.amazonaws.services.simpleworkflow.model.History extends Object implements Serializable

Serialized Fields

events

List<E> events

The list of history events.

nextPageToken

String nextPageToken

The token for the next page. If set, the history consists of more than one page and the next page can be retrieved by repeating the request with this token and all other arguments unchanged.

Constraints:
Length: 0 - 2048

Class com.amazonaws.services.simpleworkflow.model.HistoryEvent extends Object implements Serializable

Serialized Fields

eventTimestamp

Date eventTimestamp

The date and time when the event occurred.

eventType

String eventType

The type of the history event.

Constraints:
Allowed Values: WorkflowExecutionStarted, WorkflowExecutionCancelRequested, WorkflowExecutionCompleted, CompleteWorkflowExecutionFailed, WorkflowExecutionFailed, FailWorkflowExecutionFailed, WorkflowExecutionTimedOut, WorkflowExecutionCanceled, CancelWorkflowExecutionFailed, WorkflowExecutionContinuedAsNew, ContinueAsNewWorkflowExecutionFailed, WorkflowExecutionTerminated, DecisionTaskScheduled, DecisionTaskStarted, DecisionTaskCompleted, DecisionTaskTimedOut, ActivityTaskScheduled, ScheduleActivityTaskFailed, ActivityTaskStarted, ActivityTaskCompleted, ActivityTaskFailed, ActivityTaskTimedOut, ActivityTaskCanceled, ActivityTaskCancelRequested, RequestCancelActivityTaskFailed, WorkflowExecutionSignaled, MarkerRecorded, RecordMarkerFailed, TimerStarted, StartTimerFailed, TimerFired, TimerCanceled, CancelTimerFailed, StartChildWorkflowExecutionInitiated, StartChildWorkflowExecutionFailed, ChildWorkflowExecutionStarted, ChildWorkflowExecutionCompleted, ChildWorkflowExecutionFailed, ChildWorkflowExecutionTimedOut, ChildWorkflowExecutionCanceled, ChildWorkflowExecutionTerminated, SignalExternalWorkflowExecutionInitiated, SignalExternalWorkflowExecutionFailed, ExternalWorkflowExecutionSignaled, RequestCancelExternalWorkflowExecutionInitiated, RequestCancelExternalWorkflowExecutionFailed, ExternalWorkflowExecutionCancelRequested

eventId

Long eventId

The system generated id of the event. This id uniquely identifies the event with in the workflow execution history.

workflowExecutionStartedEventAttributes

WorkflowExecutionStartedEventAttributes workflowExecutionStartedEventAttributes

If the event is of type WorkflowExecutionStarted then this member is set and provides detailed information about the event. It is not set for other event types.

workflowExecutionCompletedEventAttributes

WorkflowExecutionCompletedEventAttributes workflowExecutionCompletedEventAttributes

If the event is of type WorkflowExecutionCompleted then this member is set and provides detailed information about the event. It is not set for other event types.

completeWorkflowExecutionFailedEventAttributes

CompleteWorkflowExecutionFailedEventAttributes completeWorkflowExecutionFailedEventAttributes

If the event is of type CompleteWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

workflowExecutionFailedEventAttributes

WorkflowExecutionFailedEventAttributes workflowExecutionFailedEventAttributes

If the event is of type WorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

failWorkflowExecutionFailedEventAttributes

FailWorkflowExecutionFailedEventAttributes failWorkflowExecutionFailedEventAttributes

If the event is of type FailWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

workflowExecutionTimedOutEventAttributes

WorkflowExecutionTimedOutEventAttributes workflowExecutionTimedOutEventAttributes

If the event is of type WorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.

workflowExecutionCanceledEventAttributes

WorkflowExecutionCanceledEventAttributes workflowExecutionCanceledEventAttributes

If the event is of type WorkflowExecutionCanceled then this member is set and provides detailed information about the event. It is not set for other event types.

cancelWorkflowExecutionFailedEventAttributes

CancelWorkflowExecutionFailedEventAttributes cancelWorkflowExecutionFailedEventAttributes

If the event is of type CancelWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

workflowExecutionContinuedAsNewEventAttributes

WorkflowExecutionContinuedAsNewEventAttributes workflowExecutionContinuedAsNewEventAttributes

If the event is of type WorkflowExecutionContinuedAsNew then this member is set and provides detailed information about the event. It is not set for other event types.

continueAsNewWorkflowExecutionFailedEventAttributes

ContinueAsNewWorkflowExecutionFailedEventAttributes continueAsNewWorkflowExecutionFailedEventAttributes

If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

workflowExecutionTerminatedEventAttributes

WorkflowExecutionTerminatedEventAttributes workflowExecutionTerminatedEventAttributes

If the event is of type WorkflowExecutionTerminated then this member is set and provides detailed information about the event. It is not set for other event types.

workflowExecutionCancelRequestedEventAttributes

WorkflowExecutionCancelRequestedEventAttributes workflowExecutionCancelRequestedEventAttributes

If the event is of type WorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.

decisionTaskScheduledEventAttributes

DecisionTaskScheduledEventAttributes decisionTaskScheduledEventAttributes

If the event is of type DecisionTaskScheduled then this member is set and provides detailed information about the event. It is not set for other event types.

decisionTaskStartedEventAttributes

DecisionTaskStartedEventAttributes decisionTaskStartedEventAttributes

If the event is of type DecisionTaskStarted then this member is set and provides detailed information about the event. It is not set for other event types.

decisionTaskCompletedEventAttributes

DecisionTaskCompletedEventAttributes decisionTaskCompletedEventAttributes

If the event is of type DecisionTaskCompleted then this member is set and provides detailed information about the event. It is not set for other event types.

decisionTaskTimedOutEventAttributes

DecisionTaskTimedOutEventAttributes decisionTaskTimedOutEventAttributes

If the event is of type DecisionTaskTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.

activityTaskScheduledEventAttributes

ActivityTaskScheduledEventAttributes activityTaskScheduledEventAttributes

If the event is of type ActivityTaskScheduled then this member is set and provides detailed information about the event. It is not set for other event types.

activityTaskStartedEventAttributes

ActivityTaskStartedEventAttributes activityTaskStartedEventAttributes

If the event is of type ActivityTaskStarted then this member is set and provides detailed information about the event. It is not set for other event types.

activityTaskCompletedEventAttributes

ActivityTaskCompletedEventAttributes activityTaskCompletedEventAttributes

If the event is of type ActivityTaskCompleted then this member is set and provides detailed information about the event. It is not set for other event types.

activityTaskFailedEventAttributes

ActivityTaskFailedEventAttributes activityTaskFailedEventAttributes

If the event is of type ActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.

activityTaskTimedOutEventAttributes

ActivityTaskTimedOutEventAttributes activityTaskTimedOutEventAttributes

If the event is of type ActivityTaskTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.

activityTaskCanceledEventAttributes

ActivityTaskCanceledEventAttributes activityTaskCanceledEventAttributes

If the event is of type ActivityTaskCanceled then this member is set and provides detailed information about the event. It is not set for other event types.

activityTaskCancelRequestedEventAttributes

ActivityTaskCancelRequestedEventAttributes activityTaskCancelRequestedEventAttributes

If the event is of type ActivityTaskcancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.

workflowExecutionSignaledEventAttributes

WorkflowExecutionSignaledEventAttributes workflowExecutionSignaledEventAttributes

If the event is of type WorkflowExecutionSignaled then this member is set and provides detailed information about the event. It is not set for other event types.

markerRecordedEventAttributes

MarkerRecordedEventAttributes markerRecordedEventAttributes

If the event is of type MarkerRecorded then this member is set and provides detailed information about the event. It is not set for other event types.

recordMarkerFailedEventAttributes

RecordMarkerFailedEventAttributes recordMarkerFailedEventAttributes

If the event is of type DecisionTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.

timerStartedEventAttributes

TimerStartedEventAttributes timerStartedEventAttributes

If the event is of type TimerStarted then this member is set and provides detailed information about the event. It is not set for other event types.

timerFiredEventAttributes

TimerFiredEventAttributes timerFiredEventAttributes

If the event is of type TimerFired then this member is set and provides detailed information about the event. It is not set for other event types.

timerCanceledEventAttributes

TimerCanceledEventAttributes timerCanceledEventAttributes

If the event is of type TimerCanceled then this member is set and provides detailed information about the event. It is not set for other event types.

startChildWorkflowExecutionInitiatedEventAttributes

StartChildWorkflowExecutionInitiatedEventAttributes startChildWorkflowExecutionInitiatedEventAttributes

If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.

childWorkflowExecutionStartedEventAttributes

ChildWorkflowExecutionStartedEventAttributes childWorkflowExecutionStartedEventAttributes

If the event is of type ChildWorkflowExecutionStarted then this member is set and provides detailed information about the event. It is not set for other event types.

childWorkflowExecutionCompletedEventAttributes

ChildWorkflowExecutionCompletedEventAttributes childWorkflowExecutionCompletedEventAttributes

If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides detailed information about the event. It is not set for other event types.

childWorkflowExecutionFailedEventAttributes

ChildWorkflowExecutionFailedEventAttributes childWorkflowExecutionFailedEventAttributes

If the event is of type ChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

childWorkflowExecutionTimedOutEventAttributes

ChildWorkflowExecutionTimedOutEventAttributes childWorkflowExecutionTimedOutEventAttributes

If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.

childWorkflowExecutionCanceledEventAttributes

ChildWorkflowExecutionCanceledEventAttributes childWorkflowExecutionCanceledEventAttributes

If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides detailed information about the event. It is not set for other event types.

childWorkflowExecutionTerminatedEventAttributes

ChildWorkflowExecutionTerminatedEventAttributes childWorkflowExecutionTerminatedEventAttributes

If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides detailed information about the event. It is not set for other event types.

signalExternalWorkflowExecutionInitiatedEventAttributes

SignalExternalWorkflowExecutionInitiatedEventAttributes signalExternalWorkflowExecutionInitiatedEventAttributes

If the event is of type SignalExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.

externalWorkflowExecutionSignaledEventAttributes

ExternalWorkflowExecutionSignaledEventAttributes externalWorkflowExecutionSignaledEventAttributes

If the event is of type ExternalWorkflowExecutionSignaled then this member is set and provides detailed information about the event. It is not set for other event types.

signalExternalWorkflowExecutionFailedEventAttributes

SignalExternalWorkflowExecutionFailedEventAttributes signalExternalWorkflowExecutionFailedEventAttributes

If the event is of type SignalExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

externalWorkflowExecutionCancelRequestedEventAttributes

ExternalWorkflowExecutionCancelRequestedEventAttributes externalWorkflowExecutionCancelRequestedEventAttributes

If the event is of type ExternalWorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.

requestCancelExternalWorkflowExecutionInitiatedEventAttributes

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes requestCancelExternalWorkflowExecutionInitiatedEventAttributes

If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.

requestCancelExternalWorkflowExecutionFailedEventAttributes

RequestCancelExternalWorkflowExecutionFailedEventAttributes requestCancelExternalWorkflowExecutionFailedEventAttributes

If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

scheduleActivityTaskFailedEventAttributes

ScheduleActivityTaskFailedEventAttributes scheduleActivityTaskFailedEventAttributes

If the event is of type ScheduleActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.

requestCancelActivityTaskFailedEventAttributes

RequestCancelActivityTaskFailedEventAttributes requestCancelActivityTaskFailedEventAttributes

If the event is of type RequestCancelActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.

startTimerFailedEventAttributes

StartTimerFailedEventAttributes startTimerFailedEventAttributes

If the event is of type StartTimerFailed then this member is set and provides detailed information about the event. It is not set for other event types.

cancelTimerFailedEventAttributes

CancelTimerFailedEventAttributes cancelTimerFailedEventAttributes

If the event is of type CancelTimerFailed then this member is set and provides detailed information about the event. It is not set for other event types.

startChildWorkflowExecutionFailedEventAttributes

StartChildWorkflowExecutionFailedEventAttributes startChildWorkflowExecutionFailedEventAttributes

If the event is of type StartChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

Class com.amazonaws.services.simpleworkflow.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.simpleworkflow.model.ListActivityTypesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain in which the activity types have been registered.

Constraints:
Length: 1 - 256

name

String name

If specified, only lists the activity types that have this name.

Constraints:
Length: 1 - 256

registrationStatus

String registrationStatus

Specifies the registration status of the activity types to list.

Constraints:
Allowed Values: REGISTERED, DEPRECATED

nextPageToken

String nextPageToken

If on a previous call to this method a NextResultToken was returned, the results have more than one page. To get the next page of results, repeat the call with the nextPageToken and keep all other arguments unchanged.

Constraints:
Length: 0 - 2048

maximumPageSize

Integer maximumPageSize

The maximum number of results returned in each page. The default is 100, but the caller can override this value to a page size smaller than the default. You cannot specify a page size greater than 100. Note that the number of types may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

Constraints:
Range: 0 - 1000

reverseOrder

Boolean reverseOrder

When set to true, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the name of the activity types.

Class com.amazonaws.services.simpleworkflow.model.ListClosedWorkflowExecutionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain that contains the workflow executions to list.

Constraints:
Length: 1 - 256

startTimeFilter

ExecutionTimeFilter startTimeFilter

If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

closeTimeFilter

ExecutionTimeFilter closeTimeFilter

If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

executionFilter

WorkflowExecutionFilter executionFilter

If specified, only workflow executions matching the workflow id specified in the filter are returned. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

closeStatusFilter

CloseStatusFilter closeStatusFilter

If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

typeFilter

WorkflowTypeFilter typeFilter

If specified, only executions of the type specified in the filter are returned. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

tagFilter

TagFilter tagFilter

If specified, only executions that have the matching tag are listed. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

nextPageToken

String nextPageToken

If on a previous call to this method a NextPageToken was returned, the results are being paginated. To get the next page of results, repeat the call with the returned token and all other arguments unchanged.

Constraints:
Length: 0 - 2048

maximumPageSize

Integer maximumPageSize

The maximum number of results returned in each page. The default is 100, but the caller can override this value to a page size smaller than the default. You cannot specify a page size greater than 100. Note that the number of executions may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

Constraints:
Range: 0 - 1000

reverseOrder

Boolean reverseOrder

When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

Class com.amazonaws.services.simpleworkflow.model.ListDomainsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextPageToken

String nextPageToken

If on a previous call to this method a NextPageToken was returned, the result has more than one page. To get the next page of results, repeat the call with the returned token and all other arguments unchanged.

Constraints:
Length: 0 - 2048

registrationStatus

String registrationStatus

Specifies the registration status of the domains to list.

Constraints:
Allowed Values: REGISTERED, DEPRECATED

maximumPageSize

Integer maximumPageSize

The maximum number of results returned in each page. The default is 100, but the caller can override this value to a page size smaller than the default. You cannot specify a page size greater than 100. Note that the number of domains may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

Constraints:
Range: 0 - 1000

reverseOrder

Boolean reverseOrder

When set to true, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the name of the domains.

Class com.amazonaws.services.simpleworkflow.model.ListOpenWorkflowExecutionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain that contains the workflow executions to list.

Constraints:
Length: 1 - 256

startTimeFilter

ExecutionTimeFilter startTimeFilter

Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

typeFilter

WorkflowTypeFilter typeFilter

If specified, only executions of the type specified in the filter are returned. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

tagFilter

TagFilter tagFilter

If specified, only executions that have the matching tag are listed. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

nextPageToken

String nextPageToken

If on a previous call to this method a NextPageToken was returned, the results are being paginated. To get the next page of results, repeat the call with the returned token and all other arguments unchanged.

Constraints:
Length: 0 - 2048

maximumPageSize

Integer maximumPageSize

The maximum number of results returned in each page. The default is 100, but the caller can override this value to a page size smaller than the default. You cannot specify a page size greater than 100. Note that the number of executions may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

Constraints:
Range: 0 - 1000

reverseOrder

Boolean reverseOrder

When set to true, returns the results in reverse order. By default the results are returned in descending order of the start time of the executions.

executionFilter

WorkflowExecutionFilter executionFilter

If specified, only workflow executions matching the workflow id specified in the filter are returned. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Class com.amazonaws.services.simpleworkflow.model.ListWorkflowTypesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain in which the workflow types have been registered.

Constraints:
Length: 1 - 256

name

String name

If specified, lists the workflow type with this name.

Constraints:
Length: 1 - 256

registrationStatus

String registrationStatus

Specifies the registration status of the workflow types to list.

Constraints:
Allowed Values: REGISTERED, DEPRECATED

nextPageToken

String nextPageToken

If on a previous call to this method a NextPageToken was returned, the results are being paginated. To get the next page of results, repeat the call with the returned token and all other arguments unchanged.

Constraints:
Length: 0 - 2048

maximumPageSize

Integer maximumPageSize

The maximum number of results returned in each page. The default is 100, but the caller can override this value to a page size smaller than the default. You cannot specify a page size greater than 100. Note that the number of types may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

Constraints:
Range: 0 - 1000

reverseOrder

Boolean reverseOrder

When set to true, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the name of the workflow types.

Class com.amazonaws.services.simpleworkflow.model.MarkerRecordedEventAttributes extends Object implements Serializable

Serialized Fields

markerName

String markerName

The name of the marker.

Constraints:
Length: 1 - 256

details

String details

Details of the marker (if any).

Constraints:
Length: 0 - 32768

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarker decision that requested this marker. This information can be useful for diagnosing problems by tracing back the cause of events.

Class com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.simpleworkflow.model.PendingTaskCount extends Object implements Serializable

Serialized Fields

count

Integer count

The number of tasks in the task list.

Constraints:
Range: 0 -

truncated

Boolean truncated

If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

Class com.amazonaws.services.simpleworkflow.model.PollForActivityTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain that contains the task lists being polled.

Constraints:
Length: 1 - 256

taskList

TaskList taskList

Specifies the task list to poll for activity tasks.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - ?). Also, it must not contain the literal string "arn".

identity

String identity

Identity of the worker making the request, which is recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

Constraints:
Length: 0 - 256

Class com.amazonaws.services.simpleworkflow.model.PollForDecisionTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain containing the task lists to poll.

Constraints:
Length: 1 - 256

taskList

TaskList taskList

Specifies the task list to poll for decision tasks.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - ?). Also, it must not contain the literal string "arn".

identity

String identity

Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

Constraints:
Length: 0 - 256

nextPageToken

String nextPageToken

If on a previous call to this method a NextPageToken was returned, the results are being paginated. To get the next page of results, repeat the call with the returned token and all other arguments unchanged. The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken will not return a new decision task..

Constraints:
Length: 0 - 2048

maximumPageSize

Integer maximumPageSize

The maximum number of history events returned in each page. The default is 100, but the caller can override this value to a page size smaller than the default. You cannot specify a page size greater than 100. Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

Constraints:
Range: 0 - 1000

reverseOrder

Boolean reverseOrder

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimestamp of the events.

Class com.amazonaws.services.simpleworkflow.model.RecordActivityTaskHeartbeatRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskToken

String taskToken

The taskToken of the ActivityTask. The taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

Constraints:
Length: 1 - 1024

details

String details

If specified, contains details about the progress of the task.

Constraints:
Length: 0 - 2048

Class com.amazonaws.services.simpleworkflow.model.RecordMarkerDecisionAttributes extends Object implements Serializable

Serialized Fields

markerName

String markerName

The name of the marker. This file is required.

Constraints:
Length: 1 - 256

details

String details

Optional details of the marker.

Constraints:
Length: 0 - 32768

Class com.amazonaws.services.simpleworkflow.model.RecordMarkerFailedEventAttributes extends Object implements Serializable

Serialized Fields

markerName

String markerName

The marker's name.

Constraints:
Length: 1 - 256

cause

String cause

The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Constraints:
Allowed Values: OPERATION_NOT_PERMITTED

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarkerFailed decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the cause of events.

Class com.amazonaws.services.simpleworkflow.model.RegisterActivityTypeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain in which this activity is to be registered.

Constraints:
Length: 1 - 256

name

String name

The name of the activity type within the domain.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - ?). Also, it must not contain the literal string "arn".

Constraints:
Length: 1 - 256

version

String version

The version of the activity type. The activity type consists of the name and version, the combination of which must be unique within the domain.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - ?). Also, it must not contain the literal string "arn".

Constraints:
Length: 1 - 64

description

String description

A textual description of the activity type.

Constraints:
Length: 0 - 1024

defaultTaskStartToCloseTimeout

String defaultTaskStartToCloseTimeout

If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

defaultTaskHeartbeatTimeout

String defaultTaskHeartbeatTimeout

If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

defaultTaskList

TaskList defaultTaskList

If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list is not provided when a task is scheduled through the ScheduleActivityTask Decision.

defaultTaskScheduleToStartTimeout

String defaultTaskScheduleToStartTimeout

If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

defaultTaskScheduleToCloseTimeout

String defaultTaskScheduleToCloseTimeout

If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

Class com.amazonaws.services.simpleworkflow.model.RegisterDomainRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

Name of the domain to register. The name must be unique.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - ?). Also, it must not contain the literal string "arn".

Constraints:
Length: 1 - 256

description

String description

Textual description of the domain.

Constraints:
Length: 0 - 1024

workflowExecutionRetentionPeriodInDays

String workflowExecutionRetentionPeriodInDays

Specifies the duration--in days--for which the record (including the history) of workflow executions in this domain should be kept by the service. After the retention period, the workflow execution will not be available in the results of visibility calls. If a duration of NONE is specified, the records for workflow executions in this domain are not retained at all.

Constraints:
Length: 1 - 8

Class com.amazonaws.services.simpleworkflow.model.RegisterWorkflowTypeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain in which to register the workflow type.

Constraints:
Length: 1 - 256

name

String name

The name of the workflow type.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - ?). Also, it must not contain the literal string "arn".

Constraints:
Length: 1 - 256

version

String version

The version of the workflow type. The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - ?). Also, it must not contain the literal string "arn".

Constraints:
Length: 1 - 64

description

String description

Textual description of the workflow type.

Constraints:
Length: 0 - 1024

defaultTaskStartToCloseTimeout

String defaultTaskStartToCloseTimeout

If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

defaultExecutionStartToCloseTimeout

String defaultExecutionStartToCloseTimeout

If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.

The duration is specified in seconds. The valid values are integers greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit will always cause the workflow execution to time out.

Constraints:
Length: 0 - 8

defaultTaskList

TaskList defaultTaskList

If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list is not provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.

defaultChildPolicy

String defaultChildPolicy

If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision. The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

Class com.amazonaws.services.simpleworkflow.model.RequestCancelActivityTaskDecisionAttributes extends Object implements Serializable

Serialized Fields

activityId

String activityId

The activityId of the activity task to be canceled.

Constraints:
Length: 1 - 256

Class com.amazonaws.services.simpleworkflow.model.RequestCancelActivityTaskFailedEventAttributes extends Object implements Serializable

Serialized Fields

activityId

String activityId

The activityId provided in the RequestCancelActivityTask decision that failed.

Constraints:
Length: 1 - 256

cause

String cause

The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Constraints:
Allowed Values: ACTIVITY_ID_UNKNOWN, OPERATION_NOT_PERMITTED

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the cause of events.

Class com.amazonaws.services.simpleworkflow.model.RequestCancelExternalWorkflowExecutionDecisionAttributes extends Object implements Serializable

Serialized Fields

workflowId

String workflowId

The workflowId of the external workflow execution to cancel. This field is required.

Constraints:
Length: 1 - 256

runId

String runId

The runId of the external workflow execution to cancel.

Constraints:
Length: 0 - 64

control

String control

Optional data attached to the event that can be used by the decider in subsequent workflow tasks.

Constraints:
Length: 0 - 32768

Class com.amazonaws.services.simpleworkflow.model.RequestCancelExternalWorkflowExecutionFailedEventAttributes extends Object implements Serializable

Serialized Fields

workflowId

String workflowId

The workflowId of the external workflow to which the cancel request was to be delivered.

Constraints:
Length: 1 - 256

runId

String runId

The runId of the external workflow execution.

Constraints:
Length: 0 - 64

cause

String cause

The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Constraints:
Allowed Values: UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION, REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED

initiatedEventId

Long initiatedEventId

The id of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the cause of events.

control

String control

Class com.amazonaws.services.simpleworkflow.model.RequestCancelExternalWorkflowExecutionInitiatedEventAttributes extends Object implements Serializable

Serialized Fields

workflowId

String workflowId

The workflowId of the external workflow execution to be canceled.

Constraints:
Length: 1 - 256

runId

String runId

The runId of the external workflow execution to be canceled.

Constraints:
Length: 0 - 64

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the cause of events.

control

String control

Optional data attached to the event that can be used by the decider in subsequent workflow tasks.

Constraints:
Length: 0 - 32768

Class com.amazonaws.services.simpleworkflow.model.RequestCancelWorkflowExecutionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain containing the workflow execution to cancel.

Constraints:
Length: 1 - 256

workflowId

String workflowId

The workflowId of the workflow execution to cancel.

Constraints:
Length: 1 - 256

runId

String runId

The runId of the workflow execution to cancel.

Constraints:
Length: 0 - 64

Class com.amazonaws.services.simpleworkflow.model.RespondActivityTaskCanceledRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskToken

String taskToken

The taskToken of the ActivityTask. The taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

Constraints:
Length: 1 - 1024

details

String details

Optional information about the cancellation.

Constraints:
Length: 0 - 32768

Class com.amazonaws.services.simpleworkflow.model.RespondActivityTaskCompletedRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskToken

String taskToken

The taskToken of the ActivityTask. The taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

Constraints:
Length: 1 - 1024

result

String result

The result of the activity task. It is a free form string that is implementation specific.

Constraints:
Length: 0 - 32768

Class com.amazonaws.services.simpleworkflow.model.RespondActivityTaskFailedRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskToken

String taskToken

The taskToken of the ActivityTask. The taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

Constraints:
Length: 1 - 1024

reason

String reason

Description of the error that may assist in diagnostics.

Constraints:
Length: 0 - 256

details

String details

Optional detailed information about the failure.

Constraints:
Length: 0 - 32768

Class com.amazonaws.services.simpleworkflow.model.RespondDecisionTaskCompletedRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskToken

String taskToken

The taskToken from the DecisionTask. The taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

Constraints:
Length: 1 - 1024

decisions

List<E> decisions

The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs for the Decision structure for details.

executionContext

String executionContext

User defined context to add to workflow execution.

Constraints:
Length: 0 - 32768

Class com.amazonaws.services.simpleworkflow.model.Run extends Object implements Serializable

Serialized Fields

runId

String runId

The runId of a workflow execution. This Id is generated by the service and can be used to uniquely identify the workflow execution within a domain.

Constraints:
Length: 1 - 64

Class com.amazonaws.services.simpleworkflow.model.ScheduleActivityTaskDecisionAttributes extends Object implements Serializable

Serialized Fields

activityType

ActivityType activityType

The type of the activity task to schedule. This field is required.

activityId

String activityId

The activityId of the activity task. This field is required.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - ?). Also, it must not contain the literal string "arn".

Constraints:
Length: 1 - 256

control

String control

Optional data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.

Constraints:
Length: 0 - 32768

input

String input

The input provided to the activity task.

Constraints:
Length: 0 - 32768

scheduleToCloseTimeout

String scheduleToCloseTimeout

The maximum duration for this activity task.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration. A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault will be returned.

Constraints:
Length: 0 - 8

taskList

TaskList taskList

If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type will be used. A task list for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default task list was specified at registration time then a fault will be returned.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - ?). Also, it must not contain the literal string "arn".

scheduleToStartTimeout

String scheduleToStartTimeout

If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration. A schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault will be returned.

Constraints:
Length: 0 - 8

startToCloseTimeout

String startToCloseTimeout

If set, specifies the maximum duration a worker may take to process this activity task. This overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration. A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault will be returned.

Constraints:
Length: 0 - 8

heartbeatTimeout

String heartbeatTimeout

If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or returns a result, it will be ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

Class com.amazonaws.services.simpleworkflow.model.ScheduleActivityTaskFailedEventAttributes extends Object implements Serializable

Serialized Fields

activityType

ActivityType activityType

The activity type provided in the ScheduleActivityTask decision that failed.

activityId

String activityId

The activityId provided in the ScheduleActivityTask decision that failed.

Constraints:
Length: 1 - 256

cause

String cause

The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Constraints:
Allowed Values: ACTIVITY_TYPE_DEPRECATED, ACTIVITY_TYPE_DOES_NOT_EXIST, ACTIVITY_ID_ALREADY_IN_USE, OPEN_ACTIVITIES_LIMIT_EXCEEDED, ACTIVITY_CREATION_RATE_EXCEEDED, DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_TASK_LIST_UNDEFINED, DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED, DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED, OPERATION_NOT_PERMITTED

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Class com.amazonaws.services.simpleworkflow.model.SignalExternalWorkflowExecutionDecisionAttributes extends Object implements Serializable

Serialized Fields

workflowId

String workflowId

The workflowId of the workflow execution to be signaled. This field is required.

Constraints:
Length: 1 - 256

runId

String runId

The runId of the workflow execution to be signaled.

Constraints:
Length: 0 - 64

signalName

String signalName

The name of the signal.The target workflow execution will use the signal name and input to process the signal. This field is required.

Constraints:
Length: 1 - 256

input

String input

Optional input to be provided with the signal.The target workflow execution will use the signal name and input to process the signal.

Constraints:
Length: 0 - 32768

control

String control

Optional data attached to the event that can be used by the decider in subsequent decision tasks.

Constraints:
Length: 0 - 32768

Class com.amazonaws.services.simpleworkflow.model.SignalExternalWorkflowExecutionFailedEventAttributes extends Object implements Serializable

Serialized Fields

workflowId

String workflowId

The workflowId of the external workflow execution that the signal was being delivered to.

Constraints:
Length: 1 - 256

runId

String runId

The runId of the external workflow execution that the signal was being delivered to.

Constraints:
Length: 0 - 64

cause

String cause

The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Constraints:
Allowed Values: UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION, SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED

initiatedEventId

Long initiatedEventId

The id of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the cause of events leading up to this event.

control

String control

Class com.amazonaws.services.simpleworkflow.model.SignalExternalWorkflowExecutionInitiatedEventAttributes extends Object implements Serializable

Serialized Fields

workflowId

String workflowId

The workflowId of the external workflow execution.

Constraints:
Length: 1 - 256

runId

String runId

The runId of the external workflow execution to send the signal to.

Constraints:
Length: 0 - 64

signalName

String signalName

The name of the signal.

Constraints:
Length: 1 - 256

input

String input

Input provided to the signal (if any).

Constraints:
Length: 0 - 32768

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the cause of events leading up to this event.

control

String control

Optional data attached to the event that can be used by the decider in subsequent decision tasks.

Constraints:
Length: 0 - 32768

Class com.amazonaws.services.simpleworkflow.model.SignalWorkflowExecutionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain containing the workflow execution to signal.

Constraints:
Length: 1 - 256

workflowId

String workflowId

The workflowId of the workflow execution to signal.

Constraints:
Length: 1 - 256

runId

String runId

The runId of the workflow execution to signal.

Constraints:
Length: 0 - 64

signalName

String signalName

The name of the signal. This name must be meaningful to the target workflow.

Constraints:
Length: 1 - 256

input

String input

Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.

Constraints:
Length: 0 - 32768

Class com.amazonaws.services.simpleworkflow.model.StartChildWorkflowExecutionDecisionAttributes extends Object implements Serializable

Serialized Fields

workflowType

WorkflowType workflowType

The type of the workflow execution to be started. This field is required.

workflowId

String workflowId

The workflowId of the workflow execution. This field is required.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - ?). Also, it must not contain the literal string "arn".

Constraints:
Length: 1 - 256

control

String control

Optional data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the child workflow execution.

Constraints:
Length: 0 - 32768

input

String input

The input to be provided to the workflow execution.

Constraints:
Length: 0 - 32768

executionStartToCloseTimeout

String executionStartToCloseTimeout

The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration. An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned.

Constraints:
Length: 0 - 8

taskList

TaskList taskList

The name of the task list to be used for decision tasks of the child workflow execution. A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - ?). Also, it must not contain the literal string "arn".

taskStartToCloseTimeout

String taskStartToCloseTimeout

Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration. A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.

Constraints:
Length: 0 - 8

childPolicy

String childPolicy

If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType. The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

A child policy for the workflow execution being started must be specified either as a default registered for its workflow type or through this field. If neither this field is set nor a default child policy was specified at registration time then a fault will be returned.

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

tagList

List<E> tagList

The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

Constraints:
Length: 0 - 5

Class com.amazonaws.services.simpleworkflow.model.StartChildWorkflowExecutionFailedEventAttributes extends Object implements Serializable

Serialized Fields

workflowType

WorkflowType workflowType

The workflow type provided in the StartChildWorkflowExecution Decision that failed.

cause

String cause

The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Constraints:
Allowed Values: WORKFLOW_TYPE_DOES_NOT_EXIST, WORKFLOW_TYPE_DEPRECATED, OPEN_CHILDREN_LIMIT_EXCEEDED, OPEN_WORKFLOWS_LIMIT_EXCEEDED, CHILD_CREATION_RATE_EXCEEDED, WORKFLOW_ALREADY_RUNNING, DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_TASK_LIST_UNDEFINED, DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_CHILD_POLICY_UNDEFINED, OPERATION_NOT_PERMITTED

workflowId

String workflowId

The workflowId of the child workflow execution.

Constraints:
Length: 1 - 256

initiatedEventId

Long initiatedEventId

The id of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

control

String control

Class com.amazonaws.services.simpleworkflow.model.StartChildWorkflowExecutionInitiatedEventAttributes extends Object implements Serializable

Serialized Fields

workflowId

String workflowId

The workflowId of the child workflow execution.

Constraints:
Length: 1 - 256

workflowType

WorkflowType workflowType

The type of the child workflow execution.

control

String control

Optional data attached to the event that can be used by the decider in subsequent decision tasks. This data is not sent to the activity.

Constraints:
Length: 0 - 32768

input

String input

The inputs provided to the child workflow execution (if any).

Constraints:
Length: 0 - 32768

executionStartToCloseTimeout

String executionStartToCloseTimeout

The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

taskList

TaskList taskList

The name of the task list used for the decision tasks of the child workflow execution.

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

childPolicy

String childPolicy

The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.

The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

taskStartToCloseTimeout

String taskStartToCloseTimeout

The maximum duration allowed for the decision tasks for this workflow execution.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

tagList

List<E> tagList

The list of tags to associated with the child workflow execution.

Constraints:
Length: 0 - 5

Class com.amazonaws.services.simpleworkflow.model.StartTimerDecisionAttributes extends Object implements Serializable

Serialized Fields

timerId

String timerId

The unique Id of the timer. This field is required.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - ?). Also, it must not contain the literal string "arn".

Constraints:
Length: 1 - 256

control

String control

Optional data attached to the event that can be used by the decider in subsequent workflow tasks.

Constraints:
Length: 0 - 32768

startToFireTimeout

String startToFireTimeout

The duration to wait before firing the timer. This field is required.

The duration is specified in seconds. The valid values are integers greater than or equal to 0.

Constraints:
Length: 1 - 8

Class com.amazonaws.services.simpleworkflow.model.StartTimerFailedEventAttributes extends Object implements Serializable

Serialized Fields

timerId

String timerId

The timerId provided in the StartTimer decision that failed.

Constraints:
Length: 1 - 256

cause

String cause

The cause of the failure to process the decision. This information is generated by the system and can be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Constraints:
Allowed Values: TIMER_ID_ALREADY_IN_USE, OPEN_TIMERS_LIMIT_EXCEEDED, TIMER_CREATION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the cause of events.

Class com.amazonaws.services.simpleworkflow.model.StartWorkflowExecutionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The name of the domain in which the workflow execution is created.

Constraints:
Length: 1 - 256

workflowId

String workflowId

The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - ?). Also, it must not contain the literal string "arn".

Constraints:
Length: 1 - 256

workflowType

WorkflowType workflowType

The type of the workflow to start.

taskList

TaskList taskList

The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type. A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - ?). Also, it must not contain the literal string "arn".

input

String input

The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.

Constraints:
Length: 0 - 32768

executionStartToCloseTimeout

String executionStartToCloseTimeout

The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

The duration is specified in seconds. The valid values are integers greater than or equal to 0. Exceeding this limit will cause the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for this timeout; there is a one-year max limit on the time that a workflow execution can run. An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.

Constraints:
Length: 0 - 8

tagList

List<E> tagList

The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

Constraints:
Length: 0 - 5

taskStartToCloseTimeout

String taskStartToCloseTimeout

Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration. A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.

Constraints:
Length: 0 - 8

childPolicy

String childPolicy

If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType. The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned.

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

Class com.amazonaws.services.simpleworkflow.model.TagFilter extends Object implements Serializable

Serialized Fields

tag

String tag

Specifies the tag that must be associated with the execution for it to meet the filter criteria. This field is required.

Constraints:
Length: 1 - 256

Class com.amazonaws.services.simpleworkflow.model.TaskList extends Object implements Serializable

Serialized Fields

name

String name

The name of the task list.

Constraints:
Length: 1 - 256

Class com.amazonaws.services.simpleworkflow.model.TerminateWorkflowExecutionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

String domain

The domain of the workflow execution to terminate.

Constraints:
Length: 1 - 256

workflowId

String workflowId

The workflowId of the workflow execution to terminate.

Constraints:
Length: 1 - 256

runId

String runId

The runId of the workflow execution to terminate.

Constraints:
Length: 0 - 64

reason

String reason

An optional descriptive reason for terminating the workflow execution.

Constraints:
Length: 0 - 256

details

String details

Optional details for terminating the workflow execution.

Constraints:
Length: 0 - 32768

childPolicy

String childPolicy

If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution. The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time, a fault will be returned.

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

Class com.amazonaws.services.simpleworkflow.model.TimerCanceledEventAttributes extends Object implements Serializable

Serialized Fields

timerId

String timerId

The unique Id of the timer that was canceled.

Constraints:
Length: 1 - 256

startedEventId

Long startedEventId

The id of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the cause of events.

Class com.amazonaws.services.simpleworkflow.model.TimerFiredEventAttributes extends Object implements Serializable

Serialized Fields

timerId

String timerId

The unique Id of the timer that fired.

Constraints:
Length: 1 - 256

startedEventId

Long startedEventId

The id of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Class com.amazonaws.services.simpleworkflow.model.TimerStartedEventAttributes extends Object implements Serializable

Serialized Fields

timerId

String timerId

The unique Id of the timer that was started.

Constraints:
Length: 1 - 256

control

String control

Optional data attached to the event that can be used by the decider in subsequent workflow tasks.

Constraints:
Length: 0 - 32768

startToFireTimeout

String startToFireTimeout

The duration of time after which the timer will fire.

The duration is specified in seconds. The valid values are integers greater than or equal to 0.

Constraints:
Length: 1 - 8

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the cause of events.

Class com.amazonaws.services.simpleworkflow.model.TypeAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.simpleworkflow.model.TypeDeprecatedException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.simpleworkflow.model.UnknownResourceException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.simpleworkflow.model.WorkflowExecution extends Object implements Serializable

Serialized Fields

workflowId

String workflowId

The user defined identifier associated with the workflow execution.

Constraints:
Length: 1 - 256

runId

String runId

A system generated unique identifier for the workflow execution.

Constraints:
Length: 1 - 64

Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionAlreadyStartedException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionCanceledEventAttributes extends Object implements Serializable

Serialized Fields

details

String details

Details for the cancellation (if any).

Constraints:
Length: 0 - 32768

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the cause of events.

Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionCancelRequestedEventAttributes extends Object implements Serializable

Serialized Fields

externalWorkflowExecution

WorkflowExecution externalWorkflowExecution

The external workflow execution for which the cancellation was requested.

externalInitiatedEventId

Long externalInitiatedEventId

The id of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this workflow execution.The source event with this Id can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

cause

String cause

If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause. This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.

Constraints:
Allowed Values: CHILD_POLICY_APPLIED

Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionCompletedEventAttributes extends Object implements Serializable

Serialized Fields

result

String result

The result produced by the workflow execution upon successful completion.

Constraints:
Length: 0 - 32768

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the cause of events.

Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionConfiguration extends Object implements Serializable

Serialized Fields

taskStartToCloseTimeout

String taskStartToCloseTimeout

The maximum duration allowed for decision tasks for this workflow execution.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 1 - 8

executionStartToCloseTimeout

String executionStartToCloseTimeout

The total duration for this workflow execution.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 1 - 8

taskList

TaskList taskList

The task list used for the decision tasks generated for this workflow execution.

childPolicy

String childPolicy

The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionContinuedAsNewEventAttributes extends Object implements Serializable

Serialized Fields

input

String input

The input provided to the new workflow execution.

Constraints:
Length: 0 - 32768

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the cause of events.

newExecutionRunId

String newExecutionRunId

The runId of the new workflow execution.

Constraints:
Length: 1 - 64

executionStartToCloseTimeout

String executionStartToCloseTimeout

The total duration allowed for the new workflow execution.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

taskList

TaskList taskList

Represents a task list.

taskStartToCloseTimeout

String taskStartToCloseTimeout

The maximum duration of decision tasks for the new workflow execution.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

childPolicy

String childPolicy

The policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

tagList

List<E> tagList

The list of tags associated with the new workflow execution.

Constraints:
Length: 0 - 5

workflowType

WorkflowType workflowType

Represents a workflow type.

Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionCount extends Object implements Serializable

Serialized Fields

count

Integer count

The number of workflow executions.

Constraints:
Range: 0 -

truncated

Boolean truncated

If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionDetail extends Object implements Serializable

Serialized Fields

executionInfo

WorkflowExecutionInfo executionInfo

Information about the workflow execution.

executionConfiguration

WorkflowExecutionConfiguration executionConfiguration

The configuration settings for this workflow execution including timeout values, tasklist etc.

openCounts

WorkflowExecutionOpenCounts openCounts

The number of tasks for this workflow execution. This includes open and closed tasks of all types.

latestActivityTaskTimestamp

Date latestActivityTaskTimestamp

The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the workflow has not made progress for an unusually long period of time and might require a corrective action.

latestExecutionContext

String latestExecutionContext

The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext, which is a free form string, when closing a decision task using RespondDecisionTaskCompleted.

Constraints:
Length: 0 - 32768

Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionFailedEventAttributes extends Object implements Serializable

Serialized Fields

reason

String reason

The descriptive reason provided for the failure (if any).

Constraints:
Length: 0 - 256

details

String details

The details of the failure (if any).

Constraints:
Length: 0 - 32768

decisionTaskCompletedEventId

Long decisionTaskCompletedEventId

The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the cause of events.

Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionFilter extends Object implements Serializable

Serialized Fields

workflowId

String workflowId

The workflowId to pass of match the criteria of this filter.

Constraints:
Length: 1 - 256

Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionInfo extends Object implements Serializable

Serialized Fields

execution

WorkflowExecution execution

The workflow execution this information is about.

workflowType

WorkflowType workflowType

The type of the workflow execution.

startTimestamp

Date startTimestamp

The time when the execution was started.

closeTimestamp

Date closeTimestamp

The time when the workflow execution was closed. Set only if the execution status is CLOSED.

executionStatus

String executionStatus

The current status of the execution.

Constraints:
Allowed Values: OPEN, CLOSED

closeStatus

String closeStatus

If the execution status is closed then this specifies how the execution was closed:

• COMPLETED: the execution was successfully completed.
• CANCELED: the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.
• TERMINATED: the execution was force terminated.
• FAILED: the execution failed to complete.
• TIMED_OUT: the execution did not complete in the alloted time and was automatically timed out.
• CONTINUED_AS_NEW: the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.

Constraints:
Allowed Values: COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT

parent

WorkflowExecution parent

If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

tagList

List<E> tagList

The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.

Constraints:
Length: 0 - 5

cancelRequested

Boolean cancelRequested

Set to true if a cancellation is requested for this workflow execution.

Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionInfos extends Object implements Serializable

Serialized Fields

executionInfos

List<E> executionInfos

The list of workflow information structures.

nextPageToken

String nextPageToken

The token of the next page in the result. If set, the results have more than one page. The next page can be retrieved by repeating the request with this token and all other arguments unchanged.

Constraints:
Length: 0 - 2048

Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionOpenCounts extends Object implements Serializable

Serialized Fields

openActivityTasks

Integer openActivityTasks

The count of activity tasks whose status is OPEN.

Constraints:
Range: 0 -

openDecisionTasks

Integer openDecisionTasks

The count of decision tasks whose status is OPEN. A workflow execution can have at most one open decision task.

Constraints:
Range: 0 - 1

openTimers

Integer openTimers

The count of timers started by this workflow execution that have not fired yet.

Constraints:
Range: 0 -

openChildWorkflowExecutions

Integer openChildWorkflowExecutions

The count of child workflow executions whose status is OPEN.

Constraints:
Range: 0 -

Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionSignaledEventAttributes extends Object implements Serializable

Serialized Fields

signalName

String signalName

The name of the signal received. The decider can use the signal name and inputs to determine how to the process the signal.

Constraints:
Length: 1 - 256

input

String input

Inputs provided with the signal (if any). The decider can use the signal name and inputs to determine how to process the signal.

Constraints:
Length: 0 - 32768

externalWorkflowExecution

WorkflowExecution externalWorkflowExecution

The workflow execution that sent the signal. This is set only of the signal was sent by another workflow execution.

externalInitiatedEventId

Long externalInitiatedEventId

The id of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflow decision to signal this workflow execution.The source event with this Id can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. This field is set only if the signal was initiated by another workflow execution.

Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionStartedEventAttributes extends Object implements Serializable

Serialized Fields

input

String input

The input provided to the workflow execution (if any).

Constraints:
Length: 0 - 32768

executionStartToCloseTimeout

String executionStartToCloseTimeout

The maximum duration for this workflow execution.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

taskStartToCloseTimeout

String taskStartToCloseTimeout

The maximum duration of decision tasks for this workflow type.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

childPolicy

String childPolicy

The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

taskList

TaskList taskList

The name of the task list for scheduling the decision tasks for this workflow execution.

workflowType

WorkflowType workflowType

The workflow type of this execution.

tagList

List<E> tagList

The list of tags associated with this workflow execution. An execution can have up to 5 tags.

Constraints:
Length: 0 - 5

continuedExecutionRunId

String continuedExecutionRunId

If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution.

Constraints:
Length: 0 - 64

parentWorkflowExecution

WorkflowExecution parentWorkflowExecution

The source workflow execution that started this workflow execution. The member is not set if the workflow execution was not started by a workflow.

parentInitiatedEventId

Long parentInitiatedEventId

The id of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this workflow execution. The source event with this Id can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionTerminatedEventAttributes extends Object implements Serializable

Serialized Fields

reason

String reason

The reason provided for the termination (if any).

Constraints:
Length: 0 - 256

details

String details

The details provided for the termination (if any).

Constraints:
Length: 0 - 32768

childPolicy

String childPolicy

The policy used for the child workflow executions of this workflow execution. The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

cause

String cause

If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.

Constraints:
Allowed Values: CHILD_POLICY_APPLIED, EVENT_LIMIT_EXCEEDED, OPERATOR_INITIATED

Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionTimedOutEventAttributes extends Object implements Serializable

Serialized Fields

timeoutType

String timeoutType

The type of timeout that caused this event.

Constraints:
Allowed Values: START_TO_CLOSE

childPolicy

String childPolicy

The policy used for the child workflow executions of this workflow execution. The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

Class com.amazonaws.services.simpleworkflow.model.WorkflowType extends Object implements Serializable

Serialized Fields

name

String name

The name of the workflow type. This field is required. The combination of workflow type name and version must be unique with in a domain.

Constraints:
Length: 1 - 256

version

String version

The version of the workflow type. This field is required. The combination of workflow type name and version must be unique with in a domain.

Constraints:
Length: 1 - 64

Class com.amazonaws.services.simpleworkflow.model.WorkflowTypeConfiguration extends Object implements Serializable

Serialized Fields

defaultTaskStartToCloseTimeout

String defaultTaskStartToCloseTimeout

The optional default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task does not close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

defaultExecutionStartToCloseTimeout

String defaultExecutionStartToCloseTimeout

The optional default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

defaultTaskList

TaskList defaultTaskList

The optional default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

defaultChildPolicy

String defaultChildPolicy

The optional default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision. The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

Class com.amazonaws.services.simpleworkflow.model.WorkflowTypeDetail extends Object implements Serializable

Serialized Fields

typeInfo

WorkflowTypeInfo typeInfo

General information about the workflow type.

The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.

• REGISTERED: The type is registered and available. Workers supporting this type should be running.
• DEPRECATED: The type was deprecated using DeprecateWorkflowType, but is still in use. You should keep workers supporting this type running. You cannot create new workflow executions of this type.

configuration

WorkflowTypeConfiguration configuration

Configuration settings of the workflow type registered through RegisterWorkflowType

Class com.amazonaws.services.simpleworkflow.model.WorkflowTypeFilter extends Object implements Serializable

Serialized Fields

name

String name

Name of the workflow type. This field is required.

Constraints:
Length: 1 - 256

version

String version

Version of the workflow type.

Constraints:
Length: 0 - 64

Class com.amazonaws.services.simpleworkflow.model.WorkflowTypeInfo extends Object implements Serializable

Serialized Fields

workflowType

WorkflowType workflowType

The workflow type this information is about.

status

String status

The current status of the workflow type.

Constraints:
Allowed Values: REGISTERED, DEPRECATED

description

String description

The description of the type registered through RegisterWorkflowType.

Constraints:
Length: 0 - 1024

creationDate

Date creationDate

The date when this type was registered.

deprecationDate

Date deprecationDate

If the type is in deprecated state, then it is set to the date when the type was deprecated.

Class com.amazonaws.services.simpleworkflow.model.WorkflowTypeInfos extends Object implements Serializable

Serialized Fields

typeInfos

List<E> typeInfos

The list of workflow type information.

nextPageToken

String nextPageToken

The token for the next page of type information. If set then the list consists of more than one page. You can retrieve the next page by repeating the request (that returned the structure) with the this token and all other arguments unchanged.

Constraints:
Length: 0 - 2048

Package com.amazonaws.services.sns.model

Class com.amazonaws.services.sns.model.AddPermissionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

topicArn

String topicArn

The ARN of the topic whose access control policy you wish to modify.

label

String label

A unique identifier for the new policy statement.

aWSAccountIds

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.

actionNames

List<E> actionNames

The action you want to allow for the specified principal(s).

Class com.amazonaws.services.sns.model.AuthorizationErrorException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.sns.model.ConfirmSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

topicArn

String topicArn

The ARN of the topic for which you wish to confirm a subscription.

token

String token

Short-lived token sent to an endpoint during the Subscribe action.

authenticateOnUnsubscribe

String authenticateOnUnsubscribe

Indicates that you want to disallow unauthenticated unsubscribes of the subscription. If value of this parameter is "true" and the request has an AWS signature then only the topic owner and the subscription owner will be permitted to unsubscribe the endpoint. The unsubscribe action will require AWS authentication.

Class com.amazonaws.services.sns.model.ConfirmSubscriptionResult extends Object implements Serializable

Serialized Fields

subscriptionArn

String subscriptionArn

The ARN of the created subscription.

Class com.amazonaws.services.sns.model.CreateTopicRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

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, and hyphens, and must be between 1 and 256 characters long.

Class com.amazonaws.services.sns.model.CreateTopicResult extends Object implements Serializable

Serialized Fields

topicArn

String topicArn

The Amazon Resource Name (ARN) assigned to the created topic.

Class com.amazonaws.services.sns.model.DeleteTopicRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

topicArn

String topicArn

The ARN of the topic you want to delete. http://sns.us-east-1.amazonaws.com/ ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic &Action=DeleteTopic &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2010-03-31T12%3A00%3A00.000Z &AWSAccessKeyId=(AWS Access Key ID) &Signature=DjHBa%2BbYCKQAzctOPnLP7MbHnrHT3%2FK3kFEZjwcf9%2FU%3D fba800b9-3765-11df-8cf3-c58c53254dfb

Class com.amazonaws.services.sns.model.GetSubscriptionAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

subscriptionArn

String subscriptionArn

The ARN of the subscription whose properties you want to get.

Class com.amazonaws.services.sns.model.GetSubscriptionAttributesResult extends Object implements Serializable

Serialized Fields

attributes

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 which 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 which takes into the topic delivery policy and account system defaults

Class com.amazonaws.services.sns.model.GetTopicAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

topicArn

String topicArn

The ARN of the topic whose properties you want to get.

Class com.amazonaws.services.sns.model.GetTopicAttributesResult extends Object implements Serializable

Serialized Fields

attributes

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 which takes into account system defaults

Class com.amazonaws.services.sns.model.InternalErrorException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.sns.model.InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.sns.model.ListSubscriptionsByTopicRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

topicArn

String topicArn

The ARN of the topic for which you wish to find subscriptions.

nextToken

String nextToken

Token returned by the previous ListSubscriptionsByTopic request.

Class com.amazonaws.services.sns.model.ListSubscriptionsByTopicResult extends Object implements Serializable

Serialized Fields

subscriptions

List<E> subscriptions

A list of subscriptions.

nextToken

String nextToken

Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve.

Class com.amazonaws.services.sns.model.ListSubscriptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

String nextToken

Token returned by the previous ListSubscriptions request.

Class com.amazonaws.services.sns.model.ListSubscriptionsResult extends Object implements Serializable

Serialized Fields

subscriptions

List<E> subscriptions

A list of subscriptions.

nextToken

String nextToken

Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve.

Class com.amazonaws.services.sns.model.ListTopicsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

String nextToken

Token returned by the previous ListTopics request.

Class com.amazonaws.services.sns.model.ListTopicsResult extends Object implements Serializable

Serialized Fields

topics

List<E> topics

A list of topic ARNs.

nextToken

String nextToken

Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.

Class com.amazonaws.services.sns.model.NotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.sns.model.PublishRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

topicArn

String topicArn

The topic you want to publish to.

message

String message

The message you want to send to the topic.

Constraints: Messages must be UTF-8 encoded strings at most 8 KB in size (8192 bytes, not 8192 characters).

subject

String subject

Optional parameter to be used as the "Subject" line of when the message is delivered to e-mail endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.

Constraints: Subjects must be ASCII text that begins with a letter, number or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.

messageStructure

String messageStructure

Optional parameter. It will have one valid value: "json". If this option, Message is present and set to "json", the value of Message must: be a syntactically valid JSON object. It must contain at least a top level JSON key of "default" with a value that is a string. For any other top level key that matches one of our transport protocols (e.g. "http"), then the corresponding value (if it is a string) will be used for the message published for that protocol

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. Typically, outbound notifications are JSON encoded (meaning, the characters will be reescaped for sending). JSON strings are UTF-8. 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 will be 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).

Class com.amazonaws.services.sns.model.PublishResult extends Object implements Serializable

Serialized Fields

messageId

String messageId

Unique identifier assigned to the published message.

Class com.amazonaws.services.sns.model.RemovePermissionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

topicArn

String topicArn

The ARN of the topic whose access control policy you wish to modify.

label

String label

The unique label of the statement you want to remove.

Class com.amazonaws.services.sns.model.SetSubscriptionAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

subscriptionArn

String subscriptionArn

The ARN of the subscription to modify.

attributeName

String attributeName

The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.

Valid values: DeliveryPolicy

attributeValue

String attributeValue

The new value for the attribute.

Class com.amazonaws.services.sns.model.SetTopicAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

topicArn

String topicArn

The ARN of the topic to modify.

attributeName

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

attributeValue

String attributeValue

The new value for the attribute.

Class com.amazonaws.services.sns.model.SubscribeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

topicArn

String topicArn

The ARN of topic you want to subscribe to.

protocol

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
• sqs -- delivery of JSON-encoded message to an Amazon SQS queue

endpoint

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 e-mail address
• For the email-json protocol, the endpoint is an e-mail address
• For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue

Class com.amazonaws.services.sns.model.SubscribeResult extends Object implements Serializable

Serialized Fields

subscriptionArn

String subscriptionArn

The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).

Class com.amazonaws.services.sns.model.Subscription extends Object implements Serializable

Serialized Fields

subscriptionArn

String subscriptionArn

The subscription's ARN.

owner

String owner

The subscription's owner.

protocol

String protocol

The subscription's protocol.

endpoint

String endpoint

The subscription's endpoint (format depends on the protocol).

topicArn

String topicArn

The ARN of the subscription's topic.

Class com.amazonaws.services.sns.model.SubscriptionLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.sns.model.Topic extends Object implements Serializable

Serialized Fields

topicArn

String topicArn

The topic's ARN.

Class com.amazonaws.services.sns.model.TopicLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.sns.model.UnsubscribeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

subscriptionArn

String subscriptionArn

The ARN of the subscription to be deleted.

Package com.amazonaws.services.sqs.model

Class com.amazonaws.services.sqs.model.AddPermissionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the SQS queue to take action on.

label

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.

aWSAccountIds

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.

actions

List<E> actions

The action the client wants to allow for the specified principal.

Class com.amazonaws.services.sqs.model.BatchEntryIdsNotDistinctException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.sqs.model.BatchRequestTooLongException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.sqs.model.BatchResultErrorEntry extends Object implements Serializable

Serialized Fields

id

String id

The id of an entry in a batch request.

senderFault

Boolean senderFault

Whether the error happened due to the sender's fault.

code

String code

An error code representing why the operation failed on this entry.

message

String message

A message explaining why the operation failed on this entry.

Class com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the SQS queue to take action on.

entries

List<E> entries

A list of receipt handles of the messages for which the visibility timeout must be changed.

Class com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchRequestEntry extends Object implements Serializable

Serialized Fields

id

String id

An identifier for this particular receipt handle. This is used to communicate the result. Note that the Ids of a batch request need to be unique within the request.

receiptHandle

String receiptHandle

A receipt handle.

visibilityTimeout

Integer visibilityTimeout

The new value (in seconds) for the message's visibility timeout.

Class com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchResult extends Object implements Serializable

Serialized Fields

successful

List<E> successful

A list of ChangeMessageVisibilityBatchResultEntrys.

failed

List<E> failed

A list of BatchResultErrorEntrys.

Class com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchResultEntry extends Object implements Serializable

Serialized Fields

id

String id

Represents a message whose visibility timeout has been changed successfully.

Class com.amazonaws.services.sqs.model.ChangeMessageVisibilityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the SQS queue to take action on.

receiptHandle

String receiptHandle

The receipt handle associated with the message whose visibility timeout should be changed.

visibilityTimeout

Integer visibilityTimeout

The new value (in seconds) for the message's visibility timeout.

Class com.amazonaws.services.sqs.model.CreateQueueRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueName

String queueName

The name for the queue to be created.

attributes

Map<K,V> attributes

A map of attributes with their corresponding values.

Class com.amazonaws.services.sqs.model.CreateQueueResult extends Object implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL for the created SQS queue.

Class com.amazonaws.services.sqs.model.DeleteMessageBatchRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the SQS queue to take action on.

entries

List<E> entries

A list of receipt handles for the messages to be deleted.

Class com.amazonaws.services.sqs.model.DeleteMessageBatchRequestEntry extends Object implements Serializable

Serialized Fields

id

String id

An identifier for this particular receipt handle. This is used to communicate the result. Note that the Ids of a batch request need to be unique within the request.

receiptHandle

String receiptHandle

A receipt handle.

Class com.amazonaws.services.sqs.model.DeleteMessageBatchResult extends Object implements Serializable

Serialized Fields

successful

List<E> successful

A list of DeleteMessageBatchResultEntrys.

failed

List<E> failed

A list of BatchResultErrorEntrys.

Class com.amazonaws.services.sqs.model.DeleteMessageBatchResultEntry extends Object implements Serializable

Serialized Fields

id

String id

Represents a successfully deleted message.

Class com.amazonaws.services.sqs.model.DeleteMessageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the SQS queue to take action on.

receiptHandle

String receiptHandle

The receipt handle associated with the message to delete.

Class com.amazonaws.services.sqs.model.DeleteQueueRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the SQS queue to take action on.

Class com.amazonaws.services.sqs.model.EmptyBatchRequestException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.sqs.model.GetQueueAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the SQS queue to take action on.

attributeNames

List<E> attributeNames

A list of attributes to retrieve information for.

Class com.amazonaws.services.sqs.model.GetQueueAttributesResult extends Object implements Serializable

Serialized Fields

attributes

Map<K,V> attributes

A map of attributes to the respective values.

Class com.amazonaws.services.sqs.model.GetQueueUrlRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueName

String queueName

The name of the queue whose URL must be fetched.

queueOwnerAWSAccountId

String queueOwnerAWSAccountId

The AWS account number of the queue's owner.

Class com.amazonaws.services.sqs.model.GetQueueUrlResult extends Object implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL for the queue.

Class com.amazonaws.services.sqs.model.InvalidAttributeNameException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.sqs.model.InvalidBatchEntryIdException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.sqs.model.InvalidIdFormatException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.sqs.model.InvalidMessageContentsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.sqs.model.ListQueuesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueNamePrefix

String queueNamePrefix

A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

Class com.amazonaws.services.sqs.model.ListQueuesResult extends Object implements Serializable

Serialized Fields

queueUrls

List<E> queueUrls

A list of queue URLs, up to 1000 entries.

Class com.amazonaws.services.sqs.model.Message extends Object implements Serializable

Serialized Fields

messageId

String messageId

receiptHandle

String receiptHandle

mD5OfBody

String mD5OfBody

body

String body

attributes

Map<K,V> attributes

Class com.amazonaws.services.sqs.model.MessageNotInflightException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.sqs.model.OverLimitException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.sqs.model.QueueDeletedRecentlyException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.sqs.model.QueueDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.sqs.model.QueueNameExistsException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.sqs.model.ReceiptHandleIsInvalidException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.sqs.model.ReceiveMessageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the SQS queue to take action on.

attributeNames

List<E> attributeNames

A list of attributes that need to be returned along with each message. The set of valid attributes are [SenderId, ApproximateFirstReceiveTimestamp, ApproximateReceiveCount, SentTimestamp].

maxNumberOfMessages

Integer maxNumberOfMessages

The maximum number of messages to return. Amazon SQS never returns more messages than this value but may return fewer.

All of the messages are not necessarily returned.

visibilityTimeout

Integer visibilityTimeout

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

waitTimeSeconds

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.

Class com.amazonaws.services.sqs.model.ReceiveMessageResult extends Object implements Serializable

Serialized Fields

messages

List<E> messages

A list of messages.

Class com.amazonaws.services.sqs.model.RemovePermissionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the SQS queue to take action on.

label

String label

The identification of the permission to remove. This is the label added with the AddPermission operation.

Class com.amazonaws.services.sqs.model.SendMessageBatchRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the SQS queue to take action on.

entries

List<E> entries

A list of SendMessageBatchRequestEntrys.

Class com.amazonaws.services.sqs.model.SendMessageBatchRequestEntry extends Object implements Serializable

Serialized Fields

id

String id

An identifier for the message in this batch. This is used to communicate the result. Note that the the Ids of a batch request need to be unique within the request.

messageBody

String messageBody

Body of the message.

delaySeconds

Integer delaySeconds

The number of seconds for which the message has to be delayed.

Class com.amazonaws.services.sqs.model.SendMessageBatchResult extends Object implements Serializable

Serialized Fields

successful

List<E> successful

A list of SendMessageBatchResultEntrys.

failed

List<E> failed

A list of BatchResultErrorEntrys with the error detail about each message that could not be enqueued.

Class com.amazonaws.services.sqs.model.SendMessageBatchResultEntry extends Object implements Serializable

Serialized Fields

id

String id

An identifier for the message in this batch.

messageId

String messageId

An identifier for the message.

mD5OfMessageBody

String mD5OfMessageBody

An MD5 digest of the non-URL-encoded message body string. This can be used to verify that SQS received the message correctly. SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://faqs.org/rfcs/rfc1321.html.

Class com.amazonaws.services.sqs.model.SendMessageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the SQS queue to take action on.

messageBody

String messageBody

The message to send.

delaySeconds

Integer delaySeconds

The number of seconds the message has to be delayed.

Class com.amazonaws.services.sqs.model.SendMessageResult extends Object implements Serializable

Serialized Fields

mD5OfMessageBody

String mD5OfMessageBody

An MD5 digest of the non-URL-encoded message body string. This can be used to verify that SQS received the message correctly. SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://faqs.org/rfcs/rfc1321.html.

messageId

String messageId

The message ID of the message added to the queue.

Class com.amazonaws.services.sqs.model.SetQueueAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the SQS queue to take action on.

attributes

Map<K,V> attributes

A map of attributes to set.

Class com.amazonaws.services.sqs.model.TooManyEntriesInBatchRequestException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Package com.amazonaws.services.storagegateway.model

Class com.amazonaws.services.storagegateway.model.ActivateGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

activationKey

String activationKey

Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.

Constraints:
Length: 1 - 50

gatewayName

String gatewayName

A unique identifier for your gateway. This name becomes part of the gateway Amazon Resources Name (ARN) which is what you use as an input to other operations.

Constraints:
Length: 2 - 255
Pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$

gatewayTimezone

String gatewayTimezone

One of the values that indicates the time zone you want to set for the gateway. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

Constraints:
Allowed Values: GMT-12:00, GMT-11:00, GMT-10:00, GMT-9:00, GMT-8:00, GMT-7:00, GMT-6:00, GMT-5:00, GMT-4:00, GMT-3:30, GMT-3:00, GMT-2:00, GMT-1:00, GMT, GMT+1:00, GMT+2:00, GMT+3:00, GMT+3:30, GMT+4:00, GMT+4:30, GMT+5:00, GMT+5:30, GMT+5:45, GMT+6:00, GMT+7:00, GMT+8:00, GMT+9:00, GMT+9:30, GMT+10:00, GMT+11:00, GMT+12:00

gatewayRegion

String gatewayRegion

One of the values that indicates the region where you want to store the snapshot backups. The gateway region specified must be the same region as the region in your Host header in the request. For more information about available regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the Amazon Web Services Glossary.

Valid Values: "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "ap-northeast-1", "ap-southest-1", "sa-east-1"

Constraints:
Length: 1 - 25

gatewayType

String gatewayType

One of the values that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is STORED.

Constraints:
Allowed Values: STORED, CACHED

Class com.amazonaws.services.storagegateway.model.ActivateGatewayResult extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.AddCacheRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

diskIds

List<E> diskIds

An array of strings that identify disks that are to be configured as cache. Each string in the array must be minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

Class com.amazonaws.services.storagegateway.model.AddCacheResult extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.AddUploadBufferRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

diskIds

List<E> diskIds

An array of strings that identify disks that are to be configured as upload buffer. Each string in the array must be minimum length of 1 and maximum length of 300. You can get disk IDs from the ListLocalDisks API.

Class com.amazonaws.services.storagegateway.model.AddUploadBufferResult extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.AddWorkingStorageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

diskIds

List<E> diskIds

An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

Class com.amazonaws.services.storagegateway.model.AddWorkingStorageResult extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.CachediSCSIVolume extends Object implements Serializable

Serialized Fields

volumeARN

String volumeARN

The Amazon Resource Name (ARN) of the storage volume.

Constraints:
Length: 50 - 500

volumeId

String volumeId

The unique identifier of the storage volume, e.g. vol-1122AABB.

Constraints:
Length: 12 - 30

volumeType

String volumeType

A value describing the type of volume.

Constraints:
Allowed Values: STORED iSCSI, CACHED iSCSI

volumeStatus

String volumeStatus

A value that indicates the state of the volume.

Constraints:
Allowed Values: CREATING, AVAILABLE, RESTORING, BOOTSTRAPPING, IRRECOVERABLE, PASS THROUGH, RESTORE AND PASS THROUGH, DELETED, WORKING STORAGE NOT CONFIGURED, UPLOAD BUFFER NOT CONFIGURED

volumeSizeInBytes

Long volumeSizeInBytes

The size of the volume in bytes that was specified in the API_CreateCachediSCSIVolume operation.

volumeProgress

Double volumeProgress

The percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.

sourceSnapshotId

String sourceSnapshotId

If the cached volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-1122aabb. Otherwise, this field is not included.

Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z

volumeiSCSIAttributes

VolumeiSCSIAttributes volumeiSCSIAttributes

Lists iSCSI information about a volume.

Class com.amazonaws.services.storagegateway.model.ChapInfo extends Object implements Serializable

Serialized Fields

targetARN

String targetARN

The Amazon Resource Name (ARN) of the volume.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Constraints:
Length: 50 - 800

secretToAuthenticateInitiator

String secretToAuthenticateInitiator

The secret key that the initiator (e.g. Windows client) must provide to participate in mutual CHAP with the target.

Constraints:
Length: 12 - 16

initiatorName

String initiatorName

The iSCSI initiator that connects to the target.

Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+

secretToAuthenticateTarget

String secretToAuthenticateTarget

The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).

Constraints:
Length: 12 - 16

Class com.amazonaws.services.storagegateway.model.CreateCachediSCSIVolumeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

volumeSizeInBytes

Long volumeSizeInBytes

The size of the cached volume.

snapshotId

String snapshotId

The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI cached volume from a snapshot; otherwise, do not include this field. To list snapshots for your account, use DescribeSnapshots in Amazon Elastic Compute Cloud API Reference.

Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z

targetName

String targetName

The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.

Constraints:
Length: 1 - 200
Pattern: ^[-\.;a-z0-9]+$

networkInterfaceId

String networkInterfaceId

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use the DescribeGatewayInformation operation to get a list of the network interfaces available on the gateway.

Constraints:
Pattern: \A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z

clientToken

String clientToken

A unique identifying string for the cached volume.

Constraints:
Length: 5 - 100

Class com.amazonaws.services.storagegateway.model.CreateCachediSCSIVolumeResult extends Object implements Serializable

Serialized Fields

volumeARN

String volumeARN

The ARN of the configured volume.

Constraints:
Length: 50 - 500

targetARN

String targetARN

The ARN of the volume target that includes the iSCSI name that initiators can use to connect to the target.

Constraints:
Length: 50 - 800

Class com.amazonaws.services.storagegateway.model.CreateSnapshotFromVolumeRecoveryPointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeARN

String volumeARN

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Constraints:
Length: 50 - 500

snapshotDescription

String snapshotDescription

A textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.

Length: Minimum length of 1. Maximum length of 255.

Constraints:
Length: 1 - 255

Class com.amazonaws.services.storagegateway.model.CreateSnapshotFromVolumeRecoveryPointResult extends Object implements Serializable

Serialized Fields

snapshotId

String snapshotId

The snapshot ID that is used to refer to the snapshot in future operations such as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots) or creating a volume from a snapshot (CreateStorediSCSIVolume).

Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z

volumeARN

String volumeARN

The ARN of the volume of which the snapshot was taken. Obtain volume ARNs from the ListVolumes operation.

Constraints:
Length: 50 - 500

volumeRecoveryPointTime

String volumeRecoveryPointTime

The time of the recovery point. Data up to this recovery point are included in the snapshot.

Type: String format of a date in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

Class com.amazonaws.services.storagegateway.model.CreateSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeARN

String volumeARN

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Constraints:
Length: 50 - 500

snapshotDescription

String snapshotDescription

Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field

Constraints:
Length: 1 - 255

Class com.amazonaws.services.storagegateway.model.CreateSnapshotResult extends Object implements Serializable

Serialized Fields

volumeARN

String volumeARN

The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.

Constraints:
Length: 50 - 500

snapshotId

String snapshotId

The snapshot ID that is used to refer to the snapshot in future operations such as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots) or creating a volume from a snapshot (CreateStorediSCSIVolume).

Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z

Class com.amazonaws.services.storagegateway.model.CreateStorediSCSIVolumeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

diskId

String diskId

The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.

Constraints:
Length: 1 - 300

snapshotId

String snapshotId

The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z

preserveExistingData

Boolean preserveExistingData

Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume.

Valid Values: true, false

targetName

String targetName

The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.

Constraints:
Length: 1 - 200
Pattern: ^[-\.;a-z0-9]+$

networkInterfaceId

String networkInterfaceId

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

Constraints:
Pattern: \A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z

Class com.amazonaws.services.storagegateway.model.CreateStorediSCSIVolumeResult extends Object implements Serializable

Serialized Fields

volumeARN

String volumeARN

The Amazon Resource Name (ARN) of the configured volume.

Constraints:
Length: 50 - 500

volumeSizeInBytes

Long volumeSizeInBytes

The size of the volume in bytes.

targetARN

String targetARN

he Amazon Resource Name (ARN) of the volume target that includes the iSCSI name that initiators can use to connect to the target.

Constraints:
Length: 50 - 800

Class com.amazonaws.services.storagegateway.model.DeleteBandwidthRateLimitRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

bandwidthType

String bandwidthType

One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete.

Valid Values: Upload, Download, All

Constraints:
Allowed Values: UPLOAD, DOWNLOAD, ALL

Class com.amazonaws.services.storagegateway.model.DeleteBandwidthRateLimitResult extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.DeleteChapCredentialsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

targetARN

String targetARN

The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

Constraints:
Length: 50 - 800

initiatorName

String initiatorName

The iSCSI initiator that connects to the target.

Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+

Class com.amazonaws.services.storagegateway.model.DeleteChapCredentialsResult extends Object implements Serializable

Serialized Fields

targetARN

String targetARN

The Amazon Resource Name (ARN) of the target.

Constraints:
Length: 50 - 800

initiatorName

String initiatorName

The iSCSI initiator that connects to the target.

Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+

Class com.amazonaws.services.storagegateway.model.DeleteGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.DeleteGatewayResult extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.DeleteSnapshotScheduleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeARN

String volumeARN

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.DeleteSnapshotScheduleResult extends Object implements Serializable

Serialized Fields

volumeARN

String volumeARN

The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.DeleteVolumeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeARN

String volumeARN

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.DeleteVolumeResult extends Object implements Serializable

Serialized Fields

volumeARN

String volumeARN

The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.DescribeBandwidthRateLimitRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.DescribeBandwidthRateLimitResult extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

averageUploadRateLimitInBitsPerSec

Long averageUploadRateLimitInBitsPerSec

The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the upload rate limit is not set.

Constraints:
Range: 51200 -

averageDownloadRateLimitInBitsPerSec

Long averageDownloadRateLimitInBitsPerSec

The average download bandwidth rate limit in bits per second. This field does not appear in the response if the download rate limit is not set.

Constraints:
Range: 102400 -

Class com.amazonaws.services.storagegateway.model.DescribeCachediSCSIVolumesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeARNs

List<E> volumeARNs

An array of strings, where each string represents the Amazon Resource Name (ARN) of a cached volume. All of the specified cached volumes must be from the same gateway. Use ListVolumes to get volume ARNs of a gateway.

Class com.amazonaws.services.storagegateway.model.DescribeCachediSCSIVolumesResult extends Object implements Serializable

Serialized Fields

cachediSCSIVolumes

List<E> cachediSCSIVolumes

An array of CachediSCSIVolume objects where each object contains metadata about one cached volume.

Class com.amazonaws.services.storagegateway.model.DescribeCacheRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.DescribeCacheResult extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

In response, AWS Storage Gateway returns the ARN of the activated gateway. If you don't remember the ARN of a gateway, you can use the List Gateways operations to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

diskIds

List<E> diskIds

An array of the gateway's local disk IDs that are configured as cache. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as cache, then the DiskIds array is empty.

cacheAllocatedInBytes

Long cacheAllocatedInBytes

The size allocated, in bytes, for the cache. If no cache is defined for the gateway, this field returns 0.

cacheUsedPercentage

Double cacheUsedPercentage

The percentage (0 to 100) of the cache storage in use. If no cached is defined for the gateway, this field returns 0.

cacheDirtyPercentage

Double cacheDirtyPercentage

The percentage of the cache that contains data that has not yet been persisted to Amazon S3. If no cached is defined for the gateway, this field returns 0.

cacheHitPercentage

Double cacheHitPercentage

The percentage (0 to 100) of data read from the storage volume that was read from cache. If no cached is defined for the gateway, this field returns 0.

cacheMissPercentage

Double cacheMissPercentage

TThe percentage (0 to 100) of data read from the storage volume that was not read from the cache, but was read from Amazon S3. If no cached is defined for the gateway, this field returns 0.

Class com.amazonaws.services.storagegateway.model.DescribeChapCredentialsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

targetARN

String targetARN

The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

Constraints:
Length: 50 - 800

Class com.amazonaws.services.storagegateway.model.DescribeChapCredentialsResult extends Object implements Serializable

Serialized Fields

chapCredentials

List<E> chapCredentials

An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:

• InitiatorName: The iSCSI initiator that connects to the target.

• SecretToAuthenticateInitiator: The secret key that the initiator (e.g. Windows client) must provide to participate in mutual CHAP with the target.

• SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).

• TargetARN: The Amazon Resource Name (ARN) of the storage volume.

Class com.amazonaws.services.storagegateway.model.DescribeGatewayInformationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.DescribeGatewayInformationResult extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

gatewayId

String gatewayId

The gateway ID.

Constraints:
Length: 12 - 30

gatewayTimezone

String gatewayTimezone

One of the GatewayTimezone values that indicates the time zone configured for the gateway.

Constraints:
Allowed Values: GMT-12:00, GMT-11:00, GMT-10:00, GMT-9:00, GMT-8:00, GMT-7:00, GMT-6:00, GMT-5:00, GMT-4:00, GMT-3:30, GMT-3:00, GMT-2:00, GMT-1:00, GMT, GMT+1:00, GMT+2:00, GMT+3:00, GMT+3:30, GMT+4:00, GMT+4:30, GMT+5:00, GMT+5:30, GMT+5:45, GMT+6:00, GMT+7:00, GMT+8:00, GMT+9:00, GMT+9:30, GMT+10:00, GMT+11:00, GMT+12:00

gatewayState

String gatewayState

One of the GatewayState values that indicates the operating state of the gateway.

Constraints:
Allowed Values: RUNNING, SHUTDOWN

gatewayNetworkInterfaces

List<E> gatewayNetworkInterfaces

A NetworkInterface array that contains descriptions of the gateway network interfaces.

gatewayType

String gatewayType

TBD

Constraints:
Allowed Values: STORED, CACHED

nextUpdateAvailabilityDate

String nextUpdateAvailabilityDate

The date at which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.

Constraints:
Length: 1 - 25

Class com.amazonaws.services.storagegateway.model.DescribeMaintenanceStartTimeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.DescribeMaintenanceStartTimeResult extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

hourOfDay

Integer hourOfDay

The hour component of the maintenance start time represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

Constraints:
Range: 0 - 23

minuteOfHour

Integer minuteOfHour

The minute component of the maintenance start time represented as mm, where mm is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.

Constraints:
Range: 0 - 59

dayOfWeek

Integer dayOfWeek

An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.

Constraints:
Range: 0 - 6

timezone

String timezone

One of the GatewayTimezone values that indicates the time zone that is set for the gateway. The start time and day of week specified should be in the time zone of the gateway.

Constraints:
Allowed Values: GMT-12:00, GMT-11:00, GMT-10:00, GMT-9:00, GMT-8:00, GMT-7:00, GMT-6:00, GMT-5:00, GMT-4:00, GMT-3:30, GMT-3:00, GMT-2:00, GMT-1:00, GMT, GMT+1:00, GMT+2:00, GMT+3:00, GMT+3:30, GMT+4:00, GMT+4:30, GMT+5:00, GMT+5:30, GMT+5:45, GMT+6:00, GMT+7:00, GMT+8:00, GMT+9:00, GMT+9:30, GMT+10:00, GMT+11:00, GMT+12:00

Class com.amazonaws.services.storagegateway.model.DescribeSnapshotScheduleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeARN

String volumeARN

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.DescribeSnapshotScheduleResult extends Object implements Serializable

Serialized Fields

volumeARN

String volumeARN

The Amazon Resource Name (ARN) of the volume that was specified in the request.

Constraints:
Length: 50 - 500

startAt

Integer startAt

The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

Constraints:
Range: 0 - 23

recurrenceInHours

Integer recurrenceInHours

The number of hours between snapshots.

Constraints:
Range: 1 - 24

description

String description

The snapshot description.

Constraints:
Length: 1 - 255

timezone

String timezone

One of the GatewayTimezone values that indicates the time zone of the gateway.

Constraints:
Allowed Values: GMT-12:00, GMT-11:00, GMT-10:00, GMT-9:00, GMT-8:00, GMT-7:00, GMT-6:00, GMT-5:00, GMT-4:00, GMT-3:30, GMT-3:00, GMT-2:00, GMT-1:00, GMT, GMT+1:00, GMT+2:00, GMT+3:00, GMT+3:30, GMT+4:00, GMT+4:30, GMT+5:00, GMT+5:30, GMT+5:45, GMT+6:00, GMT+7:00, GMT+8:00, GMT+9:00, GMT+9:30, GMT+10:00, GMT+11:00, GMT+12:00

Class com.amazonaws.services.storagegateway.model.DescribeStorediSCSIVolumesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeARNs

List<E> volumeARNs

An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must from the same gateway. Use ListVolumes to get volume ARNs for a gateway.

Class com.amazonaws.services.storagegateway.model.DescribeStorediSCSIVolumesResult extends Object implements Serializable

Serialized Fields

storediSCSIVolumes

List<E> storediSCSIVolumes

Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned:

• ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.

• LunNumber: The logical disk number.

• NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the stored volume as an iSCSI target.

• NetworkInterfacePort: The port used to communicate with iSCSI targets.

• PreservedExistingData: Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.

• SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-1122aabb. Otherwise, this field is not included.

• StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about one stored volume.

• TargetARN: The Amazon Resource Name (ARN) of the volume target.

• VolumeARN: The Amazon Resource Name (ARN) of the stored volume.

• VolumeDiskId: The disk ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

• VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.

• VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

• VolumeProgress: Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.

• VolumeSizeInBytes: The size of the volume in bytes.

• VolumeStatus: One of the VolumeStatus values that indicates the state of the volume.

• VolumeType: One of the enumeration values describing the type of the volume. Currently, on STORED volumes are supported.

Class com.amazonaws.services.storagegateway.model.DescribeUploadBufferRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.DescribeUploadBufferResult extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

In response, AWS Storage Gateway returns the ARN of the activated gateway. If you don't remember the ARN of a gateway, you can use the ListGateways operations to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

diskIds

List<E> diskIds

An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.

uploadBufferUsedInBytes

Long uploadBufferUsedInBytes

The total upload buffer in bytes in use by the gateway. If no upload buffer is configured for the gateway, this field returns 0.

uploadBufferAllocatedInBytes

Long uploadBufferAllocatedInBytes

The total upload buffer in bytes allocated for the gateway. If no upload buffer is configured for the gateway, this field returns 0.

Class com.amazonaws.services.storagegateway.model.DescribeWorkingStorageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.DescribeWorkingStorageResult extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

diskIds

List<E> diskIds

An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.

workingStorageUsedInBytes

Long workingStorageUsedInBytes

The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.

workingStorageAllocatedInBytes

Long workingStorageAllocatedInBytes

The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.

Class com.amazonaws.services.storagegateway.model.Disk extends Object implements Serializable

Serialized Fields

diskId

String diskId

The unique device ID or other distinguishing data that identify the local disk.

Constraints:
Length: 1 - 300

diskPath

String diskPath

The path of the local disk in the gateway virtual machine (VM).

diskNode

String diskNode

The device node of the local disk as assigned by the virtualization environment.

diskSizeInBytes

Long diskSizeInBytes

The local disk size in bytes.

diskAllocationType

String diskAllocationType

One of the DiskAllocationType enumeration values that identifies how the local disk is used.

Constraints:
Allowed Values: AVAILABLE, CACHE STORAGE, STORED iSCSI VOLUME, UPLOAD BUFFER, WORKING STORAGE

diskAllocationResource

String diskAllocationResource

The iSCSI Qualified Name (IQN) that is defined for the disk. This field is not included in the response if the local disk is not defined as an iSCSI target. The format of this field is targetIqn::LUNNumber::region-volumeId.

Class com.amazonaws.services.storagegateway.model.GatewayInfo extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.InternalServerErrorException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

error

StorageGatewayError error

Class com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Serialized Fields

error

StorageGatewayError error

Class com.amazonaws.services.storagegateway.model.ListGatewaysRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

marker

String marker

An opaque string that indicates the position at which to begin the returned list of gateways.

Constraints:
Length: 1 - 1000

limit

Integer limit

Specifies that the list of gateways returned be limited to the specified number of items.

Constraints:
Range: 1 -

Class com.amazonaws.services.storagegateway.model.ListGatewaysResult extends Object implements Serializable

Serialized Fields

gateways

List<E> gateways

An array of GatewayInfo objects.

marker

String marker

Use the marker in your next request to fetch the next set of gateways in the list. If there are no more gateways to list, this field does not appear in the response.

Constraints:
Length: 1 - 1000

Class com.amazonaws.services.storagegateway.model.ListLocalDisksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.ListLocalDisksResult extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

disks

List<E> disks

An array of Disk objects.

Class com.amazonaws.services.storagegateway.model.ListVolumeRecoveryPointsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.ListVolumeRecoveryPointsResult extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the activated gateway whose local disk information is returned.

Constraints:
Length: 50 - 500

volumeRecoveryPointInfos

List<E> volumeRecoveryPointInfos

An array of VolumeRecoveryPointInfo objects, where each object describes a recovery point. If no recovery points are defined for the volume, then VolumeRecoveryPointInfos is an empty array "[]"

Class com.amazonaws.services.storagegateway.model.ListVolumesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

marker

String marker

A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

Constraints:
Length: 1 - 1000

limit

Integer limit

Specifies that the list of volumes returned be limited to the specified number of items.

Constraints:
Range: 1 -

Class com.amazonaws.services.storagegateway.model.ListVolumesResult extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

marker

String marker

Use the marker in your next request to continue pagination of iSCSI volumes. If there are no more volumes to list, this field does not appear in the response body.

Constraints:
Length: 1 - 1000

volumeInfos

List<E> volumeInfos

An array of VolumeInfo objects, where each object describes an iSCSI volume. If no volumes are defined for the gateway, then VolumeInfos is an empty array "[]".

Class com.amazonaws.services.storagegateway.model.NetworkInterface extends Object implements Serializable

Serialized Fields

ipv4Address

String ipv4Address

The Internet Protocol version 4 (IPv4) address of the interface.

macAddress

String macAddress

The Media Access Control (MAC) address of the interface. This is currently unsupported and will not be returned in output.

ipv6Address

String ipv6Address

The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported.

Class com.amazonaws.services.storagegateway.model.ShutdownGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.ShutdownGatewayResult extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.StartGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.StartGatewayResult extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.StorageGatewayError extends Object implements Serializable

Serialized Fields

errorCode

String errorCode

Additional information about the error.

Constraints:
Allowed Values: ActivationKeyExpired, ActivationKeyInvalid, ActivationKeyNotFound, GatewayInternalError, GatewayNotConnected, GatewayNotFound, GatewayProxyNetworkConnectionBusy, AuthenticationFailure, BandwidthThrottleScheduleNotFound, Blocked, CannotExportSnapshot, ChapCredentialNotFound, DiskAlreadyAllocated, DiskDoesNotExist, DiskSizeGreaterThanVolumeMaxSize, DiskSizeLessThanVolumeSize, DiskSizeNotGigAligned, DuplicateCertificateInfo, DuplicateSchedule, EndpointNotFound, IAMNotSupported, InitiatorInvalid, InitiatorNotFound, InternalError, InvalidGateway, InvalidEndpoint, InvalidParameters, InvalidSchedule, LocalStorageLimitExceeded, LunAlreadyAllocated , LunInvalid, MaximumContentLengthExceeded, MaximumVolumeCountExceeded, NetworkConfigurationChanged, NoDisksAvailable, NotImplemented, NotSupported, OperationAborted, OutdatedGateway, ParametersNotImplemented, RegionInvalid, RequestTimeout, ServiceUnavailable, SnapshotDeleted, SnapshotIdInvalid, SnapshotInProgress, SnapshotNotFound, SnapshotScheduleNotFound, StagingAreaFull, StorageFailure, TargetAlreadyExists, TargetInvalid, TargetNotFound, UnauthorizedOperation, VolumeAlreadyExists, VolumeIdInvalid, VolumeInUse, VolumeNotFound, VolumeNotReady

errorDetails

Map<K,V> errorDetails

Human-readable text that provides detail about the error that occured.

Class com.amazonaws.services.storagegateway.model.StorediSCSIVolume extends Object implements Serializable

Serialized Fields

volumeARN

String volumeARN

The Amazon Resource Name (ARN) of the storage volume.

Constraints:
Length: 50 - 500

volumeId

String volumeId

The unique identifier of the volume, e.g. vol-AE4B946D.

Constraints:
Length: 12 - 30

volumeType

String volumeType

One of the VolumeType enumeration values describing the type of the volume.

Constraints:
Allowed Values: STORED iSCSI, CACHED iSCSI

volumeStatus

String volumeStatus

One of the VolumeStatus values that indicates the state of the storage volume.

Constraints:
Allowed Values: CREATING, AVAILABLE, RESTORING, BOOTSTRAPPING, IRRECOVERABLE, PASS THROUGH, RESTORE AND PASS THROUGH, DELETED, WORKING STORAGE NOT CONFIGURED, UPLOAD BUFFER NOT CONFIGURED

volumeSizeInBytes

Long volumeSizeInBytes

The size of the volume in bytes.

volumeProgress

Double volumeProgress

Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.

volumeDiskId

String volumeDiskId

The disk ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

Constraints:
Length: 1 - 300

sourceSnapshotId

String sourceSnapshotId

If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z

preservedExistingData

Boolean preservedExistingData

Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.

Valid Values: true, false

volumeiSCSIAttributes

VolumeiSCSIAttributes volumeiSCSIAttributes

An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

Class com.amazonaws.services.storagegateway.model.UpdateBandwidthRateLimitRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

averageUploadRateLimitInBitsPerSec

Long averageUploadRateLimitInBitsPerSec

The average upload bandwidth rate limit in bits per second.

Constraints:
Range: 51200 -

averageDownloadRateLimitInBitsPerSec

Long averageDownloadRateLimitInBitsPerSec

The average download bandwidth rate limit in bits per second.

Constraints:
Range: 102400 -

Class com.amazonaws.services.storagegateway.model.UpdateBandwidthRateLimitResult extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.UpdateChapCredentialsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

targetARN

String targetARN

The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

Constraints:
Length: 50 - 800

secretToAuthenticateInitiator

String secretToAuthenticateInitiator

The secret key that the initiator (e.g. Windows client) must provide to participate in mutual CHAP with the target.

Constraints:
Length: 12 - 16

initiatorName

String initiatorName

The iSCSI initiator that connects to the target.

Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+

secretToAuthenticateTarget

String secretToAuthenticateTarget

The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).

Constraints:
Length: 12 - 16

Class com.amazonaws.services.storagegateway.model.UpdateChapCredentialsResult extends Object implements Serializable

Serialized Fields

targetARN

String targetARN

The Amazon Resource Name (ARN) of the target. This is the same target specified in the request.

Constraints:
Length: 50 - 800

initiatorName

String initiatorName

The iSCSI initiator that connects to the target. This is the same initiator name specified in the request.

Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+

Class com.amazonaws.services.storagegateway.model.UpdateGatewayInformationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

gatewayName

String gatewayName

A unique identifier for your gateway. This name becomes part of the gateway Amazon Resources Name (ARN) which is what you use as an input to other operations.

Constraints:
Length: 2 - 255
Pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$

gatewayTimezone

String gatewayTimezone

One of the GatewayTimezone values that represents the time zone for your gateway. The time zone is used, for example, when a time stamp is given to a snapshot.

Constraints:
Allowed Values: GMT-12:00, GMT-11:00, GMT-10:00, GMT-9:00, GMT-8:00, GMT-7:00, GMT-6:00, GMT-5:00, GMT-4:00, GMT-3:30, GMT-3:00, GMT-2:00, GMT-1:00, GMT, GMT+1:00, GMT+2:00, GMT+3:00, GMT+3:30, GMT+4:00, GMT+4:30, GMT+5:00, GMT+5:30, GMT+5:45, GMT+6:00, GMT+7:00, GMT+8:00, GMT+9:00, GMT+9:30, GMT+10:00, GMT+11:00, GMT+12:00

Class com.amazonaws.services.storagegateway.model.UpdateGatewayInformationResult extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.UpdateGatewaySoftwareNowRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.UpdateGatewaySoftwareNowResult extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.UpdateMaintenanceStartTimeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

hourOfDay

Integer hourOfDay

The hour component of the maintenance start time represented as hh, where hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway.

Constraints:
Range: 0 - 23

minuteOfHour

Integer minuteOfHour

The minute component of the maintenance start time represented as mm, where mm is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.

Constraints:
Range: 0 - 59

dayOfWeek

Integer dayOfWeek

The maintenance start time day of the week.

Constraints:
Range: 0 - 6

Class com.amazonaws.services.storagegateway.model.UpdateMaintenanceStartTimeResult extends Object implements Serializable

Serialized Fields

gatewayARN

String gatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.UpdateSnapshotScheduleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeARN

String volumeARN

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Constraints:
Length: 50 - 500

startAt

Integer startAt

The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

Constraints:
Range: 0 - 23

recurrenceInHours

Integer recurrenceInHours

Frequency of snapshots. Specify the number of hours between snapshots.

Constraints:
Range: 1 - 24

description

String description

Optional description of the snapshot that overwrites the existing description.

Constraints:
Length: 1 - 255

Class com.amazonaws.services.storagegateway.model.UpdateSnapshotScheduleResult extends Object implements Serializable

Serialized Fields

volumeARN

String volumeARN

The UpdateSnapshotScheduleOutput$VolumeARN of the storage volume whose snapshot schedule was updated. It is the same value you provided in your request.

Constraints:
Length: 50 - 500

Class com.amazonaws.services.storagegateway.model.VolumeInfo extends Object implements Serializable

Serialized Fields

volumeARN

String volumeARN

The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Constraints:
Length: 50 - 500

volumeType

String volumeType

One of the VolumeType values that indicates the configuration of the storage volume, for example as a storage volume.

Constraints:
Allowed Values: STORED iSCSI, CACHED iSCSI

Class com.amazonaws.services.storagegateway.model.VolumeiSCSIAttributes extends Object implements Serializable

Serialized Fields

targetARN

String targetARN

The Amazon Resource Name (ARN) of the volume target.

Constraints:
Length: 50 - 800

networkInterfaceId

String networkInterfaceId

The network interface identifier.

Constraints:
Pattern: \A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z

networkInterfacePort

Integer networkInterfacePort

The port used to communicate with iSCSI targets.

lunNumber

Integer lunNumber

The logical disk number.

Constraints:
Range: 1 -

chapEnabled

Boolean chapEnabled

Indicates whether mutual CHAP is enabled for the iSCSI target.

Class com.amazonaws.services.storagegateway.model.VolumeRecoveryPointInfo extends Object implements Serializable

Serialized Fields

volumeARN

String volumeARN

The Amazon Resource Name (ARN) of the volume associated with the recovery point.

Constraints:
Length: 50 - 500

volumeSizeInBytes

Long volumeSizeInBytes

The size, in bytes, of the volume to which the recovery point is associated.

volumeUsageInBytes

Long volumeUsageInBytes

The size, in bytes, of the volume in use at the time of the recovery point.

volumeRecoveryPointTime

String volumeRecoveryPointTime

The time of the recovery point. The format of the time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

Package com.amazonaws.services.support.model

Class com.amazonaws.services.support.model.AddCommunicationToCaseRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

caseId

String caseId

String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: case-12345678910-2013-c4c1d2bf33c5cf47

communicationBody

String communicationBody

Represents the body of an email communication added to the support case.

Constraints:
Length: 1 - 8000

ccEmailAddresses

List<E> ccEmailAddresses

Represents any email addresses contained in the CC line of an email added to the support case.

Constraints:
Length: 0 - 10

Class com.amazonaws.services.support.model.AddCommunicationToCaseResult extends Object implements Serializable

Serialized Fields

result

Boolean result

Returns true if the AddCommunicationToCase succeeds. Returns an error otherwise.

Class com.amazonaws.services.support.model.CaseCreationLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.support.model.CaseDetails extends Object implements Serializable

Serialized Fields

caseId

String caseId

String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: case-12345678910-2013-c4c1d2bf33c5cf47

displayId

String displayId

Represents the Id value displayed on pages for the case in AWS Support Center. This is a numeric string.

subject

String subject

Represents the subject line for a support case in the AWS Support Center user interface.

status

String status

Represents the status of a case submitted to AWS Support.

serviceCode

String serviceCode

Code for the AWS service returned by the call to DescribeServices.

categoryCode

String categoryCode

Specifies the category of problem for the AWS Support case.

severityCode

String severityCode

Code for the severity level returned by the call to DescribeSeverityLevels.

submittedBy

String submittedBy

Represents the email address of the account that submitted the case to support.

timeCreated

String timeCreated

Time that the case was case created in AWS Support Center.

recentCommunications

RecentCaseCommunications recentCommunications

Returns up to the five most recent communications between you and AWS Support Center. Includes a nextToken to retrieve the next set of communications.

ccEmailAddresses

List<E> ccEmailAddresses

List of email addresses that are copied in any communication about the case.

language

String language

Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are en and ja, respectively. Language parameters must be passed explicitly for operations that take them.

Class com.amazonaws.services.support.model.CaseIdNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.support.model.Category extends Object implements Serializable

Serialized Fields

code

String code

Category code for the support case.

name

String name

Category name for the support case.

Class com.amazonaws.services.support.model.Communication extends Object implements Serializable

Serialized Fields

caseId

String caseId

String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: case-12345678910-2013-c4c1d2bf33c5cf47

body

String body

Contains the text of the the commmunication between the customer and AWS Support.

submittedBy

String submittedBy

Email address of the account that submitted the AWS Support case.

timeCreated

String timeCreated

Time the support case was created.

Class com.amazonaws.services.support.model.CreateCaseRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

subject

String subject

Title of the AWS Support case.

serviceCode

String serviceCode

Code for the AWS service returned by the call to DescribeServices.

Constraints:
Pattern: [0-9a-z\-_]+

severityCode

String severityCode

Code for the severity level returned by the call to DescribeSeverityLevels. The availability of severity levels depends on each customer's support subscription. In other words, your subscription may not necessarily require the urgent level of response time.

categoryCode

String categoryCode

Specifies the category of problem for the AWS Support case.

communicationBody

String communicationBody

Parameter that represents the communication body text when you create an AWS Support case by calling CreateCase.

Constraints:
Length: 1 - 8000

ccEmailAddresses

List<E> ccEmailAddresses

List of email addresses that AWS Support copies on case correspondence.

Constraints:
Length: 0 - 10

language

String language

Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are en and ja, respectively. Language parameters must be passed explicitly for operations that take them.

issueType

String issueType

Field passed as a parameter in a CreateCase call.

Class com.amazonaws.services.support.model.CreateCaseResult extends Object implements Serializable

Serialized Fields

caseId

String caseId

String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: case-12345678910-2013-c4c1d2bf33c5cf47

Class com.amazonaws.services.support.model.DescribeCasesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

caseIdList

List<E> caseIdList

A list of Strings comprising ID numbers for support cases you want returned. The maximum number of cases is 100.

Constraints:
Length: 0 - 100

displayId

String displayId

String that corresponds to the ID value displayed for a case in the AWS Support Center user interface.

afterTime

String afterTime

Start date for a filtered date search on support case communications.

beforeTime

String beforeTime

End date for a filtered date search on support case communications.

includeResolvedCases

Boolean includeResolvedCases

Boolean that indicates whether or not resolved support cases should be listed in the DescribeCases search.

nextToken

String nextToken

Defines a resumption point for pagination.

maxResults

Integer maxResults

Integer that sets the maximum number of results to return before paginating.

Constraints:
Range: 10 - 100

language

String language

Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are en and ja, respectively. Language parameters must be passed explicitly for operations that take them.

Class com.amazonaws.services.support.model.DescribeCasesResult extends Object implements Serializable

Serialized Fields

cases

List<E> cases

Array of CaseDetails objects.

nextToken

String nextToken

Defines a resumption point for pagination.

Class com.amazonaws.services.support.model.DescribeCommunicationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

caseId

String caseId

String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: case-12345678910-2013-c4c1d2bf33c5cf47

beforeTime

String beforeTime

End date for a filtered date search on support case communications.

afterTime

String afterTime

Start date for a filtered date search on support case communications.

nextToken

String nextToken

Defines a resumption point for pagination.

maxResults

Integer maxResults

Integer that sets the maximum number of results to return before paginating.

Constraints:
Range: 10 - 100

Class com.amazonaws.services.support.model.DescribeCommunicationsResult extends Object implements Serializable

Serialized Fields

communications

List<E> communications

Contains a list of Communications objects.

nextToken

String nextToken

Defines a resumption point for pagination.

Class com.amazonaws.services.support.model.DescribeServicesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serviceCodeList

List<E> serviceCodeList

List in JSON format of service codes available for AWS services.

Constraints:
Length: 0 - 100

language

String language

Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are en and ja, respectively. Language parameters must be passed explicitly for operations that take them.

Class com.amazonaws.services.support.model.DescribeServicesResult extends Object implements Serializable

Serialized Fields

services

List<E> services

JSON-formatted list of AWS services.

Class com.amazonaws.services.support.model.DescribeSeverityLevelsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

language

String language

Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are en and ja, respectively. Language parameters must be passed explicitly for operations that take them.

Class com.amazonaws.services.support.model.DescribeSeverityLevelsResult extends Object implements Serializable

Serialized Fields

severityLevels

List<E> severityLevels

List of available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS.

Class com.amazonaws.services.support.model.DescribeTrustedAdvisorCheckRefreshStatusesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

checkIds

List<E> checkIds

List of the CheckId values for the Trusted Advisor checks for which you want to refresh the status. You obtain the CheckId values by calling DescribeTrustedAdvisorChecks.

Class com.amazonaws.services.support.model.DescribeTrustedAdvisorCheckRefreshStatusesResult extends Object implements Serializable

Serialized Fields

statuses

List<E> statuses

List of the statuses of the Trusted Advisor checks you've specified for refresh. Status values are:

• in_progress. The refresh of the check is currently executing.
• successful. The refresh of the check has completed successfully.
• enqueued. The refresh check is queued for execution.
• abandoned. An error has prevented the check from refreshing.

Class com.amazonaws.services.support.model.DescribeTrustedAdvisorCheckResultRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

checkId

String checkId

language

String language

Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are en and ja, respectively. Language parameters must be passed explicitly for operations that take them.

Class com.amazonaws.services.support.model.DescribeTrustedAdvisorCheckResultResult extends Object implements Serializable

Serialized Fields

result

TrustedAdvisorCheckResult result

Returns a TrustedAdvisorCheckResult object.

Class com.amazonaws.services.support.model.DescribeTrustedAdvisorChecksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

language

String language

Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are en and ja, respectively. Language parameters must be passed explicitly for operations that take them.

Class com.amazonaws.services.support.model.DescribeTrustedAdvisorChecksResult extends Object implements Serializable

Serialized Fields

checks

List<E> checks

List of the checks returned by calling DescribeTrustedAdvisorChecks

Class com.amazonaws.services.support.model.DescribeTrustedAdvisorCheckSummariesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

checkIds

List<E> checkIds

Unique identifier for a Trusted Advisor check.

Class com.amazonaws.services.support.model.DescribeTrustedAdvisorCheckSummariesResult extends Object implements Serializable

Serialized Fields

summaries

List<E> summaries

List of TrustedAdvisorCheckSummary objects returned by the DescribeTrustedAdvisorCheckSummaries request.

Class com.amazonaws.services.support.model.InternalServerErrorException extends AmazonServiceException implements Serializable

serialVersionUID: 1L

Class com.amazonaws.services.support.model.RecentCaseCommunications extends Object implements Serializable

Serialized Fields

communications

List<E> communications

List of Commmunication objects.

nextToken

String nextToken

Defines a resumption point for pagination.

Class com.amazonaws.services.support.model.RefreshTrustedAdvisorCheckRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

checkId

String checkId

Class com.amazonaws.services.support.model.RefreshTrustedAdvisorCheckResult extends Object implements Serializable

Serialized Fields

status

TrustedAdvisorCheckRefreshStatus status

Returns the overall status of the RefreshTrustedAdvisorCheck call.

Class com.amazonaws.services.support.model.ResolveCaseRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

caseId

String caseId

String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: case-12345678910-2013-c4c1d2bf33c5cf47

Class com.amazonaws.services.support.model.ResolveCaseResult extends Object implements Serializable

Serialized Fields

initialCaseStatus

String initialCaseStatus

Status of the case when the ResolveCase request was sent.

finalCaseStatus

String finalCaseStatus

Status of the case after the ResolveCase request was processed.

Class com.amazonaws.services.support.model.Service extends Object implements Serializable

Serialized Fields

code

String code

JSON-formatted string that represents a code for an AWS service returned by DescribeServices response. Has a corrsponding name represented by a service.name string.

name

String name

JSON-formatted string that represents the friendly name for an AWS service. Has a corresponding code reprsented by a Service.code string.

categories

List<E> categories

JSON-formatted list of categories that describe the type of support issue a case describes. Categories are strings that represent a category name and a category code. Category names and codes are passed to AWS Support when you call CreateCase.

Class com.amazonaws.services.support.model.SeverityLevel extends Object implements Serializable

Serialized Fields

code

String code

String that represents one of four values: "low," "medium," "high," and "urgent". These values correspond to response times returned to the caller in the string SeverityLevel.name.

name

String name

Name of severity levels that correspond to the severity level codes.

Class com.amazonaws.services.support.model.TrustedAdvisorCategorySpecificSummary extends Object implements Serializable

Serialized Fields

costOptimizing

TrustedAdvisorCostOptimizingSummary costOptimizing

Corresponds to the Cost Optimizing tab on the AWS Support Center Trusted Advisor page. This field is only available to checks in the Cost Optimizing category.

Class com.amazonaws.services.support.model.TrustedAdvisorCheckDescription extends Object implements Serializable

Serialized Fields

id

String id

Unique identifier for a specific Trusted Advisor check description.

name

String name

Display name for the Trusted Advisor check. Corresponds to the display name for the check in the Trusted Advisor user interface.

description

String description

Description of the Trusted Advisor check.

category

String category

Category to which the Trusted Advisor check belongs.

metadata

List<E> metadata

List of metadata returned in TrustedAdvisorResourceDetail objects for a Trusted Advisor check.

Class com.amazonaws.services.support.model.TrustedAdvisorCheckRefreshStatus extends Object implements Serializable

Serialized Fields

checkId

String checkId

String that specifies the checkId value of the Trusted Advisor check.

status

String status

Indicates the status of the Trusted Advisor check for which a refresh has been requested.

millisUntilNextRefreshable

Long millisUntilNextRefreshable

Indicates the time in milliseconds until a call to RefreshTrustedAdvisorCheck can trigger a refresh.

Class com.amazonaws.services.support.model.TrustedAdvisorCheckResult extends Object implements Serializable

Serialized Fields

checkId

String checkId

Unique identifier for a Trusted Advisor check.

timestamp

String timestamp

Time at which Trusted Advisor ran the check.

status

String status

Overall status of the check. Status values are "ok," "warning," "error," or "not_available."

resourcesSummary

TrustedAdvisorResourcesSummary resourcesSummary

JSON-formatted object that lists details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

categorySpecificSummary

TrustedAdvisorCategorySpecificSummary categorySpecificSummary

Reports summaries for each Trusted Advisor category. Only the category cost optimizing is currently supported. The other categories are security, fault tolerance, and performance.

flaggedResources

List<E> flaggedResources

List of AWS resources flagged by the Trusted Advisor check.

Class com.amazonaws.services.support.model.TrustedAdvisorCheckSummary extends Object implements Serializable

Serialized Fields

checkId

String checkId

Unique identifier for a Trusted Advisor check.

timestamp

String timestamp

status

String status

Overall status of the Trusted Advisor check.

hasFlaggedResources

Boolean hasFlaggedResources

Indicates that the Trusted Advisor check returned flagged resources.

resourcesSummary

TrustedAdvisorResourcesSummary resourcesSummary

JSON-formatted object that lists details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

categorySpecificSummary

TrustedAdvisorCategorySpecificSummary categorySpecificSummary

Reports the results of a Trusted Advisor check by category. Only Cost Optimizing is currently supported.

Class com.amazonaws.services.support.model.TrustedAdvisorCostOptimizingSummary extends Object implements Serializable

Serialized Fields

estimatedMonthlySavings

Double estimatedMonthlySavings

Reports the estimated monthly savings determined by the Trusted Advisor check for your account.

estimatedPercentMonthlySavings

Double estimatedPercentMonthlySavings

Reports the estimated percentage of savings determined for your account by the Trusted Advisor check.

Class com.amazonaws.services.support.model.TrustedAdvisorResourceDetail extends Object implements Serializable

Serialized Fields

status

String status

Status code for the resource identified in the Trusted Advisor check.

region

String region

AWS region in which the identified resource is located.

resourceId

String resourceId

Unique identifier for the identified resource.

isSuppressed

Boolean isSuppressed

Indicates whether the specified AWS resource has had its participation in Trusted Advisor checks suppressed.

metadata

List<E> metadata

Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the TrustedAdvisorCheckDescription object returned by the call to DescribeTrustedAdvisorChecks.

Class com.amazonaws.services.support.model.TrustedAdvisorResourcesSummary extends Object implements Serializable

Serialized Fields

resourcesProcessed

Long resourcesProcessed

Reports the number of AWS resources that were analyzed in your Trusted Advisor check.

resourcesFlagged

Long resourcesFlagged

Reports the number of AWS resources that were flagged in your Trusted Advisor check.

resourcesIgnored

Long resourcesIgnored

Indicates the number of resources ignored by Trusted Advisor due to unavailability of information.

resourcesSuppressed

Long resourcesSuppressed

Indicates whether the specified AWS resource has had its participation in Trusted Advisor checks suppressed.