java.lang.String requestId
java.lang.String errorCode
AmazonServiceException.ErrorType errorType
int statusCode
java.lang.String serviceName
java.lang.String activityId
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String description
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String cause
Constraints:
Length: 1 - 1023
Pattern: [ --�𐀀-\r\n\t]*
java.util.Date startTime
java.util.Date endTime
java.lang.String statusCode
Constraints:
Allowed Values: WaitingForSpotInstanceRequestId, WaitingForSpotInstanceId, WaitingForInstanceId, PreInService, InProgress, Successful, Failed, Cancelled
java.lang.String statusMessage
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer progress
java.lang.String details
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupARN
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer minSize
java.lang.Integer maxSize
java.lang.Integer desiredCapacity
java.lang.Integer defaultCooldown
ListWithAutoConstructFlag<T> availabilityZones
Constraints:
Length: 1 -
ListWithAutoConstructFlag<T> loadBalancerNames
java.lang.String healthCheckType
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer healthCheckGracePeriod
ListWithAutoConstructFlag<T> instances
java.util.Date createdTime
ListWithAutoConstructFlag<T> suspendedProcesses
java.lang.String placementGroup
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String vPCZoneIdentifier
When
you specify VPCZoneIdentifier with
AvailabilityZones, ensure that the subnets' Availability
Zones match the values you specify for AvailabilityZones.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> enabledMetrics
java.lang.String status
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> tags
ListWithAutoConstructFlag<T> terminationPolicies
java.lang.String instanceId
Constraints:
Length: 1 - 16
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String availabilityZone
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String lifecycleState
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String healthStatus
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String virtualName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String deviceName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
Ebs ebs
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String launchConfigurationName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer minSize
java.lang.Integer maxSize
java.lang.Integer desiredCapacity
java.lang.Integer defaultCooldown
ListWithAutoConstructFlag<T> availabilityZones
Constraints:
Length: 1 -
ListWithAutoConstructFlag<T> loadBalancerNames
java.lang.String healthCheckType
EC2 or ELB.
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer healthCheckGracePeriod
java.lang.String placementGroup
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String vPCZoneIdentifier
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]*
ListWithAutoConstructFlag<T> terminationPolicies
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.
ListWithAutoConstructFlag<T> tags
java.lang.String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String imageId
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String keyName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> securityGroups
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.java.lang.String userData
Constraints:
Length: 0 - 21847
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String instanceType
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String kernelId
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String ramdiskId
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> blockDeviceMappings
InstanceMonitoring instanceMonitoring
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.
java.lang.String spotPrice
Constraints:
Length: 1 - 255
java.lang.String iamInstanceProfile
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean ebsOptimized
ListWithAutoConstructFlag<T> tags
auto-scaling-group is the only supported resource type.
The valid value for the resource ID is groupname. The
PropagateAtLaunch flag defines whether the new tag will
be applied to instances launched by the Auto Scaling group. Valid
values are true or false. However, instances
that are already running will not get the new or updated tag.
Likewise, when you modify a tag, the updated version will be applied
only to new instances launched by the Auto Scaling group after the
change. Running instances that had the previous version of the tag
will continue to have the older tag.
When you create a tag and a tag of the same name already exists, the operation overwrites the previous tag definition, but you will not get an error message.
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean forceDelete
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String topicARN
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String policyName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String scheduledActionName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> tags
ListWithAutoConstructFlag<T> adjustmentTypes
ListWithAutoConstructFlag<T> autoScalingGroupNames
java.lang.String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer maxRecords
Constraints:
Range: 1 - 50
ListWithAutoConstructFlag<T> autoScalingGroups
java.lang.String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> instanceIds
java.lang.Integer maxRecords
Constraints:
Range: 1 - 50
java.lang.String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> autoScalingInstances
java.lang.String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> autoScalingNotificationTypes
ListWithAutoConstructFlag<T> launchConfigurationNames
java.lang.String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer maxRecords
Constraints:
Range: 1 - 50
ListWithAutoConstructFlag<T> launchConfigurations
java.lang.String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> metrics
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupTotalInstances
ListWithAutoConstructFlag<T> granularities
ListWithAutoConstructFlag<T> autoScalingGroupNames
java.lang.String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer maxRecords
Constraints:
Range: 1 - 50
ListWithAutoConstructFlag<T> notificationConfigurations
java.lang.String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> policyNames
java.lang.String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer maxRecords
Constraints:
Range: 1 - 50
ListWithAutoConstructFlag<T> scalingPolicies
java.lang.String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> activityIds
AutoScalingGroupName is provided, the results are limited
to that group. The list of requested activities cannot contain more
than 50 items. If unknown activities are requested, they are ignored
with no error.java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer maxRecords
Constraints:
Range: 1 - 50
java.lang.String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> activities
java.lang.String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> processes
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> scheduledActionNames
java.util.Date startTime
java.util.Date endTime
java.lang.String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer maxRecords
Constraints:
Range: 1 - 50
ListWithAutoConstructFlag<T> scheduledUpdateGroupActions
java.lang.String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> filters
java.lang.String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer maxRecords
Constraints:
Range: 1 - 50
ListWithAutoConstructFlag<T> tags
java.lang.String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> terminationPolicyTypes
OldestInstance, OldestLaunchConfiguration,
NewestInstance, ClosestToNextInstanceHour,
Defaultjava.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> metrics
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupTotalInstances
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> metrics
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupTotalInstances
java.lang.String granularity
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String policyName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean honorCooldown
True if you want Auto Scaling to reject this
request when the Auto Scaling group is in cooldown.java.lang.String name
"auto-scaling-group", "key",
"value", and "propagate-at-launch".
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> values
java.lang.String instanceId
Constraints:
Length: 1 - 16
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String availabilityZone
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String lifecycleState
Constraints:
Allowed Values: Pending, Quarantined, InService, Terminating, Terminated
java.lang.String healthStatus
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String launchConfigurationARN
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String imageId
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String keyName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> securityGroups
java.lang.String userData
Constraints:
Length: 0 - 21847
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String instanceType
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String kernelId
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String ramdiskId
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> blockDeviceMappings
InstanceMonitoring instanceMonitoring
java.lang.String spotPrice
Constraints:
Length: 1 - 255
java.lang.String iamInstanceProfile
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.util.Date createdTime
java.lang.Boolean ebsOptimized
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String topicARN
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String notificationType
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String topicARN
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> notificationTypes
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String policyName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer scalingAdjustment
AdjustmentType
determines the interpretation of this number (e.g., as an absolute
number or as a percentage of the existing Auto Scaling group size). A
positive increment adds to the current capacity and a negative value
removes from the current capacity.java.lang.String adjustmentType
ScalingAdjustment is an absolute
number or a percentage of the current capacity. Valid values are
ChangeInCapacity, ExactCapacity, and
PercentChangeInCapacity.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer cooldown
java.lang.Integer minAdjustmentStep
AdjustmentType with the value
PercentChangeInCapacity, the scaling policy changes the
DesiredCapacity of the Auto Scaling group by at least the
number of instances specified in the value. You will get a
ValidationError if you use MinAdjustmentStep
on a policy with an AdjustmentType other than
PercentChangeInCapacity.
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String scheduledActionName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.util.Date time
Time is deprecated. The time for this action to start.
Time is an alias for StartTime and can be
specified instead of StartTime, or vice versa. If both
Time and StartTime are specified, their
values should be identical. Otherwise,
PutScheduledUpdateGroupAction will return an error.
java.util.Date startTime
--start-time
2010-06-01T00:00:00Z. When StartTime and
EndTime are specified with Recurrence, they
form the boundaries of when the recurring action will start and stop.
java.util.Date endTime
java.lang.String recurrence
When StartTime and
EndTime are specified with Recurrence, they
form the boundaries of when the recurring action will start and stop.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer minSize
java.lang.Integer maxSize
java.lang.Integer desiredCapacity
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> scalingProcesses
To suspend all process types, omit this parameter.
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String policyName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer scalingAdjustment
java.lang.String adjustmentType
ScalingAdjustment is an absolute
number or a percentage of the current capacity. Valid values are
ChangeInCapacity, ExactCapacity, and
PercentChangeInCapacity.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer cooldown
java.lang.String policyARN
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> alarms
java.lang.Integer minAdjustmentStep
DesiredCapacity of the Auto Scaling group by
at least the specified number of instances.java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String scheduledActionName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String scheduledActionARN
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.util.Date time
Time is deprecated. The time that the action is
scheduled to begin. Time is an alias for
StartTime.
java.util.Date startTime
When StartTime and
EndTime are specified with Recurrence, they
form the boundaries of when the recurring action will start and stop.
java.util.Date endTime
java.lang.String recurrence
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer minSize
java.lang.Integer maxSize
java.lang.Integer desiredCapacity
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer desiredCapacity
java.lang.Boolean honorCooldown
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.java.lang.String instanceId
Constraints:
Length: 1 - 16
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String healthStatus
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean shouldRespectGracePeriod
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> scalingProcesses
To suspend all process types, omit this parameter.
java.lang.String resourceId
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String resourceType
auto-scaling-group resource type.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String key
Constraints:
Length: 1 - 128
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String value
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean propagateAtLaunch
java.lang.String resourceId
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String resourceType
auto-scaling-group resource type.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String key
Constraints:
Length: 1 - 128
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String value
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean propagateAtLaunch
java.lang.String instanceId
Constraints:
Length: 1 - 16
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean shouldDecrementDesiredCapacity
Activity activity
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String launchConfigurationName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer minSize
java.lang.Integer maxSize
java.lang.Integer desiredCapacity
java.lang.Integer defaultCooldown
ListWithAutoConstructFlag<T> availabilityZones
Constraints:
Length: 1 -
java.lang.String healthCheckType
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer healthCheckGracePeriod
java.lang.String placementGroup
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String vPCZoneIdentifier
When
you specify VPCZoneIdentifier with
AvailabilityZones, ensure that the subnets' Availability
Zones match the values you specify for AvailabilityZones.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> terminationPolicies
For more information on creating a termination policy for your Auto Scaling group, go to Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.
java.lang.String stackName
java.lang.String templateBody
Conditional: You must pass
TemplateBody or TemplateURL. If both are
passed, only TemplateBody is used.
Constraints:
Length: 1 - 51200
java.lang.String templateURL
Conditional: You must pass
TemplateURL or TemplateBody. If both are
passed, only TemplateBody is used.
Constraints:
Length: 1 - 1024
ListWithAutoConstructFlag<T> parameters
Parameter structures that specify input
parameters for the stack.java.lang.Boolean disableRollback
true to disable rollback of the stack if stack
creation failed. You can specify either DisableRollback
or OnFailure, but not both. Default:
false
java.lang.Integer timeoutInMinutes
DisableRollback is not set or is set to
false, the stack will be rolled back.
Constraints:
Range: 1 -
ListWithAutoConstructFlag<T> notificationARNs
Constraints:
Length: 0 - 5
ListWithAutoConstructFlag<T> capabilities
java.lang.String onFailure
OnFailure or DisableRollback, but not
both. Default: ROLLBACK
Constraints:
Allowed Values: DO_NOTHING, ROLLBACK, DELETE
ListWithAutoConstructFlag<T> tags
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.java.lang.String stackName
Default: There is no default value.
java.lang.String nextToken
Default: There is no default value.
Constraints:
Length: 1 - 1024
ListWithAutoConstructFlag<T> stackEvents
StackEvents structures.java.lang.String nextToken
Constraints:
Length: 1 - 1024
StackResourceDetail stackResourceDetail
StackResourceDetail structure containing the
description of the specified resource in the specified stack.java.lang.String stackName
Required: Conditional. If you do not specify
StackName, you must specify
PhysicalResourceId.
Default: There is no default value.
java.lang.String logicalResourceId
Default: There is no default value.
java.lang.String physicalResourceId
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.
ListWithAutoConstructFlag<T> stackResources
StackResource structures.ListWithAutoConstructFlag<T> stacks
java.lang.String nextToken
java.lang.String templateBody
Conditional: You must pass
TemplateBody or TemplateURL. If both are
passed, only TemplateBody is used.
Constraints:
Length: 1 - 51200
java.lang.String templateURL
Conditional: You must pass
TemplateURL or TemplateBody. If both are
passed, only TemplateBody is used.
Constraints:
Length: 1 - 1024
ListWithAutoConstructFlag<T> parameters
Parameter structures that specify input
parameters.java.lang.String templateBody
Constraints:
Length: 1 - 51200
java.lang.String stackName
Default: There is no default value.
java.lang.String nextToken
Default: There is no default value.
Constraints:
Length: 1 - 1024
ListWithAutoConstructFlag<T> stackResourceSummaries
StackResourceSummary structures.java.lang.String nextToken
Constraints:
Length: 1 - 1024
java.lang.String nextToken
Default: There is no default value.
Constraints:
Length: 1 - 1024
ListWithAutoConstructFlag<T> stackStatusFilters
StackStatus
parameter of the Stack data type.ListWithAutoConstructFlag<T> stackSummaries
StackSummary structures containing information
about the specified stacks.java.lang.String nextToken
Constraints:
Length: 1 - 1024
java.lang.String stackId
java.lang.String stackName
java.lang.String description
ListWithAutoConstructFlag<T> parameters
Parameter structures.java.util.Date creationTime
java.util.Date lastUpdatedTime
java.lang.String stackStatus
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
java.lang.String stackStatusReason
java.lang.Boolean disableRollback
true: disable rollbackfalse: enable rollbackListWithAutoConstructFlag<T> notificationARNs
Constraints:
Length: 0 - 5
java.lang.Integer timeoutInMinutes
Constraints:
Range: 1 -
ListWithAutoConstructFlag<T> capabilities
ListWithAutoConstructFlag<T> outputs
ListWithAutoConstructFlag<T> tags
Tags that specify cost allocation information
for the stack.java.lang.String stackId
java.lang.String eventId
java.lang.String stackName
java.lang.String logicalResourceId
java.lang.String physicalResourceId
java.lang.String resourceType
java.util.Date timestamp
java.lang.String resourceStatus
Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE
java.lang.String resourceStatusReason
java.lang.String resourceProperties
java.lang.String stackName
java.lang.String stackId
java.lang.String logicalResourceId
java.lang.String physicalResourceId
java.lang.String resourceType
java.util.Date timestamp
java.lang.String resourceStatus
Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE
java.lang.String resourceStatusReason
java.lang.String description
java.lang.String stackName
java.lang.String stackId
java.lang.String logicalResourceId
java.lang.String physicalResourceId
java.lang.String resourceType
java.util.Date lastUpdatedTimestamp
java.lang.String resourceStatus
Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE
java.lang.String resourceStatusReason
java.lang.String description
java.lang.String metadata
Metadata attribute
declared for the resource. For more information, see Metadata
Attribute in the AWS CloudFormation User Guide.java.lang.String logicalResourceId
java.lang.String physicalResourceId
java.lang.String resourceType
java.util.Date lastUpdatedTimestamp
java.lang.String resourceStatus
Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE
java.lang.String resourceStatusReason
java.lang.String stackId
java.lang.String stackName
java.lang.String templateDescription
java.util.Date creationTime
java.util.Date lastUpdatedTime
java.util.Date deletionTime
java.lang.String stackStatus
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
java.lang.String stackStatusReason
java.lang.String key
aws:.java.lang.String value
java.lang.String parameterKey
java.lang.String defaultValue
java.lang.Boolean noEcho
java.lang.String description
java.lang.String stackName
java.lang.String templateBody
Conditional: You must pass
TemplateBody or TemplateURL. If both are
passed, only TemplateBody is used.
Constraints:
Length: 1 - 51200
java.lang.String templateURL
Conditional: You must pass
TemplateURL or TemplateBody. If both are
passed, only TemplateBody is used.
Constraints:
Length: 1 - 1024
ListWithAutoConstructFlag<T> parameters
Parameter structures that specify input
parameters for the stack.ListWithAutoConstructFlag<T> capabilities
java.lang.String templateBody
Conditional: You must pass
TemplateURL or TemplateBody. If both are
passed, only TemplateBody is used.
Constraints:
Length: 1 - 51200
java.lang.String templateURL
Conditional: You must pass
TemplateURL or TemplateBody. If both are
passed, only TemplateBody is used.
Constraints:
Length: 1 - 1024
ListWithAutoConstructFlag<T> parameters
TemplateParameter structures.java.lang.String description
ListWithAutoConstructFlag<T> capabilities
java.lang.String capabilitiesReason
java.lang.Boolean enabled
java.lang.Integer quantity
ListWithAutoConstructFlag<T> items
java.lang.Integer quantity
ListWithAutoConstructFlag<T> items
java.lang.String pathPattern
java.lang.String targetOriginId
ForwardedValues forwardedValues
TrustedSigners trustedSigners
java.lang.String viewerProtocolPolicy
Constraints:
Allowed Values: allow-all, https-only
java.lang.Long minTTL
java.lang.Integer quantity
ListWithAutoConstructFlag<T> items
java.lang.String id
java.lang.String s3CanonicalUserId
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
java.lang.String callerReference
java.lang.String comment
java.lang.String marker
java.lang.String nextMarker
java.lang.Integer maxItems
java.lang.Boolean isTruncated
java.lang.Integer quantity
ListWithAutoConstructFlag<T> items
java.lang.String id
java.lang.String s3CanonicalUserId
java.lang.String comment
java.lang.Integer quantity
ListWithAutoConstructFlag<T> items
java.lang.String forward
Constraints:
Allowed Values: none, whitelist, all
CookieNames whitelistedNames
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity
java.lang.String location
java.lang.String eTag
DistributionConfig distributionConfig
Distribution distribution
java.lang.String location
java.lang.String eTag
java.lang.String distributionId
InvalidationBatch invalidationBatch
java.lang.String location
Invalidation invalidation
StreamingDistributionConfig streamingDistributionConfig
StreamingDistribution streamingDistribution
java.lang.String location
java.lang.String eTag
java.lang.Integer hTTPPort
java.lang.Integer hTTPSPort
java.lang.String originProtocolPolicy
Constraints:
Allowed Values: http-only, match-viewer
java.lang.String targetOriginId
ForwardedValues forwardedValues
TrustedSigners trustedSigners
java.lang.String viewerProtocolPolicy
Constraints:
Allowed Values: allow-all, https-only
java.lang.Long minTTL
java.lang.String id
java.lang.String status
java.util.Date lastModifiedTime
java.lang.Integer inProgressInvalidationBatches
java.lang.String domainName
ActiveTrustedSigners activeTrustedSigners
DistributionConfig distributionConfig
java.lang.String callerReference
Aliases aliases
java.lang.String defaultRootObject
Origins origins
DefaultCacheBehavior defaultCacheBehavior
CacheBehaviors cacheBehaviors
java.lang.String comment
LoggingConfig logging
java.lang.String priceClass
Constraints:
Allowed Values: PriceClass_100, PriceClass_200, PriceClass_All
java.lang.Boolean enabled
ViewerCertificate viewerCertificate
java.lang.String marker
java.lang.String nextMarker
java.lang.Integer maxItems
java.lang.Boolean isTruncated
java.lang.Integer quantity
ListWithAutoConstructFlag<T> items
java.lang.String id
java.lang.String status
java.util.Date lastModifiedTime
java.lang.String domainName
Aliases aliases
Origins origins
DefaultCacheBehavior defaultCacheBehavior
CacheBehaviors cacheBehaviors
java.lang.String comment
java.lang.String priceClass
java.lang.Boolean enabled
ViewerCertificate viewerCertificate
java.lang.Boolean queryString
CookiePreference cookies
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
java.lang.String eTag
CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity
java.lang.String eTag
DistributionConfig distributionConfig
java.lang.String eTag
Distribution distribution
java.lang.String eTag
Invalidation invalidation
StreamingDistributionConfig streamingDistributionConfig
java.lang.String eTag
StreamingDistribution streamingDistribution
java.lang.String eTag
java.lang.String id
java.lang.String status
java.util.Date createTime
InvalidationBatch invalidationBatch
Paths paths
java.lang.String callerReference
java.lang.String marker
java.lang.String nextMarker
java.lang.Integer maxItems
java.lang.Boolean isTruncated
java.lang.Integer quantity
ListWithAutoConstructFlag<T> items
java.lang.Integer quantity
ListWithAutoConstructFlag<T> items
java.lang.String marker
java.lang.String maxItems
CloudFrontOriginAccessIdentityList cloudFrontOriginAccessIdentityList
java.lang.String marker
java.lang.String maxItems
DistributionList distributionList
java.lang.String distributionId
java.lang.String marker
java.lang.String maxItems
InvalidationList invalidationList
java.lang.String marker
java.lang.String maxItems
StreamingDistributionList streamingDistributionList
java.lang.Boolean enabled
java.lang.Boolean includeCookies
java.lang.String bucket
java.lang.String prefix
java.lang.String id
java.lang.String domainName
S3OriginConfig s3OriginConfig
CustomOriginConfig customOriginConfig
java.lang.Integer quantity
ListWithAutoConstructFlag<T> items
Constraints:
Length: 1 -
java.lang.Integer quantity
ListWithAutoConstructFlag<T> items
java.lang.String originAccessIdentity
java.lang.String awsAccountNumber
KeyPairIds keyPairIds
java.lang.String id
java.lang.String status
java.util.Date lastModifiedTime
java.lang.String domainName
ActiveTrustedSigners activeTrustedSigners
StreamingDistributionConfig streamingDistributionConfig
java.lang.String callerReference
S3Origin s3Origin
Aliases aliases
java.lang.String comment
StreamingLoggingConfig logging
TrustedSigners trustedSigners
java.lang.String priceClass
Constraints:
Allowed Values: PriceClass_100, PriceClass_200, PriceClass_All
java.lang.Boolean enabled
java.lang.String marker
java.lang.String nextMarker
java.lang.Integer maxItems
java.lang.Boolean isTruncated
java.lang.Integer quantity
ListWithAutoConstructFlag<T> items
java.lang.String id
java.lang.String status
java.util.Date lastModifiedTime
java.lang.String domainName
S3Origin s3Origin
Aliases aliases
TrustedSigners trustedSigners
java.lang.String comment
java.lang.String priceClass
java.lang.Boolean enabled
java.lang.Boolean enabled
java.lang.String bucket
java.lang.String prefix
java.lang.Boolean enabled
java.lang.Integer quantity
ListWithAutoConstructFlag<T> items
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
java.lang.String id
java.lang.String ifMatch
CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity
java.lang.String eTag
DistributionConfig distributionConfig
java.lang.String id
java.lang.String ifMatch
Distribution distribution
java.lang.String eTag
StreamingDistributionConfig streamingDistributionConfig
java.lang.String id
java.lang.String ifMatch
StreamingDistribution streamingDistribution
java.lang.String eTag
java.lang.String iAMCertificateId
java.lang.Boolean cloudFrontDefaultCertificate
java.lang.String options
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"] } }} ] }
OptionStatus status
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
DomainStatus domainStatus
java.lang.String options
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_]*
OptionStatus status
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
IndexField indexField
IndexFieldType indicates which of the
options will be present. It is invalid to specify options for a type
other than the IndexFieldType.IndexFieldStatus indexField
IndexField and its current status.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
NamedRankExpression rankExpression
RankExpressionStatus rankExpression
RankExpression and its current status.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
DomainStatus domainStatus
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String indexFieldName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
IndexFieldStatus indexField
IndexField and its current status.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String rankName
RankExpression to delete.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
RankExpressionStatus rankExpression
RankExpression and its current status.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
DefaultSearchFieldStatus defaultSearchField
IndexField to use for search requests
issued with the q parameter. The default is the empty
string, which automatically searches all text fields.ListWithAutoConstructFlag<T> domainNames
ListWithAutoConstructFlag<T> domainStatusList
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
ListWithAutoConstructFlag<T> fieldNames
DescribeIndexFields response to the specified
fields.ListWithAutoConstructFlag<T> indexFields
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
ListWithAutoConstructFlag<T> rankNames
DescribeRankExpressions response to the
specified fields.ListWithAutoConstructFlag<T> rankExpressions
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
AccessPoliciesStatus accessPolicies
PolicyDocument that specifies access policies for the
search domain's services, and the current status of those policies.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
StemmingOptionsStatus stems
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
StopwordOptionsStatus stopwords
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
SynonymOptionsStatus synonyms
java.lang.String domainId
Constraints:
Length: 1 - 64
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.Boolean created
java.lang.Boolean deleted
java.lang.Integer numSearchableDocs
Constraints:
Range: 0 -
ServiceEndpoint docService
ServiceEndpoint searchService
java.lang.Boolean requiresIndexDocuments
java.lang.Boolean processing
java.lang.String searchInstanceType
Constraints:
Allowed Values: SearchInstance:t1.micro, SearchInstance:m1.small, SearchInstance:m1.large, SearchInstance:m2.xlarge
java.lang.Integer searchPartitionCount
Constraints:
Range: 1 -
java.lang.Integer searchInstanceCount
Constraints:
Range: 1 -
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
ListWithAutoConstructFlag<T> fieldNames
IndexDocuments action.java.lang.String indexFieldName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
java.lang.String indexFieldType
Constraints:
Allowed Values: uint, literal, text
UIntOptions uIntOptions
IndexFieldType specifies the field is of type unsigned
integer.LiteralOptions literalOptions
IndexFieldType
specifies the field is of type literal.TextOptions textOptions
IndexFieldType
specifies the field is of type text.ListWithAutoConstructFlag<T> sourceAttributes
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.IndexField options
IndexFieldType indicates which of the
options will be present. It is invalid to specify options for a type
other than the IndexFieldType.OptionStatus status
java.lang.String defaultValue
Constraints:
Length: 0 - 1024
java.lang.Boolean searchEnabled
java.lang.Boolean facetEnabled
java.lang.Boolean resultEnabled
java.lang.String rankName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
java.lang.String rankExpression
RankExpression syntax is
based on JavaScript expressions and supports:a || b
evaluates to the value a if a is
true without evaluting b at all+ - * / %abs ceil erf exp floor lgamma ln log2 log10 max min sqrt
powacosh acos
asinh asin atanh atan cosh cos sinh sin tanh tanrandtimemin max functions that
operate on a variable argument listIntermediate 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
java.util.Date creationDate
java.util.Date updateDate
java.lang.Integer updateVersion
Constraints:
Range: 0 -
java.lang.String state
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
NamedRankExpression options
OptionStatus status
java.lang.String arn
java.lang.String endpoint
java.lang.String sourceDataFunction
Constraints:
Allowed Values: Copy, TrimTitle, Map
SourceData sourceDataCopy
IndexField.SourceDataTrimTitle sourceDataTrimTitle
IndexField. This can be used to create an
IndexField you can use for sorting.SourceDataMap sourceDataMap
IndexField.java.lang.String sourceName
IndexField.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
java.lang.String defaultValue
Constraints:
Length: 0 - 1024
java.util.Map<K,V> cases
java.lang.String sourceName
IndexField.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
java.lang.String defaultValue
Constraints:
Length: 0 - 1024
java.lang.String separator
java.lang.String language
Constraints:
Pattern: [a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*
java.lang.String options
{ "stems": {"people": "person", "walking":
"walk"} }OptionStatus status
java.lang.String options
{ "stopwords": ["a", "an", "the", "of"] }OptionStatus status
java.lang.String options
{ "synonyms": {"cat": ["feline",
"kitten"], "puppy": "dog"} }OptionStatus status
java.lang.String defaultValue
Constraints:
Length: 0 - 1024
java.lang.Boolean facetEnabled
java.lang.Boolean resultEnabled
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String defaultSearchField
IndexField to use for search requests issued with the
q parameter. The default is an empty string, which
automatically searches all text fields.DefaultSearchFieldStatus defaultSearchField
DefaultSearchField configured for this
search domain and its current status.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String accessPolicies
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"] } }} ] }
AccessPoliciesStatus accessPolicies
PolicyDocument that specifies access policies for the
search domain's services, and the current status of those policies.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String stems
{ "stems": {"people": "person", "walking":
"walk"} }StemmingOptionsStatus stems
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String stopwords
{ "stopwords": ["a", "an", "the", "of"] }StopwordOptionsStatus stopwords
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String synonyms
{ "synonyms": {"cat": ["feline",
"kitten"], "puppy": "dog"} }SynonymOptionsStatus synonyms
java.lang.String alarmName
Constraints:
Length: 1 - 255
java.util.Date timestamp
java.lang.String historyItemType
Constraints:
Allowed Values: ConfigurationUpdate, StateUpdate, Action
java.lang.String historySummary
Constraints:
Length: 1 - 255
java.lang.String historyData
Constraints:
Length: 1 - 4095
java.util.Date timestamp
java.lang.Double sampleCount
java.lang.Double average
java.lang.Double sum
java.lang.Double minimum
java.lang.Double maximum
java.lang.String unit
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
ListWithAutoConstructFlag<T> alarmNames
Constraints:
Length: 0 - 100
java.lang.String alarmName
Constraints:
Length: 1 - 255
java.lang.String historyItemType
Constraints:
Allowed Values: ConfigurationUpdate, StateUpdate, Action
java.util.Date startDate
java.util.Date endDate
java.lang.Integer maxRecords
Constraints:
Range: 1 - 100
java.lang.String nextToken
ListWithAutoConstructFlag<T> alarmHistoryItems
java.lang.String nextToken
java.lang.String metricName
Constraints:
Length: 1 - 255
java.lang.String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String statistic
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
java.lang.Integer period
Constraints:
Range: 60 -
java.lang.String unit
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
ListWithAutoConstructFlag<T> metricAlarms
ListWithAutoConstructFlag<T> alarmNames
Constraints:
Length: 0 - 100
java.lang.String alarmNamePrefix
AlarmNames cannot be specified if
this parameter is specified.
Constraints:
Length: 1 - 255
java.lang.String stateValue
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
java.lang.String actionPrefix
Constraints:
Length: 1 - 1024
java.lang.Integer maxRecords
Constraints:
Range: 1 - 100
java.lang.String nextToken
ListWithAutoConstructFlag<T> metricAlarms
java.lang.String nextToken
ListWithAutoConstructFlag<T> alarmNames
Constraints:
Length: 0 - 100
ListWithAutoConstructFlag<T> alarmNames
Constraints:
Length: 0 - 100
java.lang.String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String metricName
Constraints:
Length: 1 - 255
ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
java.util.Date startTime
java.util.Date endTime
java.lang.Integer period
Period must be at least 60 seconds and must be a multiple
of 60. The default value is 60.
Constraints:
Range: 60 -
ListWithAutoConstructFlag<T> statistics
Constraints:
Length: 1 - 5
java.lang.String unit
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
java.lang.String label
ListWithAutoConstructFlag<T> datapoints
java.lang.String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String metricName
Constraints:
Length: 1 - 255
ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
java.lang.String nextToken
ListWithAutoConstructFlag<T> metrics
java.lang.String nextToken
java.lang.String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String metricName
Constraints:
Length: 1 - 255
ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
java.lang.String alarmName
Constraints:
Length: 1 - 255
java.lang.String alarmArn
Constraints:
Length: 1 - 1600
java.lang.String alarmDescription
Constraints:
Length: 0 - 255
java.util.Date alarmConfigurationUpdatedTimestamp
java.lang.Boolean actionsEnabled
ListWithAutoConstructFlag<T> oKActions
OK state from any other state. Each action is specified
as an Amazon Resource Number (ARN). Currently the only actions
supported are publishing to an Amazon SNS topic and triggering an Auto
Scaling policy.
Constraints:
Length: 0 - 5
ListWithAutoConstructFlag<T> alarmActions
ALARM state from any other state. Each action is
specified as an Amazon Resource Number (ARN). Currently the only
actions supported are publishing to an Amazon SNS topic and triggering
an Auto Scaling policy.
Constraints:
Length: 0 - 5
ListWithAutoConstructFlag<T> insufficientDataActions
INSUFFICIENT_DATA state from any other state. Each action
is specified as an Amazon Resource Number (ARN). Currently the only
actions supported are publishing to an Amazon SNS topic or triggering
an Auto Scaling policy.
Constraints:
Length: 0 - 5
java.lang.String stateValue
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
java.lang.String stateReason
Constraints:
Length: 0 - 1023
java.lang.String stateReasonData
Constraints:
Length: 0 - 4000
java.util.Date stateUpdatedTimestamp
java.lang.String metricName
Constraints:
Length: 1 - 255
java.lang.String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String statistic
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
java.lang.Integer period
Constraints:
Range: 60 -
java.lang.String unit
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
java.lang.Integer evaluationPeriods
Constraints:
Range: 1 -
java.lang.Double threshold
java.lang.String comparisonOperator
Statistic and Threshold. The specified
Statistic value is used as the first operand.
Constraints:
Allowed Values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
java.lang.String metricName
Constraints:
Length: 1 - 255
ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
java.util.Date timestamp
java.lang.Double value
Value
parameter accepts numbers of type Double, Amazon
CloudWatch truncates values with very large exponents. Values with
base-10 exponents greater than 126 (1 x 10^126) are truncated.
Likewise, values with base-10 exponents less than -130 (1 x 10^-130)
are also truncated. StatisticSet statisticValues
java.lang.String unit
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
java.lang.String alarmName
Constraints:
Length: 1 - 255
java.lang.String alarmDescription
Constraints:
Length: 0 - 255
java.lang.Boolean actionsEnabled
ListWithAutoConstructFlag<T> oKActions
OK state from any other state. Each action is specified
as an Amazon Resource Number (ARN). Currently the only action
supported is publishing to an Amazon SNS topic or an Amazon Auto
Scaling policy.
Constraints:
Length: 0 - 5
ListWithAutoConstructFlag<T> alarmActions
ALARM state from any other state. Each action is
specified as an Amazon Resource Number (ARN). Currently the only
action supported is publishing to an Amazon SNS topic or an Amazon
Auto Scaling policy.
Constraints:
Length: 0 - 5
ListWithAutoConstructFlag<T> insufficientDataActions
INSUFFICIENT_DATA state from any other state. Each action
is specified as an Amazon Resource Number (ARN). Currently the only
action supported is publishing to an Amazon SNS topic or an Amazon
Auto Scaling policy.
Constraints:
Length: 0 - 5
java.lang.String metricName
Constraints:
Length: 1 - 255
java.lang.String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String statistic
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
java.lang.Integer period
Constraints:
Range: 60 -
java.lang.String unit
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
java.lang.Integer evaluationPeriods
Constraints:
Range: 1 -
java.lang.Double threshold
java.lang.String comparisonOperator
Statistic and Threshold. The specified
Statistic value is used as the first operand.
Constraints:
Allowed Values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
java.lang.String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
ListWithAutoConstructFlag<T> metricData
java.lang.String alarmName
Constraints:
Length: 1 - 255
java.lang.String stateValue
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
java.lang.String stateReason
Constraints:
Length: 0 - 1023
java.lang.String stateReasonData
Constraints:
Length: 0 - 4000
java.lang.Double sampleCount
java.lang.Double sum
java.lang.Double minimum
java.lang.Double maximum
java.lang.String name
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String uniqueId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String description
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> objectIds
java.lang.Boolean evaluateExpressions
java.lang.String marker
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]*
ListWithAutoConstructFlag<T> pipelineObjects
java.lang.String marker
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean hasMoreResults
True, there are more pages of results to return.ListWithAutoConstructFlag<T> pipelineIds
ListWithAutoConstructFlag<T> pipelineDescriptionList
java.lang.String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String objectId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String expression
Constraints:
Length: 0 - 20971520
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String key
Constraints:
Length: 1 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String stringValue
Constraints:
Length: 0 - 10240
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String refValue
Constraints:
Length: 1 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String version
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]*
ListWithAutoConstructFlag<T> pipelineObjects
java.lang.String document
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String signature
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String marker
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]*
ListWithAutoConstructFlag<T> pipelineIdList
java.lang.String marker
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean hasMoreResults
True, there are more results that can be obtained by a
subsequent call to ListPipelines.java.lang.String type
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:
The
comparison operators GE, LE, and
BETWEEN act on the following fields:
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
ListWithAutoConstructFlag<T> values
java.lang.String pipelineId
df-297EG78HU43EEXAMPLE.
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String name
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> fields
java.lang.String description
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String id
df-297EG78HU43EEXAMPLE.
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String name
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String id
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String name
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> fields
java.lang.String workerGroup
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]*
java.lang.String hostname
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
InstanceIdentity instanceIdentity
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.TaskObject taskObject
java.lang.String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> pipelineObjects
ListWithAutoConstructFlag<T> validationErrors
pipelineObjects.ListWithAutoConstructFlag<T> validationWarnings
pipelineObjects.java.lang.Boolean errored
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.ListWithAutoConstructFlag<T> selectors
java.lang.String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
Query query
java.lang.String sphere
COMPONENT, INSTANCE,
ATTEMPT.
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String marker
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]*
java.lang.Integer limit
ListWithAutoConstructFlag<T> ids
java.lang.String marker
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]*
java.lang.Boolean hasMoreResults
True, there are more results that can be obtained by a
subsequent call to QueryObjects.java.lang.String taskId
Constraints:
Length: 1 - 2048
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean canceled
True, the calling task runner should cancel processing
of the task. The task runner does not need to call
SetTaskStatus for canceled tasks.java.lang.String taskrunnerId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String workerGroup
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]*
java.lang.String hostname
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Boolean terminate
True, the task runner that called
ReportTaskRunnerHeartbeat should terminate.java.lang.String fieldName
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
Operator operator
java.lang.String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> objectIds
java.lang.String status
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]*
java.lang.String taskId
Constraints:
Length: 1 - 2048
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String taskStatus
FINISHED, the task successfully completed. If
FAILED the task ended unsuccessfully. The
FALSE value is used by preconditions.
Constraints:
Allowed Values: FINISHED, FAILED, FALSE
java.lang.String errorId
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String errorMessage
java.lang.String errorStackTrace
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String taskId
Constraints:
Length: 1 - 2048
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String attemptId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
java.util.Map<K,V> objects
java.lang.String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> pipelineObjects
ListWithAutoConstructFlag<T> validationErrors
ListWithAutoConstructFlag<T> validationWarnings
java.lang.Boolean errored
True, there were validation errors.java.lang.String id
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> errors
java.lang.String id
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> warnings
java.lang.String connectionId
Example: dxcon-fg5678gh
Default: None
java.lang.String connectionName
Example: "1G Connection to AWS"
Default: None
java.lang.String connectionState
Constraints:
Allowed Values: requested, pending, available, deleted
java.lang.String region
Example: us-east-1
Default: None
java.lang.String location
Example: EqSV5
Default: None
java.lang.String name
Example: Inbound data transfer
java.lang.String unit
Example: "Gbps," if the price is calculated based on Gbps.
java.lang.String currencyCode
Example: "USD" for US dollar.
java.lang.String amount
Example: 0.01
java.lang.String number
Example: 1
java.lang.String name
Example: Authorize cross connect
java.lang.String description
Example: "AWS will prepare your connection and send you an email with an LOA to provide to the colocation provider"
java.lang.String owner
Example: AWS, Customer
java.lang.Integer sla
Example: 60
java.lang.String stepState
Constraints:
Allowed Values: pending, completed
java.lang.String connectionId
Example: dxcon-fg5678gh
Default: None
java.lang.String connectionName
Example: "1G Connection to AWS"
Default: None
java.lang.String connectionState
Constraints:
Allowed Values: requested, pending, available, deleted
java.lang.String region
Example: us-east-1
Default: None
java.lang.String location
Example: EqSV5
Default: None
java.lang.String connectionId
Example: dxcon-fg5678gh
Default: None
NewPrivateVirtualInterface newPrivateVirtualInterface
Default: None
java.lang.String virtualInterfaceId
Example: dxvif-123dfg56
Default: None
java.lang.String location
Example: EqSV5
Default: None
java.lang.String connectionId
Example: dxcon-fg5678gh
Default: None
java.lang.String virtualInterfaceType
Example: Private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, etc.)
java.lang.String virtualInterfaceName
Example: "Dev VPC"
java.lang.Integer vlan
Example: 101
java.lang.Integer asn
Example: 65000
java.lang.String authKey
Example: asdf34example
java.lang.String amazonAddress
Example: 192.168.1.1
java.lang.String customerAddress
Example: 192.168.1.2
java.lang.String virtualInterfaceState
Constraints:
Allowed Values: verifying, pending, available, deleting, deleted
java.lang.String customerRouterConfig
java.lang.String virtualGatewayId
Example: vgw-123er56
ListWithAutoConstructFlag<T> routeFilterPrefixes
java.lang.String connectionId
Example: dxcon-fg5678gh
Default: None
NewPublicVirtualInterface newPublicVirtualInterface
Default: None
java.lang.String virtualInterfaceId
Example: dxvif-123dfg56
Default: None
java.lang.String location
Example: EqSV5
Default: None
java.lang.String connectionId
Example: dxcon-fg5678gh
Default: None
java.lang.String virtualInterfaceType
Example: Private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, etc.)
java.lang.String virtualInterfaceName
Example: "Dev VPC"
java.lang.Integer vlan
Example: 101
java.lang.Integer asn
Example: 65000
java.lang.String authKey
Example: asdf34example
java.lang.String amazonAddress
Example: 192.168.1.1
java.lang.String customerAddress
Example: 192.168.1.2
java.lang.String virtualInterfaceState
Constraints:
Allowed Values: verifying, pending, available, deleting, deleted
java.lang.String customerRouterConfig
java.lang.String virtualGatewayId
Example: vgw-123er56
ListWithAutoConstructFlag<T> routeFilterPrefixes
java.lang.String connectionId
Example: dxcon-fg5678gh
Default: None
java.lang.String connectionName
Example: "1G Connection to AWS"
Default: None
java.lang.String connectionState
Constraints:
Allowed Values: requested, pending, available, deleted
java.lang.String region
Example: us-east-1
Default: None
java.lang.String location
Example: EqSV5
Default: None
java.lang.String virtualInterfaceState
Constraints:
Allowed Values: verifying, pending, available, deleting, deleted
java.lang.String connectionId
Example: dxcon-fg5678gh
Default: None
java.lang.String connectionName
Example: "1G Connection to AWS"
Default: None
java.lang.String connectionState
Constraints:
Allowed Values: requested, pending, available, deleted
java.lang.String region
Example: us-east-1
Default: None
java.lang.String location
Example: EqSV5
Default: None
java.lang.String bandwidth
Example: 1Gbps
Default: None
ListWithAutoConstructFlag<T> connectionCosts
ListWithAutoConstructFlag<T> orderSteps
ListWithAutoConstructFlag<T> connections
java.lang.String offeringId
Example: us-west-1_EqSV5_1G
Default: None
java.lang.String region
Example: us-east-1
Default: None
java.lang.String location
Example: EqSV5
Default: None
java.lang.String offeringName
java.lang.String description
Example: "1Gbps Cross Connect in us-east-1 via Equinix"
Default: None
java.lang.String bandwidth
Example: 1Gbps
Default: None
ListWithAutoConstructFlag<T> connectionCosts
ListWithAutoConstructFlag<T> orderSteps
ListWithAutoConstructFlag<T> offerings
ListWithAutoConstructFlag<T> virtualGateways
ListWithAutoConstructFlag<T> virtualInterfaces
java.lang.String virtualInterfaceName
Example: "Dev VPC"
java.lang.Integer vlan
Example: 101
java.lang.Integer asn
Example: 65000
java.lang.String authKey
Example: asdf34example
java.lang.String amazonAddress
Example: 192.168.1.1
java.lang.String customerAddress
java.lang.String virtualGatewayId
Example: vgw-123er56
java.lang.String virtualInterfaceName
Example: "Dev VPC"
java.lang.Integer vlan
Example: 101
java.lang.Integer asn
Example: 65000
java.lang.String authKey
Example: asdf34example
java.lang.String amazonAddress
Example: 192.168.1.1
java.lang.String customerAddress
ListWithAutoConstructFlag<T> routeFilterPrefixes
java.lang.String offeringId
Example: us-west-1_EqSV5_1G
Default: None
java.lang.String region
Example: us-east-1
Default: None
java.lang.String location
Example: EqSV5
Default: None
java.lang.String offeringName
Example: "1Gbps Cross Connect in us-east-1 via Equinix"
Default: None
java.lang.String description
Example: "1Gbps Cross Connect in us-east-1 via Equinix"
Default: None
java.lang.String bandwidth
Example: 1Gbps
Default: None
ListWithAutoConstructFlag<T> connectionCosts
java.lang.String number
Example: 1
java.lang.String name
Example: Authorize cross connect
java.lang.String description
Example: "AWS will prepare your connection and send you an email with an LOA to provide to the colocation provider"
java.lang.String owner
Example: AWS
java.lang.Integer sla
Example: 60
java.lang.String virtualGatewayId
Example: vgw-123er56
java.lang.String virtualGatewayState
java.lang.String virtualInterfaceId
Example: dxvif-123dfg56
Default: None
java.lang.String location
Example: EqSV5
Default: None
java.lang.String connectionId
Example: dxcon-fg5678gh
Default: None
java.lang.String virtualInterfaceType
Example: Private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, etc.)
java.lang.String virtualInterfaceName
Example: "Dev VPC"
java.lang.Integer vlan
Example: 101
java.lang.Integer asn
Example: 65000
java.lang.String authKey
Example: asdf34example
java.lang.String amazonAddress
Example: 192.168.1.1
java.lang.String customerAddress
Example: 192.168.1.2
java.lang.String virtualInterfaceState
Constraints:
Allowed Values: verifying, pending, available, deleting, deleted
java.lang.String customerRouterConfig
java.lang.String virtualGatewayId
Example: vgw-123er56
ListWithAutoConstructFlag<T> routeFilterPrefixes
java.lang.String s
java.lang.String n
java.nio.ByteBuffer b
java.util.List<E> sS
java.util.List<E> nS
java.util.List<E> bS
AttributeValue value
String, Number,
Binary, StringSet, NumberSet,
BinarySet.java.lang.String action
Constraints:
Allowed Values: ADD, PUT, DELETE
java.util.Map<K,V> responses
java.util.Map<K,V> unprocessedKeys
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
java.util.List<E> items
java.lang.Double consumedCapacityUnits
GetItem,
BatchGetItem, BatchWriteItem,
Query, and Scan operations consume
ReadCapacityUnits, while PutItem,
UpdateItem, and DeleteItem operations
consume WriteCapacityUnits.java.util.Map<K,V> responses
BatchWriteItem call.
This is essentially a map of table name to
ConsumedCapacityUnits.java.util.Map<K,V> unprocessedItems
BatchWriteItem call is returned as
UnprocessedItems
Constraints:
Length: 1 - 25
java.lang.Double consumedCapacityUnits
GetItem,
BatchGetItem, BatchWriteItem,
Query, and Scan operations consume
ReadCapacityUnits, while PutItem,
UpdateItem, and DeleteItem operations
consume WriteCapacityUnits.java.util.List<E> attributeValueList
BETWEEN comparison, the
AttributeValueList contains two attribute values and the comparison
operator.java.lang.String comparisonOperator
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
java.lang.String tableName
a-z, A-Z, 0-9, _
(underscore), - (hyphen) and . (period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
KeySchema keySchema
HashKeyElement. A composite hash-and-range primary key
contains two attribute values: a HashKeyElement and a
RangeKeyElement.ProvisionedThroughput provisionedThroughput
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.TableDescription tableDescription
java.lang.String tableName
a-z, A-Z, 0-9,
_ (underscore), - (hyphen) and
. (period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Key key
java.util.Map<K,V> expected
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.java.lang.String returnValues
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
java.util.Map<K,V> attributes
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.java.lang.Double consumedCapacityUnits
GetItem,
BatchGetItem, BatchWriteItem,
Query, and Scan operations consume
ReadCapacityUnits, while PutItem,
UpdateItem, and DeleteItem operations
consume WriteCapacityUnits.Key key
TableDescription tableDescription
TableDescription table
AttributeValue value
java.lang.Boolean exists
java.lang.String tableName
a-z, A-Z, 0-9,
_ (underscore), - (hyphen) and
. (period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Key key
java.util.List<E> attributesToGet
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 -
java.lang.Boolean consistentRead
true, then a consistent read is issued.
Otherwise eventually-consistent is used.java.util.Map<K,V> item
java.lang.Double consumedCapacityUnits
GetItem,
BatchGetItem, BatchWriteItem,
Query, and Scan operations consume
ReadCapacityUnits, while PutItem,
UpdateItem, and DeleteItem operations
consume WriteCapacityUnits.AttributeValue hashKeyElement
String, Number,
StringSet, NumberSet.AttributeValue rangeKeyElement
String, Number, StringSet,
NumberSet.java.util.List<E> keys
java.util.List<E> attributesToGet
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 -
java.lang.Boolean consistentRead
true, then a consistent read is issued.
Otherwise eventually-consistent is used.KeySchemaElement hashKeyElement
String, Number,
StringSet, NumberSet.KeySchemaElement rangeKeyElement
String, Number, StringSet,
NumberSet.java.lang.String attributeName
AttributeName of the KeySchemaElement.
Constraints:
Length: 1 - 255
java.lang.String attributeType
AttributeType of the KeySchemaElement
which can be a String or a Number.
Constraints:
Allowed Values: S, N, B
java.lang.String exclusiveStartTableName
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_.-]+
java.lang.Integer limit
Constraints:
Range: 1 - 100
java.util.List<E> tableNames
java.lang.String lastEvaluatedTableName
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_.-]+
java.lang.Long readCapacityUnits
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 -
java.lang.Long writeCapacityUnits
WriteCapacityUnits are in terms of strictly consistent
reads, assuming items of 1k. 2k items require twice the
WriteCapacityUnits.
Constraints:
Range: 1 -
java.util.Date lastIncreaseDateTime
java.util.Date lastDecreaseDateTime
java.lang.Long numberOfDecreasesToday
java.lang.Long readCapacityUnits
java.lang.Long writeCapacityUnits
java.lang.String tableName
a-z, A-Z, 0-9,
_ (underscore), - (hyphen) and
. (period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.Map<K,V> item
java.util.Map<K,V> expected
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.java.lang.String returnValues
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
java.util.Map<K,V> attributes
ReturnValues parameter is specified as
ALL_OLD in the request.java.lang.Double consumedCapacityUnits
GetItem,
BatchGetItem, BatchWriteItem,
Query, and Scan operations consume
ReadCapacityUnits, while PutItem,
UpdateItem, and DeleteItem operations
consume WriteCapacityUnits.java.lang.String tableName
a-z, A-Z, 0-9,
_ (underscore), - (hyphen) and
. (period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.List<E> attributesToGet
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 -
java.lang.Integer limit
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 -
java.lang.Boolean consistentRead
true, then a consistent read is issued.
Otherwise eventually-consistent is used.java.lang.Boolean count
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.AttributeValue hashKeyValue
Condition rangeKeyCondition
java.lang.Boolean scanIndexForward
true (forward).Key exclusiveStartKey
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.java.util.List<E> items
java.lang.Integer count
Key lastEvaluatedKey
LastEvaluatedKey is null when the entire query result set
is complete (i.e. the operation processed the "last page").java.lang.Double consumedCapacityUnits
GetItem,
BatchGetItem, BatchWriteItem,
Query, and Scan operations consume
ReadCapacityUnits, while PutItem,
UpdateItem, and DeleteItem operations
consume WriteCapacityUnits.java.lang.String tableName
a-z, A-Z, 0-9,
_ (underscore), - (hyphen) and
. (period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.List<E> attributesToGet
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 -
java.lang.Integer limit
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 -
java.lang.Boolean count
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.java.util.Map<K,V> scanFilter
Key exclusiveStartKey
Limit parameter. The
LastEvaluatedKey can be passed back in a new scan request
to continue the operation from that point.java.util.List<E> items
java.lang.Integer count
java.lang.Integer scannedCount
ScannedCount value with few, or no,
Count results indicates an inefficient Scan
operation.Key lastEvaluatedKey
LastEvaluatedKey is null when the entire
scan result set is complete (i.e. the operation processed the "last
page").java.lang.Double consumedCapacityUnits
GetItem,
BatchGetItem, BatchWriteItem,
Query, and Scan operations consume
ReadCapacityUnits, while PutItem,
UpdateItem, and DeleteItem operations
consume WriteCapacityUnits.java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
KeySchema keySchema
HashKeyElement. A composite hash-and-range primary key
contains two attribute values: a HashKeyElement and a
RangeKeyElement.java.lang.String tableStatus
java.util.Date creationDateTime
ProvisionedThroughputDescription provisionedThroughput
java.lang.Long tableSizeBytes
java.lang.Long itemCount
java.lang.String tableName
a-z, A-Z, 0-9,
_ (underscore), - (hyphen) and
. (period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Key key
java.util.Map<K,V> attributeUpdates
java.util.Map<K,V> expected
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.java.lang.String returnValues
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
java.util.Map<K,V> attributes
ReturnValues parameter is specified as something other
than NONE in the request.java.lang.Double consumedCapacityUnits
GetItem,
BatchGetItem, BatchWriteItem,
Query, and Scan operations consume
ReadCapacityUnits, while PutItem,
UpdateItem, and DeleteItem operations
consume WriteCapacityUnits.java.lang.String tableName
a-z, A-Z, 0-9, _
(underscore), - (hyphen) and . (period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
ProvisionedThroughput provisionedThroughput
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.TableDescription tableDescription
PutRequest putRequest
DeleteRequest deleteRequest
java.lang.String s
java.lang.String n
java.nio.ByteBuffer b
ListWithAutoConstructFlag<T> sS
ListWithAutoConstructFlag<T> nS
ListWithAutoConstructFlag<T> bS
AttributeValue value
java.lang.String action
PUT, DELETE, and ADD. The
behavior depends on whether the specified primary key already exists
in the table. If an item with the specified Key is found in the table:
PUT - Adds the specified
attribute to the item. If the attribute already exists, it is replaced
by the new value.
DELETE - If no value is
specified, the attribute and its value are removed from the item. The
data type of the specified value must match the existing value's data
type.
If a set of values is specified, then those values are
subtracted from the old set. For example, if the attribute value was
the set [a,b,c] and the DELETE action specified
[a,c], then the final attribute value would be
[b]. Specifying an empty set is an error.
ADD - If the attribute does not already exist, then
the attribute and its values are added to the item. If the attribute
does exist, then the behavior of ADD depends on the data
type of the attribute:
If the existing attribute is a
number, and if Value is also a number, then the Value is
mathematically added to the existing attribute. If Value is a
negative number, then it is subtracted from the existing attribute.
If you use In addition, if you use
ADD to increment or decrement a
number value for an item that doesn't exist before the update, Amazon
DynamoDB uses 0 as the initial value. ADD to update an existing item, and intend to increment
or decrement an attribute value which does not yet exist, 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
java.util.Map<K,V> requestItems
Each element in the map consists of the following:
Keys - An array of primary key attribute values that define specific items in the table.
AttributesToGet - One or more attributes to be retrieved from the table 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
java.lang.String returnConsumedCapacity
TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
java.util.Map<K,V> responses
java.util.Map<K,V> unprocessedKeys
Each element consists of:
Keys - An array of primary key attribute values that define specific items in the table.
AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.
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
ListWithAutoConstructFlag<T> consumedCapacity
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
java.util.Map<K,V> requestItems
DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:
Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
Constraints:
Length: 1 - 25
java.lang.String returnConsumedCapacity
TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
java.lang.String returnItemCollectionMetrics
SIZE, statistics about item collections, if
any, that were modified during the operation are returned in the
response. If set to NONE (the default), no statistics are
returned..
Constraints:
Allowed Values: SIZE, NONE
java.util.Map<K,V> unprocessedItems
Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to perform (DeleteRequest or PutRequest).
DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:
Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
Constraints:
Length: 1 - 25
java.util.Map<K,V> itemCollectionMetrics
Each entry consists of the following subelements:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the 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.
ListWithAutoConstructFlag<T> consumedCapacity
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
ListWithAutoConstructFlag<T> attributeValueList
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.
java.lang.String comparisonOperator
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
ListWithAutoConstructFlag<T> attributeDefinitions
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
ListWithAutoConstructFlag<T> keySchema
Each KeySchemaElement in the array is composed of:
AttributeName - The name of this key attribute.
KeyType - Determines whether the key attribute is
HASH or RANGE.
For a primary
key that consists of a hash attribute, you must specify exactly one
element with a KeyType of HASH.
For a primary
key that consists of hash and range attributes, you must specify
exactly two elements, in this order: The first element must have a
KeyType of HASH, and the second element must have
a KeyType of RANGE.
For more information, see Specifying the Primary Key in the Amazon DynamoDB Developer Guide.
Constraints:
Length: 1 - 2
ListWithAutoConstructFlag<T> localSecondaryIndexes
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
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
TableDescription tableDescription
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.Map<K,V> key
java.util.Map<K,V> expected
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.
java.lang.String returnValues
NONE - If ReturnValues is
not specified, or if its value is NONE, then nothing is
returned. (This is the default for ReturnValues.)
ALL_OLD - The content of the old item is returned.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
java.lang.String returnConsumedCapacity
TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
java.lang.String returnItemCollectionMetrics
SIZE, statistics about item collections, if
any, that were modified during the operation are returned in the
response. If set to NONE (the default), no statistics are
returned..
Constraints:
Allowed Values: SIZE, NONE
java.util.Map<K,V> attributes
ALL_OLD in the
request.ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
Each ItemCollectionMetrics element consists of:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size, measured in gigabytes. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the 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.
TableDescription tableDescription
TableDescription table
AttributeValue value
java.lang.Boolean exists
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.
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.Map<K,V> key
ListWithAutoConstructFlag<T> attributesToGet
Constraints:
Length: 1 -
java.lang.Boolean consistentRead
true, then the operation uses strongly
consistent reads; otherwise, eventually consistent reads are used.java.lang.String returnConsumedCapacity
TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
java.util.Map<K,V> item
ConsumedCapacity consumedCapacity
java.util.Map<K,V> itemCollectionKey
ListWithAutoConstructFlag<T> sizeEstimateRangeGB
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
ListWithAutoConstructFlag<T> keys
Constraints:
Length: 1 - 100
ListWithAutoConstructFlag<T> attributesToGet
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 -
java.lang.Boolean consistentRead
true, then a strongly consistent read is used; otherwise,
an eventually consistent read is used.java.lang.String exclusiveStartTableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.lang.Integer limit
Constraints:
Range: 1 - 100
ListWithAutoConstructFlag<T> tableNames
java.lang.String lastEvaluatedTableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.lang.String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
ListWithAutoConstructFlag<T> keySchema
HASH or
RANGE).
Constraints:
Length: 1 - 2
Projection projection
java.lang.String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
ListWithAutoConstructFlag<T> keySchema
HASH or
RANGE).
Constraints:
Length: 1 - 2
Projection projection
java.lang.Long indexSizeBytes
java.lang.Long itemCount
java.lang.String projectionType
KEYS_ONLY - Only the index and primary keys
are projected into the index.
INCLUDE -
Only the specified table attributes are projected into the index. The
list of projected attributes are in NonKeyAttributes.
ALL - All of the table attributes are projected
into the index.
Constraints:
Allowed Values: ALL, KEYS_ONLY, INCLUDE
ListWithAutoConstructFlag<T> nonKeyAttributes
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
java.lang.Long readCapacityUnits
Constraints:
Range: 1 -
java.lang.Long writeCapacityUnits
Constraints:
Range: 1 -
java.util.Date lastIncreaseDateTime
java.util.Date lastDecreaseDateTime
java.lang.Long numberOfDecreasesToday
Constraints:
Range: 1 -
java.lang.Long readCapacityUnits
Constraints:
Range: 1 -
java.lang.Long writeCapacityUnits
Constraints:
Range: 1 -
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.Map<K,V> item
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item map is an AttributeValue object.
java.util.Map<K,V> expected
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.
java.lang.String returnValues
NONE -
If ReturnValues is not specified, or if its value is
NONE, then nothing is returned. (This is the default for
ReturnValues.)
ALL_OLD - If
PutItem overwrote an attribute name-value pair, then the
content of the old item is returned.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
java.lang.String returnConsumedCapacity
TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
java.lang.String returnItemCollectionMetrics
SIZE, statistics about item collections, if
any, that were modified during the operation are returned in the
response. If set to NONE (the default), no statistics are
returned..
Constraints:
Allowed Values: SIZE, NONE
java.util.Map<K,V> attributes
ALL_OLD in the request. Each element consists of an
attribute name and an attribute value.ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
Each ItemCollectionMetrics element consists of:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size, measured in gigabytes. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the 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.
java.util.Map<K,V> item
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.lang.String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.lang.String select
ALL_ATTRIBUTES: Returns all of
the item attributes. 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
ListWithAutoConstructFlag<T> attributesToGet
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 -
java.lang.Integer limit
Constraints:
Range: 1 -
java.lang.Boolean consistentRead
true, then the operation uses strongly
consistent reads; otherwise, eventually consistent reads are used.java.util.Map<K,V> keyConditions
For a query on a table, you
can only have conditions on the table primary key attributes. You must
specify the hash key attribute name and value as an EQ
condition. You can optionally specify a second condition, referring to
the range key attribute.
For a query on 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 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, For Binary, Amazon DynamoDB treats each byte of the binary data as
unsigned when it compares binary values, for example when evaluating
query expressions. BETWEEN or IN comparison, in
which case the list contains two values. 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.
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"]}
java.lang.Boolean scanIndexForward
If ScanIndexForward is not specified, the results are returned in ascending order.
java.util.Map<K,V> exclusiveStartKey
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
java.lang.String returnConsumedCapacity
TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
ListWithAutoConstructFlag<T> items
java.lang.Integer count
java.util.Map<K,V> lastEvaluatedKey
LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).
ConsumedCapacity consumedCapacity
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
ListWithAutoConstructFlag<T> attributesToGet
Constraints:
Length: 1 -
java.lang.Integer limit
Constraints:
Range: 1 -
java.lang.String select
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
java.util.Map<K,V> scanFilter
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 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, For Binary, Amazon DynamoDB treats each byte of the binary data as
unsigned when it compares binary values, for example when evaluating
query expressions. BETWEEN or IN comparison, in
which case the list contains two values. 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.
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"]}
java.util.Map<K,V> exclusiveStartKey
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
java.lang.String returnConsumedCapacity
TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
java.lang.Integer totalSegments
The value for TotalSegments must be greater than or equal to 1, and less than or equal to 4096. If you specify a TotalSegments value of 1, the Scan will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
Constraints:
Range: 1 - 4096
java.lang.Integer segment
Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application threads, the first thread would specify a Segment value of 0, the second thread would specify 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same Segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
If you specify Segment, you must also specify TotalSegments.
Constraints:
Range: 0 - 4095
ListWithAutoConstructFlag<T> items
java.lang.Integer count
java.lang.Integer scannedCount
java.util.Map<K,V> lastEvaluatedKey
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
ListWithAutoConstructFlag<T> attributeDefinitions
Each AttributeDefinition object in this array is composed of:
AttributeName - The name of the attribute.
AttributeType - The data type for the attribute.
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
ListWithAutoConstructFlag<T> keySchema
AttributeName - The name of the attribute.
KeyType - The key type for the
attribute. Can be either HASH or RANGE.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Constraints:
Length: 1 - 2
java.lang.String tableStatus
CREATING - The table is being created, as the result of a CreateTable operation.
UPDATING - The table is being updated, as the result of an UpdateTable operation.
DELETING - The table is being deleted, as the result of a DeleteTable operation.
ACTIVE - The table is ready for use.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
java.util.Date creationDateTime
ProvisionedThroughputDescription provisionedThroughput
java.lang.Long tableSizeBytes
java.lang.Long itemCount
ListWithAutoConstructFlag<T> localSecondaryIndexes
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.
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.Map<K,V> key
java.util.Map<K,V> attributeUpdates
Attribute values cannot be null. String and binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException.
Each AttributeUpdates element consists of an attribute name to modify, along with the following:
Value - The new value, if applicable, for this attribute.
Action - Specifies how to perform the
update. Valid values for Action are PUT,
DELETE, and ADD. The behavior depends on
whether the specified primary key already exists in the table.
If an item with the specified Key is found in the table:
PUT - Adds the specified attribute to the
item. If the attribute already exists, it is replaced by the new
value.
DELETE - If no value is specified,
the attribute and its value are removed from the item. The data type
of the specified value must match the existing value's data type.
If a set of values is specified, then those values are
subtracted from the old set. For example, if the attribute value was
the set [a,b,c] and the DELETE action specified
[a,c], then the final attribute value would be
[b]. Specifying an empty set is an error.
ADD - If the attribute does not already exist, then
the attribute and its values are added to the item. If the attribute
does exist, then the behavior of ADD depends on the data
type of the attribute:
If the existing attribute is a
number, and if Value is also a number, then the Value is
mathematically added to the existing attribute. If Value is a
negative number, then it is subtracted from the existing attribute.
If you use In addition, if you use
ADD to increment or decrement a
number value for an item that doesn't exist before the update, Amazon
DynamoDB uses 0 as the initial value. ADD to update an existing item, and intend to increment
or decrement an attribute value which does not yet exist, 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.
java.util.Map<K,V> expected
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.
java.lang.String returnValues
NONE - If ReturnValues is not specified, or if
its value is NONE, then nothing is returned. (This is the
default for ReturnValues.)
ALL_OLD -
If UpdateItem overwrote an attribute name-value pair, then the
content of the old item is returned.
UPDATED_OLD - The old versions of only the updated
attributes are returned.
ALL_NEW - All of
the attributes of the new version of the item are returned.
UPDATED_NEW - The new versions of only the updated
attributes are returned.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
java.lang.String returnConsumedCapacity
TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
java.lang.String returnItemCollectionMetrics
SIZE, statistics about item collections, if
any, that were modified during the operation are returned in the
response. If set to NONE (the default), no statistics are
returned..
Constraints:
Allowed Values: SIZE, NONE
java.util.Map<K,V> attributes
NONE in the request.
Each element represents one attribute.ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
ProvisionedThroughput provisionedThroughput
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
TableDescription tableDescription
PutRequest putRequest
DeleteRequest deleteRequest
java.lang.String attributeName
ListWithAutoConstructFlag<T> attributeValues
java.lang.String instanceId
java.lang.String publicIp
java.lang.String allocationId
java.lang.String associationId
java.lang.String domain
java.lang.String networkInterfaceId
java.lang.String networkInterfaceOwnerId
java.lang.String privateIpAddress
java.lang.String networkInterfaceId
ListWithAutoConstructFlag<T> privateIpAddresses
java.lang.Integer secondaryPrivateIpAddressCount
java.lang.Boolean allowReassignment
java.lang.String instanceId
java.lang.String publicIp
java.lang.String allocationId
java.lang.String networkInterfaceId
java.lang.String privateIpAddress
java.lang.Boolean allowReassociation
java.lang.String volumeId
java.lang.String instanceId
java.lang.String device
/dev/sdh).VolumeAttachment attachment
VpcAttachment vpcAttachement
java.lang.String groupId
java.lang.String sourceSecurityGroupName
java.lang.String sourceSecurityGroupOwnerId
java.lang.String ipProtocol
java.lang.Integer fromPort
java.lang.Integer toPort
java.lang.String cidrIp
ListWithAutoConstructFlag<T> ipPermissions
java.lang.String groupName
java.lang.String groupId
java.lang.String sourceSecurityGroupName
java.lang.String sourceSecurityGroupOwnerId
java.lang.String ipProtocol
java.lang.Integer fromPort
java.lang.Integer toPort
java.lang.String cidrIp
ListWithAutoConstructFlag<T> ipPermissions
java.lang.String zoneName
java.lang.String state
java.lang.String regionName
ListWithAutoConstructFlag<T> messages
java.lang.String virtualName
java.lang.String deviceName
/dev/sdh).EbsBlockDevice ebs
java.lang.String noDevice
java.lang.String instanceId
Storage storage
BundleTask bundleTask
java.lang.String instanceId
java.lang.String bundleId
java.lang.String state
java.util.Date startTime
java.util.Date updateTime
Storage storage
java.lang.String progress
BundleTaskError bundleTaskError
BundleTask bundleTask
ListWithAutoConstructFlag<T> reservedInstancesListings
ListWithAutoConstructFlag<T> spotInstanceRequestIds
ListWithAutoConstructFlag<T> cancelledSpotInstanceRequests
java.lang.String conversionTaskId
java.lang.String expirationTime
ImportInstanceTaskDetails importInstance
ImportVolumeTaskDetails importVolume
java.lang.String state
java.lang.String statusMessage
ListWithAutoConstructFlag<T> tags
java.lang.String type
java.lang.String publicIp
java.lang.Integer bgpAsn
CustomerGateway customerGateway
ListWithAutoConstructFlag<T> dhcpConfigurations
DhcpOptions dhcpOptions
java.lang.String instanceId
java.lang.String name
java.lang.String description
java.lang.Boolean noReboot
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.ListWithAutoConstructFlag<T> blockDeviceMappings
java.lang.String description
java.lang.String instanceId
java.lang.String targetEnvironment
ExportToS3TaskSpecification exportToS3Task
ExportTask exportTask
InternetGateway internetGateway
KeyPair keyPair
java.lang.String networkAclId
java.lang.Integer ruleNumber
java.lang.String protocol
tcp,
udp, icmp or an IP protocol number.java.lang.String ruleAction
Constraints:
Allowed Values: allow, deny
java.lang.Boolean egress
true) or ingress traffic to the subnet
(false).java.lang.String cidrBlock
172.16.0.0/24).IcmpTypeCode icmpTypeCode
PortRange portRange
NetworkAcl networkAcl
java.lang.String subnetId
java.lang.String description
java.lang.String privateIpAddress
ListWithAutoConstructFlag<T> groups
ListWithAutoConstructFlag<T> privateIpAddresses
java.lang.Integer secondaryPrivateIpAddressCount
NetworkInterface networkInterface
java.lang.String reservedInstancesId
java.lang.Integer instanceCount
ListWithAutoConstructFlag<T> priceSchedules
java.lang.String clientToken
ListWithAutoConstructFlag<T> reservedInstancesListings
java.lang.String routeTableId
java.lang.String destinationCidrBlock
0.0.0.0/0. Routing decisions are based on the most
specific match.java.lang.String gatewayId
GatewayId or InstanceId, but
not both.java.lang.String instanceId
GatewayId or InstanceId, but not both.java.lang.String networkInterfaceId
RouteTable routeTable
Snapshot snapshot
SpotDatafeedSubscription spotDatafeedSubscription
Subnet subnet
ListWithAutoConstructFlag<T> resources
ListWithAutoConstructFlag<T> tags
ListWithAutoConstructFlag<T> add
ListWithAutoConstructFlag<T> remove
java.lang.Integer size
java.lang.String snapshotId
java.lang.String availabilityZone
java.lang.String volumeType
java.lang.Integer iops
Volume volume
java.lang.String cidrBlock
java.lang.String instanceTenancy
Vpc vpc
java.lang.String type
java.lang.String customerGatewayId
java.lang.String vpnGatewayId
VpnConnectionOptionsSpecification options
VpnConnection vpnConnection
VpnGateway vpnGateway
java.lang.String customerGatewayId
java.lang.String state
pending, available, deleting,
and deleted.java.lang.String type
java.lang.String ipAddress
java.lang.String bgpAsn
ListWithAutoConstructFlag<T> tags
java.lang.String routeTableId
java.lang.String destinationCidrBlock
ListWithAutoConstructFlag<T> resources
ListWithAutoConstructFlag<T> tags
If a tag is specified without a value, the tag and all of its values are deleted.
ListWithAutoConstructFlag<T> attributeNames
ListWithAutoConstructFlag<T> accountAttributes
ListWithAutoConstructFlag<T> publicIps
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> allocationIds
ListWithAutoConstructFlag<T> addresses
ListWithAutoConstructFlag<T> zoneNames
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> availabilityZones
ListWithAutoConstructFlag<T> bundleIds
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> bundleTasks
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> conversionTaskIds
ListWithAutoConstructFlag<T> conversionTasks
ListWithAutoConstructFlag<T> customerGatewayIds
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> customerGateways
ListWithAutoConstructFlag<T> dhcpOptionsIds
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> dhcpOptions
ListWithAutoConstructFlag<T> exportTaskIds
ListWithAutoConstructFlag<T> exportTasks
ImageAttribute imageAttribute
ListWithAutoConstructFlag<T> imageIds
ListWithAutoConstructFlag<T> owners
self : AMIs owned by you AWS account
ID : AMIs owned by this account ID aws-marketplace :
AMIs owned by the AWS Marketplace amazon : AMIs owned by
Amazon all : Do not scope the AMIs returned by owner
The values self, aws-marketplace,
amazon, and all are literals.
ListWithAutoConstructFlag<T> executableUsers
self :
AMIs for which you have explicit launch permissions AWS account
ID : AMIs for which this account ID has launch permissions
all : AMIs that have public launch permissions
The values self and all are literals.
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> images
java.lang.String instanceId
java.lang.String attribute
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
InstanceAttribute instanceAttribute
ListWithAutoConstructFlag<T> instanceIds
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> reservations
ListWithAutoConstructFlag<T> instanceIds
ListWithAutoConstructFlag<T> filters
java.lang.String nextToken
java.lang.Integer maxResults
java.lang.Boolean includeAllInstances
ListWithAutoConstructFlag<T> instanceStatuses
java.lang.String nextToken
ListWithAutoConstructFlag<T> internetGatewayIds
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> internetGateways
ListWithAutoConstructFlag<T> keyNames
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> keyPairs
ListWithAutoConstructFlag<T> licenseIds
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> licenses
ListWithAutoConstructFlag<T> networkAclIds
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> networkAcls
java.lang.String networkInterfaceId
java.lang.String description
java.lang.Boolean sourceDestCheck
ListWithAutoConstructFlag<T> groups
NetworkInterfaceAttachment attachment
ListWithAutoConstructFlag<T> networkInterfaceIds
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> networkInterfaces
ListWithAutoConstructFlag<T> groupNames
PlacementGroup.ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> placementGroups
PlacementGroups.ListWithAutoConstructFlag<T> regionNames
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> regions
java.lang.String reservedInstancesId
java.lang.String reservedInstancesListingId
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> reservedInstancesListings
ListWithAutoConstructFlag<T> reservedInstancesOfferingIds
java.lang.String instanceType
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
java.lang.String availabilityZone
java.lang.String productDescription
ListWithAutoConstructFlag<T> filters
java.lang.String instanceTenancy
java.lang.String offeringType
java.lang.String nextToken
java.lang.Integer maxResults
java.lang.Boolean includeMarketplace
java.lang.Long minDuration
java.lang.Long maxDuration
java.lang.Integer maxInstanceCount
ListWithAutoConstructFlag<T> reservedInstancesOfferings
java.lang.String nextToken
ListWithAutoConstructFlag<T> reservedInstancesIds
ListWithAutoConstructFlag<T> filters
java.lang.String offeringType
ListWithAutoConstructFlag<T> reservedInstances
ListWithAutoConstructFlag<T> routeTableIds
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> routeTables
ListWithAutoConstructFlag<T> groupNames
ListWithAutoConstructFlag<T> groupIds
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> securityGroups
java.lang.String snapshotId
java.lang.String attribute
Available attribute names: createVolumePermission
Constraints:
Allowed Values: productCodes, createVolumePermission
java.lang.String snapshotId
ListWithAutoConstructFlag<T> createVolumePermissions
Only available if the createVolumePermission attribute is requested.
ListWithAutoConstructFlag<T> productCodes
ListWithAutoConstructFlag<T> snapshotIds
ListWithAutoConstructFlag<T> ownerIds
self : Snapshots owned
by you AWS account ID : Snapshots owned by this account ID
amazon : Snapshots owned by Amazon The values
self and amazon are literals.
ListWithAutoConstructFlag<T> restorableByUserIds
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> snapshots
SpotDatafeedSubscription spotDatafeedSubscription
ListWithAutoConstructFlag<T> spotInstanceRequestIds
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> spotInstanceRequests
java.util.Date startTime
java.util.Date endTime
ListWithAutoConstructFlag<T> instanceTypes
ListWithAutoConstructFlag<T> productDescriptions
ListWithAutoConstructFlag<T> filters
java.lang.String availabilityZone
java.lang.Integer maxResults
java.lang.String nextToken
ListWithAutoConstructFlag<T> spotPriceHistory
java.lang.String nextToken
ListWithAutoConstructFlag<T> subnetIds
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> subnets
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> tags
java.lang.String volumeId
java.lang.Boolean autoEnableIO
ListWithAutoConstructFlag<T> productCodes
ListWithAutoConstructFlag<T> volumeIds
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> volumes
ListWithAutoConstructFlag<T> volumeIds
ListWithAutoConstructFlag<T> filters
java.lang.String nextToken
java.lang.Integer maxResults
ListWithAutoConstructFlag<T> volumeStatuses
java.lang.String nextToken
ListWithAutoConstructFlag<T> vpcIds
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> vpcs
ListWithAutoConstructFlag<T> vpnConnectionIds
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> vpnConnections
ListWithAutoConstructFlag<T> vpnGatewayIds
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> vpnGateways
java.lang.String volumeId
java.lang.String instanceId
java.lang.String device
java.lang.Boolean force
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.
VolumeAttachment attachment
java.lang.String key
ListWithAutoConstructFlag<T> values
java.lang.String dhcpOptionsId
ListWithAutoConstructFlag<T> dhcpConfigurations
ListWithAutoConstructFlag<T> tags
DiskImageDetail image
java.lang.String description
VolumeDetail volume
java.lang.String snapshotId
java.lang.Integer volumeSize
java.lang.Boolean deleteOnTermination
java.lang.String volumeType
java.lang.Integer iops
java.lang.String volumeId
java.lang.String status
java.util.Date attachTime
java.lang.Boolean deleteOnTermination
java.lang.String exportTaskId
java.lang.String description
java.lang.String state
java.lang.String statusMessage
InstanceExportDetails instanceExportDetails
ExportToS3Task exportToS3Task
java.lang.String name
ListWithAutoConstructFlag<T> values
java.lang.String instanceId
java.util.Date timestamp
java.lang.String passwordData
java.lang.Integer type
-1 is a
wildcard meaning all types. Required if specifying icmp
for the protocol.java.lang.Integer code
-1 is a
wildcard meaning all codes. Required if specifying icmp
for the protocol.java.lang.String imageId
java.lang.String imageLocation
java.lang.String state
Constraints:
Allowed Values: available, deregistered
java.lang.String ownerId
java.lang.Boolean publicValue
ListWithAutoConstructFlag<T> productCodes
java.lang.String architecture
java.lang.String imageType
java.lang.String kernelId
java.lang.String ramdiskId
java.lang.String platform
StateReason stateReason
java.lang.String imageOwnerAlias
java.lang.String name
java.lang.String description
java.lang.String rootDeviceType
java.lang.String rootDeviceName
/dev/sda1).ListWithAutoConstructFlag<T> blockDeviceMappings
java.lang.String virtualizationType
ListWithAutoConstructFlag<T> tags
java.lang.String hypervisor
java.lang.String imageId
ListWithAutoConstructFlag<T> launchPermissions
ListWithAutoConstructFlag<T> productCodes
java.lang.String kernelId
java.lang.String ramdiskId
java.lang.String description
ListWithAutoConstructFlag<T> blockDeviceMappings
java.lang.String architecture
ListWithAutoConstructFlag<T> groupNames
java.lang.String additionalInfo
java.lang.String userData
java.lang.String instanceType
Placement placement
java.lang.Boolean monitoring
java.lang.String subnetId
java.lang.String instanceInitiatedShutdownBehavior
java.lang.String privateIpAddress
java.lang.String description
ImportInstanceLaunchSpecification launchSpecification
ListWithAutoConstructFlag<T> diskImages
java.lang.String platform
ConversionTask conversionTask
ListWithAutoConstructFlag<T> volumes
java.lang.String instanceId
java.lang.String platform
java.lang.String description
java.lang.Long bytesConverted
java.lang.String availabilityZone
DiskImageDescription image
DiskImageVolumeDescription volume
java.lang.String status
java.lang.String statusMessage
java.lang.String description
java.lang.String keyName
java.lang.String keyFingerprint
java.lang.String availabilityZone
DiskImageDetail image
java.lang.String description
VolumeDetail volume
ConversionTask conversionTask
java.lang.Long bytesConverted
java.lang.String availabilityZone
java.lang.String description
DiskImageDescription image
DiskImageVolumeDescription volume
java.lang.String instanceId
java.lang.String imageId
InstanceState state
java.lang.String privateDnsName
java.lang.String publicDnsName
java.lang.String stateTransitionReason
java.lang.String keyName
java.lang.Integer amiLaunchIndex
ListWithAutoConstructFlag<T> productCodes
java.lang.String instanceType
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
java.util.Date launchTime
Placement placement
java.lang.String kernelId
java.lang.String ramdiskId
java.lang.String platform
Monitoring monitoring
java.lang.String subnetId
java.lang.String vpcId
java.lang.String privateIpAddress
java.lang.String publicIpAddress
StateReason stateReason
java.lang.String architecture
java.lang.String rootDeviceType
java.lang.String rootDeviceName
/dev/sda1).ListWithAutoConstructFlag<T> blockDeviceMappings
java.lang.String virtualizationType
java.lang.String instanceLifecycle
java.lang.String spotInstanceRequestId
InstanceLicense license
java.lang.String clientToken
ListWithAutoConstructFlag<T> tags
ListWithAutoConstructFlag<T> securityGroups
java.lang.Boolean sourceDestCheck
java.lang.String hypervisor
ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfile iamInstanceProfile
java.lang.Boolean ebsOptimized
java.lang.String instanceId
java.lang.String instanceType
m1.small,
c1.medium, m2.2xlarge, and so on).java.lang.String kernelId
java.lang.String ramdiskId
java.lang.String userData
java.lang.Boolean disableApiTermination
java.lang.String instanceInitiatedShutdownBehavior
java.lang.String rootDeviceName
/dev/sda1).ListWithAutoConstructFlag<T> blockDeviceMappings
ListWithAutoConstructFlag<T> productCodes
java.lang.Boolean ebsOptimized
java.lang.String deviceName
/dev/sdh) at which the block
device is exposed on the instance.EbsInstanceBlockDevice ebs
java.lang.String deviceName
/dev/sdh) at which the block
device is exposed on the instance.EbsInstanceBlockDeviceSpecification ebs
java.lang.String virtualName
java.lang.String noDevice
java.lang.String instanceId
Monitoring monitoring
java.lang.String networkInterfaceId
java.lang.String subnetId
java.lang.String vpcId
java.lang.String description
java.lang.String ownerId
java.lang.String status
java.lang.String privateIpAddress
java.lang.String privateDnsName
java.lang.Boolean sourceDestCheck
ListWithAutoConstructFlag<T> groups
InstanceNetworkInterfaceAttachment attachment
InstanceNetworkInterfaceAssociation association
ListWithAutoConstructFlag<T> privateIpAddresses
java.lang.String networkInterfaceId
java.lang.Integer deviceIndex
java.lang.String subnetId
java.lang.String description
java.lang.String privateIpAddress
ListWithAutoConstructFlag<T> groups
java.lang.Boolean deleteOnTermination
ListWithAutoConstructFlag<T> privateIpAddresses
java.lang.Integer secondaryPrivateIpAddressCount
java.lang.String privateIpAddress
java.lang.String privateDnsName
java.lang.Boolean primary
InstanceNetworkInterfaceAssociation association
java.lang.Integer code
java.lang.String name
Constraints:
Allowed Values: pending, running, shutting-down, terminated, stopping, stopped
java.lang.String instanceId
InstanceState currentState
InstanceState previousState
java.lang.String instanceId
java.lang.String availabilityZone
ListWithAutoConstructFlag<T> events
InstanceState instanceState
InstanceStatusSummary systemStatus
InstanceStatusSummary instanceStatus
java.lang.String code
java.lang.String description
java.util.Date notBefore
java.util.Date notAfter
java.lang.String status
ListWithAutoConstructFlag<T> details
java.lang.String internetGatewayId
ListWithAutoConstructFlag<T> attachments
ListWithAutoConstructFlag<T> tags
java.lang.String ipProtocol
Valid protocol values:
tcp, udp, icmp
java.lang.Integer fromPort
-1 indicates a wildcard
(i.e., any ICMP type number).java.lang.Integer toPort
-1 indicates a wildcard (i.e., any ICMP
code).ListWithAutoConstructFlag<T> userIdGroupPairs
ListWithAutoConstructFlag<T> ipRanges
ListWithAutoConstructFlag<T> add
ListWithAutoConstructFlag<T> remove
java.lang.String imageId
java.lang.String keyName
ListWithAutoConstructFlag<T> allSecurityGroups
ListWithAutoConstructFlag<T> securityGroups
java.lang.String userData
java.lang.String addressingType
java.lang.String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, 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
SpotPlacement placement
java.lang.String kernelId
java.lang.String ramdiskId
ListWithAutoConstructFlag<T> blockDeviceMappings
java.lang.Boolean monitoringEnabled
java.lang.String subnetId
ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfileSpecification iamInstanceProfile
java.lang.Boolean ebsOptimized
java.lang.String licenseId
java.lang.String type
java.lang.String pool
ListWithAutoConstructFlag<T> capacities
ListWithAutoConstructFlag<T> tags
java.lang.Integer capacity
java.lang.Integer instanceCapacity
java.lang.String state
java.util.Date earliestAllowedDeactivationTime
java.lang.String imageId
java.lang.String attribute
Available
attributes: launchPermission, productCodes
java.lang.String operationType
Available operation types:
add, remove
ListWithAutoConstructFlag<T> userIds
ListWithAutoConstructFlag<T> userGroups
Available user
groups: all
ListWithAutoConstructFlag<T> productCodes
java.lang.String value
LaunchPermissionModifications launchPermission
java.lang.String description
java.lang.String instanceId
java.lang.String attribute
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
java.lang.String value
Only valid
when kernel, ramdisk, userData,
disableApiTermination or
instanceInitiateShutdownBehavior is specified as the
attribute being modified.
ListWithAutoConstructFlag<T> blockDeviceMappings
Only valid when blockDeviceMapping is specified as the attribute being modified.
java.lang.Boolean sourceDestCheck
java.lang.Boolean disableApiTermination
java.lang.String instanceType
java.lang.String kernel
java.lang.String ramdisk
java.lang.String userData
java.lang.String instanceInitiatedShutdownBehavior
ListWithAutoConstructFlag<T> groups
java.lang.Boolean ebsOptimized
java.lang.String networkInterfaceId
java.lang.String description
java.lang.Boolean sourceDestCheck
ListWithAutoConstructFlag<T> groups
NetworkInterfaceAttachmentChanges attachment
java.lang.String snapshotId
java.lang.String attribute
Available attribute
names: createVolumePermission
Constraints:
Allowed Values: productCodes, createVolumePermission
java.lang.String operationType
Available operation
names: add, remove
ListWithAutoConstructFlag<T> userIds
createVolumePermission attribute is being modified.
ListWithAutoConstructFlag<T> groupNames
createVolumePermission attribute is being modified.
CreateVolumePermissionModifications createVolumePermission
ListWithAutoConstructFlag<T> instanceIds
ListWithAutoConstructFlag<T> instanceMonitorings
java.lang.String networkAclId
java.lang.String vpcId
java.lang.Boolean isDefault
ListWithAutoConstructFlag<T> entries
ListWithAutoConstructFlag<T> associations
ListWithAutoConstructFlag<T> tags
java.lang.Integer ruleNumber
java.lang.String protocol
java.lang.String ruleAction
java.lang.Boolean egress
java.lang.String cidrBlock
IcmpTypeCode icmpTypeCode
PortRange portRange
java.lang.String networkInterfaceId
java.lang.String subnetId
java.lang.String vpcId
java.lang.String availabilityZone
java.lang.String description
java.lang.String ownerId
java.lang.String requesterId
java.lang.Boolean requesterManaged
java.lang.String status
java.lang.String macAddress
java.lang.String privateIpAddress
java.lang.String privateDnsName
java.lang.Boolean sourceDestCheck
ListWithAutoConstructFlag<T> groups
NetworkInterfaceAttachment attachment
NetworkInterfaceAssociation association
ListWithAutoConstructFlag<T> tagSet
ListWithAutoConstructFlag<T> privateIpAddresses
java.lang.String attachmentId
java.lang.String instanceId
java.lang.String instanceOwnerId
java.lang.Integer deviceIndex
java.lang.String status
java.util.Date attachTime
java.lang.Boolean deleteOnTermination
java.lang.String privateIpAddress
java.lang.String privateDnsName
java.lang.Boolean primary
NetworkInterfaceAssociation association
java.lang.String availabilityZone
java.lang.String groupName
java.lang.String tenancy
java.lang.String groupName
PlacementGroup.java.lang.String strategy
PlacementGroup.
Constraints:
Allowed Values: cluster
java.lang.String state
PlacementGroup.
Constraints:
Allowed Values: pending, available, deleting, deleted
java.lang.String reservedInstancesOfferingId
java.lang.Integer instanceCount
ReservedInstanceLimitPrice limitPrice
ListWithAutoConstructFlag<T> instanceIds
java.lang.String imageLocation
java.lang.String name
Constraints: 3-128
alphanumeric characters, parenthesis (()), commas
(,), slashes (/), dashes (-),
or underscores(_)
java.lang.String description
java.lang.String architecture
Valid Values: i386,
x86_64
java.lang.String kernelId
java.lang.String ramdiskId
Some kernels require additional drivers at launch. Check the kernel requirements for information on whether you need to specify a RAM disk.
java.lang.String rootDeviceName
/dev/sda1).ListWithAutoConstructFlag<T> blockDeviceMappings
java.lang.String networkAclId
java.lang.Integer ruleNumber
java.lang.String protocol
tcp,
udp, icmp or an IP protocol number.java.lang.String ruleAction
Constraints:
Allowed Values: allow, deny
java.lang.Boolean egress
true) or ingress traffic (false).java.lang.String cidrBlock
172.16.0.0/24).IcmpTypeCode icmpTypeCode
PortRange portRange
java.lang.String routeTableId
java.lang.String destinationCidrBlock
0.0.0.0/0. The value you provide must match the CIDR of
an existing route in the table.java.lang.String gatewayId
java.lang.String instanceId
java.lang.String networkInterfaceId
ListWithAutoConstructFlag<T> instances
java.lang.String status
java.util.Date startTime
java.util.Date endTime
ListWithAutoConstructFlag<T> reasonCodes
java.lang.String description
java.lang.String spotPrice
java.lang.Integer instanceCount
java.lang.String type
Constraints:
Allowed Values: one-time, persistent
java.util.Date validFrom
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.
java.util.Date validUntil
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.
java.lang.String launchGroup
java.lang.String availabilityZoneGroup
When specifying the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.
LaunchSpecification launchSpecification
ListWithAutoConstructFlag<T> spotInstanceRequests
java.lang.String reservationId
java.lang.String ownerId
java.lang.String requesterId
ListWithAutoConstructFlag<T> groups
ListWithAutoConstructFlag<T> groupNames
ListWithAutoConstructFlag<T> instances
java.lang.String reservedInstancesId
java.lang.String instanceType
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
java.lang.String availabilityZone
java.util.Date start
java.lang.Long duration
java.lang.Float usagePrice
java.lang.Float fixedPrice
java.lang.Integer instanceCount
java.lang.String productDescription
java.lang.String state
ListWithAutoConstructFlag<T> tags
java.lang.String instanceTenancy
java.lang.String currencyCode
java.lang.String offeringType
ListWithAutoConstructFlag<T> recurringCharges
java.lang.String reservedInstancesListingId
java.lang.String reservedInstancesId
java.util.Date createDate
java.util.Date updateDate
java.lang.String status
java.lang.String statusMessage
ListWithAutoConstructFlag<T> instanceCounts
ListWithAutoConstructFlag<T> priceSchedules
ListWithAutoConstructFlag<T> tags
java.lang.String clientToken
java.lang.String reservedInstancesOfferingId
java.lang.String instanceType
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
java.lang.String availabilityZone
java.lang.Long duration
java.lang.Float usagePrice
java.lang.Float fixedPrice
java.lang.String productDescription
java.lang.String instanceTenancy
java.lang.String currencyCode
java.lang.String offeringType
ListWithAutoConstructFlag<T> recurringCharges
java.lang.Boolean marketplace
ListWithAutoConstructFlag<T> pricingDetails
java.lang.String instanceId
java.lang.String attribute
Available attribute names:
kernel, ramdisk
Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized
java.lang.String groupId
java.lang.String sourceSecurityGroupName
java.lang.String sourceSecurityGroupOwnerId
java.lang.String ipProtocol
java.lang.Integer fromPort
java.lang.Integer toPort
java.lang.String cidrIp
ListWithAutoConstructFlag<T> ipPermissions
java.lang.String groupName
java.lang.String groupId
java.lang.String sourceSecurityGroupName
java.lang.String sourceSecurityGroupOwnerId
java.lang.String ipProtocol
java.lang.Integer fromPort
java.lang.Integer toPort
java.lang.String cidrIp
ListWithAutoConstructFlag<T> ipPermissions
java.lang.String routeTableId
java.lang.String vpcId
ListWithAutoConstructFlag<T> routes
ListWithAutoConstructFlag<T> associations
ListWithAutoConstructFlag<T> tags
ListWithAutoConstructFlag<T> propagatingVgws
java.lang.String imageId
java.lang.Integer minCount
java.lang.Integer maxCount
Between 1 and the maximum number allowed for your account (default: 20).
java.lang.String keyName
ListWithAutoConstructFlag<T> securityGroups
ListWithAutoConstructFlag<T> securityGroupIds
java.lang.String userData
java.lang.String instanceType
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
java.lang.String kernelId
java.lang.String ramdiskId
ListWithAutoConstructFlag<T> blockDeviceMappings
java.lang.Boolean monitoring
java.lang.String subnetId
java.lang.Boolean disableApiTermination
java.lang.String instanceInitiatedShutdownBehavior
InstanceLicenseSpecification license
java.lang.String privateIpAddress
java.lang.String clientToken
java.lang.String additionalInfo
ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfileSpecification iamInstanceProfile
java.lang.Boolean ebsOptimized
Reservation reservation
java.lang.String bucket
If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
java.lang.String prefix
java.lang.String aWSAccessKeyId
java.lang.String uploadPolicy
java.lang.String uploadPolicySignature
java.lang.String ownerId
java.lang.String groupName
java.lang.String groupId
java.lang.String description
ListWithAutoConstructFlag<T> ipPermissions
ListWithAutoConstructFlag<T> ipPermissionsEgress
java.lang.String vpcId
ListWithAutoConstructFlag<T> tags
java.lang.String snapshotId
java.lang.String volumeId
java.lang.String state
Constraints:
Allowed Values: pending, completed, error
java.util.Date startTime
java.lang.String progress
java.lang.String ownerId
java.lang.String description
java.lang.Integer volumeSize
java.lang.String ownerAlias
ListWithAutoConstructFlag<T> tags
java.lang.String ownerId
java.lang.String bucket
java.lang.String prefix
java.lang.String state
SpotInstanceStateFault fault
java.lang.String spotInstanceRequestId
java.lang.String spotPrice
java.lang.String type
java.lang.String state
SpotInstanceStateFault fault
SpotInstanceStatus status
java.util.Date validFrom
java.util.Date validUntil
java.lang.String launchGroup
java.lang.String availabilityZoneGroup
LaunchSpecification launchSpecification
java.lang.String instanceId
java.util.Date createTime
java.lang.String productDescription
ListWithAutoConstructFlag<T> tags
java.lang.String launchedAvailabilityZone
java.lang.String availabilityZone
java.lang.String groupName
ListWithAutoConstructFlag<T> instanceIds
java.lang.String additionalInfo
ListWithAutoConstructFlag<T> startingInstances
ListWithAutoConstructFlag<T> instanceIds
java.lang.Boolean force
ListWithAutoConstructFlag<T> stoppingInstances
S3Storage s3
java.lang.String subnetId
java.lang.String state
pending or available.java.lang.String vpcId
java.lang.String cidrBlock
java.lang.Integer availableIpAddressCount
The IP addresses for any stopped instances are considered unavailable.
java.lang.String availabilityZone
java.lang.Boolean defaultForAz
java.lang.Boolean mapPublicIpOnLaunch
ListWithAutoConstructFlag<T> tags
java.lang.String resourceId
java.lang.String resourceType
Constraints:
Allowed Values: customer-gateway, dhcp-options, image, instance, snapshot, spot-instances-request, subnet, volume, vpc, vpn-connection, vpn-gateway
java.lang.String key
java.lang.String value
ListWithAutoConstructFlag<T> instanceIds
ListWithAutoConstructFlag<T> terminatingInstances
java.lang.String networkInterfaceId
ListWithAutoConstructFlag<T> privateIpAddresses
ListWithAutoConstructFlag<T> instanceIds
ListWithAutoConstructFlag<T> instanceMonitorings
java.lang.String userId
java.lang.String groupName
java.lang.String groupId
java.lang.String volumeId
java.lang.Integer size
java.lang.String snapshotId
java.lang.String availabilityZone
java.lang.String state
Constraints:
Allowed Values: creating, available, in-use, deleting, error
java.util.Date createTime
ListWithAutoConstructFlag<T> attachments
ListWithAutoConstructFlag<T> tags
java.lang.String volumeType
java.lang.Integer iops
java.lang.String volumeId
java.lang.String instanceId
java.lang.String device
/dev/sdh).java.lang.String state
Constraints:
Allowed Values: attaching, attached, detaching, detached
java.util.Date attachTime
java.lang.Boolean deleteOnTermination
Whether this volume will be deleted or not when the associated instance is terminated.
java.lang.String status
ListWithAutoConstructFlag<T> details
java.lang.String volumeId
java.lang.String availabilityZone
VolumeStatusInfo volumeStatus
ListWithAutoConstructFlag<T> events
ListWithAutoConstructFlag<T> actions
java.lang.String vpcId
java.lang.String state
pending or available.java.lang.String cidrBlock
java.lang.String dhcpOptionsId
default if the default options are
associated with the VPC.ListWithAutoConstructFlag<T> tags
java.lang.String instanceTenancy
java.lang.Boolean isDefault
java.lang.String vpnConnectionId
java.lang.String state
pending, available, deleting,
and deleted.java.lang.String customerGatewayConfiguration
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.
java.lang.String type
java.lang.String customerGatewayId
java.lang.String vpnGatewayId
ListWithAutoConstructFlag<T> tags
ListWithAutoConstructFlag<T> vgwTelemetry
VpnConnectionOptions options
ListWithAutoConstructFlag<T> routes
java.lang.String vpnGatewayId
java.lang.String state
pending, available, deleting,
and deleted.java.lang.String type
java.lang.String availabilityZone
ListWithAutoConstructFlag<T> vpcAttachments
ListWithAutoConstructFlag<T> tags
java.lang.String cacheSecurityGroupName
java.lang.String eC2SecurityGroupName
java.lang.String eC2SecurityGroupOwnerId
java.lang.String cacheClusterId
Endpoint configurationEndpoint
java.lang.String clientDownloadLandingPage
java.lang.String cacheNodeType
java.lang.String engine
java.lang.String engineVersion
java.lang.String cacheClusterStatus
java.lang.Integer numCacheNodes
java.lang.String preferredAvailabilityZone
java.util.Date cacheClusterCreateTime
java.lang.String preferredMaintenanceWindow
PendingModifiedValues pendingModifiedValues
NotificationConfiguration notificationConfiguration
ListWithAutoConstructFlag<T> cacheSecurityGroups
CacheParameterGroupStatus cacheParameterGroup
java.lang.String cacheSubnetGroupName
ListWithAutoConstructFlag<T> cacheNodes
java.lang.Boolean autoMinorVersionUpgrade
ListWithAutoConstructFlag<T> securityGroups
java.lang.String engine
java.lang.String engineVersion
java.lang.String cacheParameterGroupFamily
java.lang.String cacheEngineDescription
java.lang.String cacheEngineVersionDescription
java.lang.String cacheNodeId
java.lang.String cacheNodeStatus
java.util.Date cacheNodeCreateTime
Endpoint endpoint
java.lang.String parameterGroupStatus
java.lang.String parameterName
java.lang.String description
java.lang.String source
java.lang.String dataType
java.lang.String allowedValues
java.lang.Boolean isModifiable
true) or not (false) the
parameter can be modified. Some parameters have security or
operational implications that prevent them from being changed.java.lang.String minimumEngineVersion
ListWithAutoConstructFlag<T> cacheNodeTypeSpecificValues
java.lang.String cacheParameterGroupName
java.lang.String cacheParameterGroupFamily
java.lang.String description
java.lang.String cacheParameterGroupName
java.lang.String parameterApplyStatus
ListWithAutoConstructFlag<T> cacheNodeIdsToReboot
java.lang.String ownerId
java.lang.String cacheSecurityGroupName
java.lang.String description
ListWithAutoConstructFlag<T> eC2SecurityGroups
java.lang.String cacheSecurityGroupName
java.lang.String status
java.lang.String cacheSubnetGroupName
java.lang.String cacheSubnetGroupDescription
java.lang.String vpcId
ListWithAutoConstructFlag<T> subnets
java.lang.String cacheClusterId
Constraints:
Example: mycachecluster
java.lang.Integer numCacheNodes
java.lang.String cacheNodeType
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
java.lang.String engine
java.lang.String engineVersion
java.lang.String cacheParameterGroupName
java.lang.String cacheSubnetGroupName
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
ListWithAutoConstructFlag<T> cacheSecurityGroupNames
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
ListWithAutoConstructFlag<T> securityGroupIds
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
java.lang.String preferredAvailabilityZone
All cache nodes belonging to a cache cluster are placed in the preferred availability zone.
Default: System chosen (random) availability zone.
java.lang.String preferredMaintenanceWindow
Example: sun:05:00-sun:09:00
java.lang.Integer port
java.lang.String notificationTopicArn
java.lang.Boolean autoMinorVersionUpgrade
Default:
true
java.lang.String cacheParameterGroupName
java.lang.String cacheParameterGroupFamily
java.lang.String description
java.lang.String cacheSecurityGroupName
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
Example:
mysecuritygroup
java.lang.String description
java.lang.String cacheSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example:
mysubnetgroup
java.lang.String cacheSubnetGroupDescription
ListWithAutoConstructFlag<T> subnetIds
java.lang.String cacheClusterId
java.lang.Integer maxRecords
Default: 100
Constraints: minimum 20, maximum 100
java.lang.String marker
java.lang.Boolean showCacheNodeInfo
java.lang.String marker
ListWithAutoConstructFlag<T> cacheClusters
java.lang.String engine
java.lang.String engineVersion
Example: 1.4.14
java.lang.String cacheParameterGroupFamily
Constraints:
java.lang.Integer maxRecords
java.lang.String marker
java.lang.Boolean defaultOnly
java.lang.String marker
ListWithAutoConstructFlag<T> cacheEngineVersions
CacheEngineVersion elements.java.lang.String cacheParameterGroupName
java.lang.Integer maxRecords
java.lang.String marker
java.lang.String marker
ListWithAutoConstructFlag<T> cacheParameterGroups
java.lang.String cacheParameterGroupName
java.lang.String source
Valid values: user |
system | engine-default
java.lang.Integer maxRecords
java.lang.String marker
java.lang.String marker
ListWithAutoConstructFlag<T> parameters
ListWithAutoConstructFlag<T> cacheNodeTypeSpecificParameters
java.lang.String cacheSecurityGroupName
java.lang.Integer maxRecords
Default: 100
Constraints: minimum 20, maximum 100
java.lang.String marker
java.lang.String marker
ListWithAutoConstructFlag<T> cacheSecurityGroups
java.lang.String cacheSubnetGroupName
java.lang.Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results may
be retrieved. Default: 100
Constraints: minimum 20, maximum 100
java.lang.String marker
MaxRecords.java.lang.String marker
ListWithAutoConstructFlag<T> cacheSubnetGroups
java.lang.String cacheParameterGroupFamily
java.lang.Integer maxRecords
java.lang.String marker
java.lang.String sourceIdentifier
java.lang.String sourceType
Constraints:
Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
java.util.Date startTime
java.util.Date endTime
java.lang.Integer duration
java.lang.Integer maxRecords
java.lang.String marker
java.lang.String marker
ListWithAutoConstructFlag<T> events
java.lang.String reservedCacheNodesOfferingId
Example:
438012d3-4052-4cc7-b2e3-8d3372e0e706
java.lang.String cacheNodeType
java.lang.String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
java.lang.String productDescription
java.lang.String offeringType
Valid
Values: "Light Utilization" | "Medium Utilization" | "Heavy
Utilization"
java.lang.Integer maxRecords
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
java.lang.String marker
MaxRecords.java.lang.String marker
ListWithAutoConstructFlag<T> reservedCacheNodesOfferings
java.lang.String reservedCacheNodeId
java.lang.String reservedCacheNodesOfferingId
java.lang.String cacheNodeType
java.lang.String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
java.lang.String productDescription
java.lang.String offeringType
Valid
Values: "Light Utilization" | "Medium Utilization" | "Heavy
Utilization"
java.lang.Integer maxRecords
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
java.lang.String marker
MaxRecords.java.lang.String marker
ListWithAutoConstructFlag<T> reservedCacheNodes
java.lang.String status
java.lang.String eC2SecurityGroupName
java.lang.String eC2SecurityGroupOwnerId
java.lang.String cacheParameterGroupFamily
java.lang.String marker
ListWithAutoConstructFlag<T> parameters
ListWithAutoConstructFlag<T> cacheNodeTypeSpecificParameters
java.lang.String sourceIdentifier
java.lang.String sourceType
Constraints:
Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
java.lang.String message
java.util.Date date
java.lang.String cacheClusterId
java.lang.Integer numCacheNodes
ListWithAutoConstructFlag<T> cacheNodeIdsToRemove
ListWithAutoConstructFlag<T> cacheSecurityGroupNames
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".
ListWithAutoConstructFlag<T> securityGroupIds
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).
java.lang.String preferredMaintenanceWindow
java.lang.String notificationTopicArn
java.lang.String cacheParameterGroupName
java.lang.String notificationTopicStatus
java.lang.Boolean applyImmediately
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
java.lang.String engineVersion
java.lang.Boolean autoMinorVersionUpgrade
Default:
true
java.lang.String cacheParameterGroupName
ListWithAutoConstructFlag<T> parameterNameValues
java.lang.String cacheSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example:
mysubnetgroup
java.lang.String cacheSubnetGroupDescription
ListWithAutoConstructFlag<T> subnetIds
java.lang.String parameterName
java.lang.String parameterValue
java.lang.String description
java.lang.String source
java.lang.String dataType
java.lang.String allowedValues
java.lang.Boolean isModifiable
true) or not (false) the
parameter can be modified. Some parameters have security or
operational implications that prevent them from being changed.java.lang.String minimumEngineVersion
java.lang.Integer numCacheNodes
ListWithAutoConstructFlag<T> cacheNodeIdsToRemove
java.lang.String engineVersion
java.lang.String reservedCacheNodesOfferingId
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
java.lang.String reservedCacheNodeId
Example: myreservationID
java.lang.Integer cacheNodeCount
Default: 1
java.lang.String cacheClusterId
ListWithAutoConstructFlag<T> cacheNodeIdsToReboot
java.lang.String reservedCacheNodeId
java.lang.String reservedCacheNodesOfferingId
java.lang.String cacheNodeType
java.util.Date startTime
java.lang.Integer duration
java.lang.Double fixedPrice
java.lang.Double usagePrice
java.lang.Integer cacheNodeCount
java.lang.String productDescription
java.lang.String offeringType
java.lang.String state
ListWithAutoConstructFlag<T> recurringCharges
java.lang.String reservedCacheNodesOfferingId
java.lang.String cacheNodeType
java.lang.Integer duration
java.lang.Double fixedPrice
java.lang.Double usagePrice
java.lang.String productDescription
java.lang.String offeringType
ListWithAutoConstructFlag<T> recurringCharges
java.lang.String cacheParameterGroupName
java.lang.Boolean resetAllParameters
ListWithAutoConstructFlag<T> parameterNameValues
java.lang.String cacheSecurityGroupName
java.lang.String eC2SecurityGroupName
java.lang.String eC2SecurityGroupOwnerId
java.lang.String securityGroupId
java.lang.String status
java.lang.String subnetIdentifier
AvailabilityZone subnetAvailabilityZone
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
java.util.Date dateCreated
java.util.Date dateUpdated
ListWithAutoConstructFlag<T> versions
ListWithAutoConstructFlag<T> configurationTemplates
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
java.lang.String versionLabel
Constraints:
Length: 1 - 100
S3Location sourceBundle
java.util.Date dateCreated
java.util.Date dateUpdated
java.lang.Boolean available
true : The CNAME is available.
true : The CNAME is not
available.
true :
The CNAME is available. false : The CNAME is
not available. java.lang.String fullyQualifiedCNAME
Constraints:
Length: 1 - 255
java.lang.String namespace
java.lang.String name
java.lang.String defaultValue
java.lang.String changeSeverity
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.
java.lang.Boolean userDefined
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
java.lang.String valueType
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
ListWithAutoConstructFlag<T> valueOptions
java.lang.Integer minValue
java.lang.Integer maxValue
java.lang.Integer maxLength
OptionRestrictionRegex regex
java.lang.String solutionStackName
Constraints:
Length: 0 - 100
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String templateName
null, the name of the configuration template for
this configuration set.
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
java.lang.String environmentName
null, the name of the environment for this
configuration set.
Constraints:
Length: 4 - 23
java.lang.String deploymentStatus
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
java.util.Date dateCreated
java.util.Date dateUpdated
ListWithAutoConstructFlag<T> optionSettings
java.lang.String applicationName
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
java.lang.String description
Constraints:
Length: 0 - 200
ApplicationDescription application
java.lang.String applicationName
AutoCreateApplication is false,
returns an InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String versionLabel
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
java.lang.String description
Constraints:
Length: 0 - 200
S3Location sourceBundle
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.
java.lang.Boolean autoCreateApplication
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
ApplicationVersionDescription applicationVersion
java.lang.String applicationName
InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String templateName
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
java.lang.String solutionStackName
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
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.
java.lang.String environmentId
java.lang.String description
Constraints:
Length: 0 - 200
ListWithAutoConstructFlag<T> optionSettings
java.lang.String solutionStackName
Constraints:
Length: 0 - 100
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String templateName
null, the name of the configuration template for
this configuration set.
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
java.lang.String environmentName
null, the name of the environment for this
configuration set.
Constraints:
Length: 4 - 23
java.lang.String deploymentStatus
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
java.util.Date dateCreated
java.util.Date dateUpdated
ListWithAutoConstructFlag<T> optionSettings
java.lang.String applicationName
If no application is found with this name,
CreateEnvironment returns an
InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String versionLabel
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
java.lang.String environmentName
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
java.lang.String templateName
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
java.lang.String solutionStackName
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
java.lang.String cNAMEPrefix
Constraints:
Length: 4 - 63
java.lang.String description
Constraints:
Length: 0 - 200
ListWithAutoConstructFlag<T> optionSettings
ListWithAutoConstructFlag<T> optionsToRemove
java.lang.String environmentName
Constraints:
Length: 4 - 23
java.lang.String environmentId
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String versionLabel
Constraints:
Length: 1 - 100
java.lang.String solutionStackName
SolutionStack deployed with this
environment.
Constraints:
Length: 0 - 100
java.lang.String templateName
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
java.lang.String endpointURL
java.lang.String cNAME
Constraints:
Length: 1 - 255
java.util.Date dateCreated
java.util.Date dateUpdated
java.lang.String status
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
java.lang.String health
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
EnvironmentResourcesDescription resources
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String versionLabel
Constraints:
Length: 1 - 100
java.lang.Boolean deleteSourceBundle
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
ListWithAutoConstructFlag<T> applicationNames
ListWithAutoConstructFlag<T> applications
java.lang.String applicationName
Constraints:
Length: 1 - 100
ListWithAutoConstructFlag<T> versionLabels
ListWithAutoConstructFlag<T> applicationVersions
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String templateName
Constraints:
Length: 1 - 100
java.lang.String environmentName
Constraints:
Length: 4 - 23
java.lang.String solutionStackName
Constraints:
Length: 0 - 100
ListWithAutoConstructFlag<T> options
java.lang.String solutionStackName
Constraints:
Length: 0 - 100
ListWithAutoConstructFlag<T> options
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String templateName
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
java.lang.String environmentName
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
ListWithAutoConstructFlag<T> configurationSettings
java.lang.String environmentId
Condition: You must specify either this or an EnvironmentName, or
both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
java.lang.String environmentName
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
EnvironmentResourceDescription environmentResources
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String versionLabel
Constraints:
Length: 1 - 100
ListWithAutoConstructFlag<T> environmentIds
ListWithAutoConstructFlag<T> environmentNames
java.lang.Boolean includeDeleted
true: Environments that have been deleted after
IncludedDeletedBackTo are displayed.
false: Do not include deleted environments.
java.util.Date includedDeletedBackTo
IncludeDeleted is set to
true, then environments deleted after this date are
displayed.ListWithAutoConstructFlag<T> environments
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String versionLabel
Constraints:
Length: 1 - 100
java.lang.String templateName
Constraints:
Length: 1 - 100
java.lang.String environmentId
java.lang.String environmentName
Constraints:
Length: 4 - 23
java.lang.String requestId
java.lang.String severity
Constraints:
Allowed Values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL
java.util.Date startTime
java.util.Date endTime
EndTime.java.lang.Integer maxRecords
Constraints:
Range: 1 - 1000
java.lang.String nextToken
ListWithAutoConstructFlag<T> events
java.lang.String nextToken
java.lang.String environmentName
Constraints:
Length: 4 - 23
java.lang.String environmentId
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String versionLabel
Constraints:
Length: 1 - 100
java.lang.String solutionStackName
SolutionStack deployed with this
environment.
Constraints:
Length: 0 - 100
java.lang.String templateName
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
java.lang.String endpointURL
java.lang.String cNAME
Constraints:
Length: 1 - 255
java.util.Date dateCreated
java.util.Date dateUpdated
java.lang.String status
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
java.lang.String health
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
EnvironmentResourcesDescription resources
java.lang.String infoType
Constraints:
Allowed Values: tail
java.lang.String ec2InstanceId
java.util.Date sampleTimestamp
java.lang.String message
java.lang.String environmentName
Constraints:
Length: 4 - 23
ListWithAutoConstructFlag<T> autoScalingGroups
AutoScalingGroups used by this environment.ListWithAutoConstructFlag<T> instances
ListWithAutoConstructFlag<T> launchConfigurations
ListWithAutoConstructFlag<T> loadBalancers
ListWithAutoConstructFlag<T> triggers
AutoScaling triggers in use by this environment.LoadBalancerDescription loadBalancer
java.util.Date eventDate
java.lang.String message
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String versionLabel
Constraints:
Length: 1 - 100
java.lang.String templateName
Constraints:
Length: 1 - 100
java.lang.String environmentName
Constraints:
Length: 4 - 23
java.lang.String requestId
java.lang.String severity
Constraints:
Allowed Values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL
ListWithAutoConstructFlag<T> solutionStacks
ListWithAutoConstructFlag<T> solutionStackDetails
java.lang.String loadBalancerName
java.lang.String domain
ListWithAutoConstructFlag<T> listeners
java.lang.String environmentId
Condition: You must specify
either this or an EnvironmentName, or both. If you do not specify
either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
java.lang.String environmentName
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
java.lang.String environmentId
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.
java.lang.String environmentName
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
java.lang.String infoType
Constraints:
Allowed Values: tail
java.lang.String environmentId
Condition:
You must specify either this or an EnvironmentName, or both. If you do
not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
java.lang.String environmentName
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
java.lang.String environmentId
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.
java.lang.String environmentName
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
java.lang.String infoType
Constraints:
Allowed Values: tail
ListWithAutoConstructFlag<T> environmentInfo
java.lang.String solutionStackName
Constraints:
Length: 0 - 100
ListWithAutoConstructFlag<T> permittedFileTypes
java.lang.String sourceEnvironmentId
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.
java.lang.String sourceEnvironmentName
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
java.lang.String destinationEnvironmentId
Condition: You must specify
at least the DestinationEnvironmentID or the
DestinationEnvironmentName. You may also specify both.
You must specify the SourceEnvironmentId with the
DestinationEnvironmentId.
java.lang.String destinationEnvironmentName
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
java.lang.String environmentId
Condition: You must
specify either this or an EnvironmentName, or both. If you do not
specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
java.lang.String environmentName
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
java.lang.Boolean terminateResources
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
java.lang.String environmentName
Constraints:
Length: 4 - 23
java.lang.String environmentId
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String versionLabel
Constraints:
Length: 1 - 100
java.lang.String solutionStackName
SolutionStack deployed with this
environment.
Constraints:
Length: 0 - 100
java.lang.String templateName
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
java.lang.String endpointURL
java.lang.String cNAME
Constraints:
Length: 1 - 255
java.util.Date dateCreated
java.util.Date dateUpdated
java.lang.String status
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
java.lang.String health
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
EnvironmentResourcesDescription resources
java.lang.String applicationName
UpdateApplication returns an
InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String description
Default: If not specified, AWS Elastic Beanstalk does not update the description.
Constraints:
Length: 0 - 200
ApplicationDescription application
java.lang.String applicationName
If no
application is found with this name, UpdateApplication
returns an InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String versionLabel
If no application version is
found with this label, UpdateApplication returns an
InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
ApplicationVersionDescription applicationVersion
java.lang.String applicationName
If no application is found with this name,
UpdateConfigurationTemplate returns an
InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String templateName
If no
configuration template is found with this name,
UpdateConfigurationTemplate returns an
InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
ListWithAutoConstructFlag<T> optionSettings
ListWithAutoConstructFlag<T> optionsToRemove
Constraint: You can remove only UserDefined
configuration options.
java.lang.String solutionStackName
Constraints:
Length: 0 - 100
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String templateName
null, the name of the configuration template for
this configuration set.
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
java.lang.String environmentName
null, the name of the environment for this
configuration set.
Constraints:
Length: 4 - 23
java.lang.String deploymentStatus
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
java.util.Date dateCreated
java.util.Date dateUpdated
ListWithAutoConstructFlag<T> optionSettings
java.lang.String environmentId
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.
java.lang.String environmentName
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
java.lang.String versionLabel
InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String templateName
InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
ListWithAutoConstructFlag<T> optionSettings
ListWithAutoConstructFlag<T> optionsToRemove
java.lang.String environmentName
Constraints:
Length: 4 - 23
java.lang.String environmentId
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String versionLabel
Constraints:
Length: 1 - 100
java.lang.String solutionStackName
SolutionStack deployed with this
environment.
Constraints:
Length: 0 - 100
java.lang.String templateName
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
java.lang.String endpointURL
java.lang.String cNAME
Constraints:
Length: 1 - 255
java.util.Date dateCreated
java.util.Date dateUpdated
java.lang.String status
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
java.lang.String health
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
EnvironmentResourcesDescription resources
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String templateName
Condition: You cannot specify both this and an environment name.
Constraints:
Length: 1 - 100
java.lang.String environmentName
Condition: You cannot specify both this and a configuration template name.
Constraints:
Length: 4 - 23
ListWithAutoConstructFlag<T> optionSettings
ListWithAutoConstructFlag<T> messages
java.lang.String message
java.lang.String severity
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
java.lang.String namespace
java.lang.String optionName
java.lang.String loadBalancerName
ListWithAutoConstructFlag<T> securityGroups
ListWithAutoConstructFlag<T> securityGroups
java.lang.String loadBalancerName
ListWithAutoConstructFlag<T> subnets
ListWithAutoConstructFlag<T> subnets
java.lang.Integer instancePort
Constraints:
Range: 1 - 65535
ListWithAutoConstructFlag<T> policyNames
java.lang.String loadBalancerName
HealthCheck healthCheck
HealthCheck healthCheck
java.lang.String loadBalancerName
java.lang.String policyName
java.lang.String cookieName
java.lang.String loadBalancerName
java.lang.String policyName
java.lang.Long cookieExpirationPeriod
java.lang.String loadBalancerName
ListWithAutoConstructFlag<T> listeners
LoadBalancerPort, InstancePort,
Protocol, and SSLCertificateId items.java.lang.String loadBalancerName
java.lang.String policyName
java.lang.String policyTypeName
ListWithAutoConstructFlag<T> policyAttributes
java.lang.String loadBalancerName
ListWithAutoConstructFlag<T> listeners
ListWithAutoConstructFlag<T> availabilityZones
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.
ListWithAutoConstructFlag<T> subnets
ListWithAutoConstructFlag<T> securityGroups
java.lang.String scheme
java.lang.String loadBalancerName
ListWithAutoConstructFlag<T> loadBalancerPorts
java.lang.String loadBalancerName
ListWithAutoConstructFlag<T> instances
ListWithAutoConstructFlag<T> instances
java.lang.String loadBalancerName
ListWithAutoConstructFlag<T> instances
ListWithAutoConstructFlag<T> instanceStates
java.lang.String loadBalancerName
ListWithAutoConstructFlag<T> policyNames
ListWithAutoConstructFlag<T> policyDescriptions
ListWithAutoConstructFlag<T> policyTypeNames
ListWithAutoConstructFlag<T> policyTypeDescriptions
ListWithAutoConstructFlag<T> loadBalancerNames
java.lang.String marker
ListWithAutoConstructFlag<T> loadBalancerDescriptions
java.lang.String nextMarker
java.lang.String loadBalancerName
ListWithAutoConstructFlag<T> subnets
ListWithAutoConstructFlag<T> subnets
java.lang.String loadBalancerName
ListWithAutoConstructFlag<T> availabilityZones
ListWithAutoConstructFlag<T> availabilityZones
java.lang.String loadBalancerName
ListWithAutoConstructFlag<T> availabilityZones
ListWithAutoConstructFlag<T> availabilityZones
java.lang.String target
TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case a healthcheck simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP or HTTPS protocol, the situation is different. You have to include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target needs to be 1024 16-bit Unicode characters or less.
java.lang.Integer interval
Constraints:
Range: 1 - 300
java.lang.Integer timeout
Constraints:
Range: 1 - 300
java.lang.Integer unhealthyThreshold
Constraints:
Range: 2 - 10
java.lang.Integer healthyThreshold
Constraints:
Range: 2 - 10
java.lang.String instanceId
java.lang.String state
java.lang.String reasonCode
java.lang.String description
java.lang.String policyName
java.lang.Long cookieExpirationPeriod
java.lang.String protocol
java.lang.Integer loadBalancerPort
java.lang.String instanceProtocol
InstanceProtocol has to be at the same
protocol layer, i.e., HTTP or HTTPS. Likewise, if the front-end
protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL. InstancePort whose InstanceProtocol is
secure, i.e., HTTPS or SSL, the listener's
InstanceProtocol has to be secure, i.e., HTTPS or SSL. If
there is another listener with the same InstancePort
whose InstanceProtocol is HTTP or TCP, the listener's
InstanceProtocol must be either HTTP or TCP. java.lang.Integer instancePort
Constraints:
Range: 1 - 65535
java.lang.String sSLCertificateId
Listener listener
ListWithAutoConstructFlag<T> policyNames
java.lang.String loadBalancerName
java.lang.String dNSName
java.lang.String canonicalHostedZoneName
java.lang.String canonicalHostedZoneNameID
ListWithAutoConstructFlag<T> listenerDescriptions
Policies policies
ListWithAutoConstructFlag<T> backendServerDescriptions
ListWithAutoConstructFlag<T> availabilityZones
ListWithAutoConstructFlag<T> subnets
java.lang.String vPCId
ListWithAutoConstructFlag<T> instances
HealthCheck healthCheck
SourceSecurityGroup sourceSecurityGroup
ListWithAutoConstructFlag<T> securityGroups
java.util.Date createdTime
java.lang.String scheme
ListWithAutoConstructFlag<T> appCookieStickinessPolicies
ListWithAutoConstructFlag<T> lBCookieStickinessPolicies
ListWithAutoConstructFlag<T> otherPolicies
java.lang.String attributeName
java.lang.String attributeType
java.lang.String description
java.lang.String defaultValue
java.lang.String cardinality
java.lang.String policyName
java.lang.String policyTypeName
ListWithAutoConstructFlag<T> policyAttributeDescriptions
java.lang.String policyTypeName
java.lang.String description
ListWithAutoConstructFlag<T> policyAttributeTypeDescriptions
java.lang.String loadBalancerName
ListWithAutoConstructFlag<T> instances
ListWithAutoConstructFlag<T> instances
java.lang.String loadBalancerName
java.lang.Integer loadBalancerPort
java.lang.String sSLCertificateId
java.lang.String loadBalancerName
java.lang.Integer instancePort
ListWithAutoConstructFlag<T> policyNames
java.lang.String loadBalancerName
java.lang.Integer loadBalancerPort
ListWithAutoConstructFlag<T> policyNames
java.lang.String ownerAlias
--source-group-user parameter of the
ec2-authorize command in the Amazon EC2 command line
tool.java.lang.String groupName
--source-group parameter of the
ec2-authorize command in the Amazon EC2 command line
tool.ListWithAutoConstructFlag<T> instanceGroups
java.lang.String jobFlowId
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String jobFlowId
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> instanceGroupIds
java.lang.String jobFlowId
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> steps
java.lang.String name
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
ScriptBootstrapActionConfig scriptBootstrapAction
BootstrapActionConfig bootstrapActionConfig
java.util.Date createdAfter
java.util.Date createdBefore
ListWithAutoConstructFlag<T> jobFlowIds
ListWithAutoConstructFlag<T> jobFlowStates
ListWithAutoConstructFlag<T> jobFlows
ListWithAutoConstructFlag<T> properties
java.lang.String jar
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String mainClass
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> args
java.lang.String name
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String market
Constraints:
Allowed Values: ON_DEMAND, SPOT
java.lang.String instanceRole
Constraints:
Allowed Values: MASTER, CORE, TASK
java.lang.String bidPrice
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String instanceType
Constraints:
Length: 1 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer instanceCount
java.lang.String instanceGroupId
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String name
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String market
Constraints:
Allowed Values: ON_DEMAND, SPOT
java.lang.String instanceRole
Constraints:
Allowed Values: MASTER, CORE, TASK
java.lang.String bidPrice
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String instanceType
Constraints:
Length: 1 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer instanceRequestCount
java.lang.Integer instanceRunningCount
java.lang.String state
Constraints:
Allowed Values: PROVISIONING, STARTING, BOOTSTRAPPING, RUNNING, RESIZING, ARRESTED, SHUTTING_DOWN, TERMINATED, FAILED, ENDED
java.lang.String lastStateChangeReason
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
java.util.Date creationDateTime
java.util.Date startDateTime
java.util.Date readyDateTime
java.util.Date endDateTime
java.lang.String jobFlowId
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String name
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String logUri
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String amiVersion
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
JobFlowExecutionStatusDetail executionStatusDetail
JobFlowInstancesDetail instances
ListWithAutoConstructFlag<T> steps
ListWithAutoConstructFlag<T> bootstrapActions
ListWithAutoConstructFlag<T> supportedProducts
java.lang.Boolean visibleToAllUsers
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.java.lang.String jobFlowRole
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String state
Constraints:
Allowed Values: COMPLETED, FAILED, TERMINATED, RUNNING, SHUTTING_DOWN, STARTING, WAITING, BOOTSTRAPPING
java.util.Date creationDateTime
java.util.Date startDateTime
java.util.Date readyDateTime
java.util.Date endDateTime
java.lang.String lastStateChangeReason
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String masterInstanceType
Constraints:
Length: 1 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String slaveInstanceType
Constraints:
Length: 1 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer instanceCount
ListWithAutoConstructFlag<T> instanceGroups
java.lang.String ec2KeyName
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
PlacementType placement
java.lang.Boolean keepJobFlowAliveWhenNoSteps
java.lang.Boolean terminationProtected
java.lang.String hadoopVersion
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String ec2SubnetId
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]*
java.lang.String masterInstanceType
Constraints:
Length: 1 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String masterPublicDnsName
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String masterInstanceId
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String slaveInstanceType
Constraints:
Length: 1 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.Integer instanceCount
ListWithAutoConstructFlag<T> instanceGroups
java.lang.Integer normalizedInstanceHours
java.lang.String ec2KeyName
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String ec2SubnetId
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
PlacementType placement
java.lang.Boolean keepJobFlowAliveWhenNoSteps
java.lang.Boolean terminationProtected
java.lang.String hadoopVersion
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> instanceGroups
java.lang.String name
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String logUri
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String additionalInfo
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String amiVersion
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]*
JobFlowInstancesConfig instances
ListWithAutoConstructFlag<T> steps
ListWithAutoConstructFlag<T> bootstrapActions
ListWithAutoConstructFlag<T> supportedProducts
java.lang.Boolean visibleToAllUsers
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.java.lang.String jobFlowRole
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]*
java.lang.String path
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> args
ListWithAutoConstructFlag<T> jobFlowIds
java.lang.Boolean terminationProtected
ListWithAutoConstructFlag<T> jobFlowIds
java.lang.Boolean visibleToAllUsers
java.lang.String name
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
java.lang.String actionOnFailure
Constraints:
Allowed Values: TERMINATE_JOB_FLOW, CANCEL_AND_WAIT, CONTINUE
HadoopJarStepConfig hadoopJarStep
StepConfig stepConfig
StepExecutionStatusDetail executionStatusDetail
java.lang.String state
Constraints:
Allowed Values: PENDING, RUNNING, CONTINUE, COMPLETED, CANCELLED, FAILED, INTERRUPTED
java.util.Date creationDateTime
java.util.Date startDateTime
java.util.Date endDateTime
java.lang.String lastStateChangeReason
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
ListWithAutoConstructFlag<T> jobFlowIds
java.lang.String codec
AAC.
Constraints:
Pattern: (^AAC$)|(^vorbis$)
java.lang.String sampleRate
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$)
java.lang.String bitRate
Constraints:
Pattern: ^\d{1,3}$
java.lang.String channels
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$)
java.lang.String id
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}$
java.lang.String key
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
java.lang.String thumbnailPattern
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. {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\}.*$)
java.lang.String rotate
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$)
java.lang.String presetId
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}$
java.lang.String segmentDuration
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})?$
ListWithAutoConstructFlag<T> watermarks
java.lang.String name
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
java.lang.String format
Constraints:
Pattern: (^HLSv3$)
ListWithAutoConstructFlag<T> outputKeys
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
java.lang.String pipelineId
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}$
JobInput input
CreateJobOutput output
CreateJobOutput structure.ListWithAutoConstructFlag<T> outputs
Outputs syntax instead of the Output syntax.
Constraints:
Length: 0 - 30
java.lang.String outputKeyPrefix
Constraints:
Length: 1 - 255
ListWithAutoConstructFlag<T> playlists
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
Job job
java.lang.String name
Constraints: Maximum 40 characters.
Constraints:
Length: 1 - 40
java.lang.String inputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
java.lang.String outputBucket
Specify this value when all of the following are true:
OutputBucket, it grants full control over the files only
to the AWS account that owns the role that is specified by
Role.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}$
java.lang.String role
Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$
Notifications notifications
PipelineOutputConfig contentConfig
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.
Grantee object: 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. Grantee object is the
registered email address of an AWS account.Grantee object is one of the following
predefined Amazon S3 groups: AllUsers,
AuthenticatedUsers, or LogDelivery.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.Standard or ReducedRedundancy, that you want
Elastic Transcoder to assign to the video files and playlists that it
stores in your Amazon S3 bucket.PipelineOutputConfig thumbnailConfig
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.
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.Grantee object is
either the canonical user ID for an AWS account or an origin access
identity for an Amazon CloudFront distribution. Grantee object is the
registered email address of an AWS account. Grantee object is one of the following
predefined Amazon S3 groups: AllUsers,
AuthenticatedUsers, or LogDelivery.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. Standard or
ReducedRedundancy, that you want Elastic Transcoder to
assign to the thumbnails that it stores in your Amazon S3 bucket.Pipeline pipeline
java.lang.String name
Constraints:
Length: 1 - 40
java.lang.String description
Constraints:
Length: 0 - 255
java.lang.String container
mp4.
Constraints:
Pattern: (^mp4$)|(^ts$)|(^webm$)
VideoParameters video
AudioParameters audio
Thumbnails thumbnails
Preset preset
java.lang.String warning
java.lang.String id
Constraints:
Pattern: ^\d{13}-\w{6}$
java.lang.String pipelineId
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}$
JobInput input
JobOutput output
ListWithAutoConstructFlag<T> outputs
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.
java.lang.String outputKeyPrefix
OutputKeyPrefix.
Constraints:
Length: 1 - 255
ListWithAutoConstructFlag<T> playlists
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.
java.lang.String status
Submitted,
Progressing, Complete,
Canceled, or Error.
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
java.lang.String key
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
java.lang.String frameRate
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$)
java.lang.String resolution
auto, which causes Elastic Transcoder
to automatically detect the resolution of the input file.
Constraints:
Pattern: (^auto$)|(^\d{1,5}x\d{1,5}$)
java.lang.String aspectRatio
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$)
java.lang.String interlaced
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$)
java.lang.String container
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$)
java.lang.String id
java.lang.String key
OutputBucket object in the pipeline that is specified by
the pipeline ID.
Constraints:
Length: 1 - 255
java.lang.String thumbnailPattern
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. {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\}.*$)
java.lang.String rotate
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$)
java.lang.String presetId
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}$
java.lang.String segmentDuration
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})?$
java.lang.String status
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.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 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.Status is one of the following:
Submitted, Progressing,
Complete, Canceled, or Error.
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
java.lang.String statusDetail
Status.
Constraints:
Length: 0 - 255
java.lang.Long duration
java.lang.Integer width
java.lang.Integer height
ListWithAutoConstructFlag<T> watermarks
Preset for the
current output. Watermarks are added to the output video in the sequence in which you list them in the job output���the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add will cover the first one, the third one will cover the second, and the fourth one will cover the third.
java.lang.String presetWatermarkId
Constraints:
Length: 1 - 40
java.lang.String inputKey
Pipeline; the Input Bucket object in that
pipeline identifies the bucket. If the file name includes a prefix, for example, logos/128x64.png, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.
Constraints:
Length: 1 - 255
Pattern: (^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)
java.lang.String pipelineId
Constraints:
Pattern: ^\d{13}-\w{6}$
java.lang.String ascending
true. To list jobs in reverse
chronological order, enter false.
Constraints:
Pattern: (^true$)|(^false$)
java.lang.String pageToken
pageToken in subsequent GET requests to get
each successive page of results.
Constraints:
Pattern: ^\d{13}-\w{6}$
ListWithAutoConstructFlag<T> jobs
Job objects that are in the specified
pipeline.java.lang.String nextPageToken
NextPageToken is null.
Constraints:
Pattern: ^\d{13}-\w{6}$
java.lang.String status
Submitted, Progressing,
Complete, Canceled, or Error.
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
java.lang.String ascending
true. To list jobs in reverse
chronological order, enter false.
Constraints:
Pattern: (^true$)|(^false$)
java.lang.String pageToken
pageToken in subsequent GET requests to get
each successive page of results.
Constraints:
Pattern: ^\d{13}-\w{6}$
ListWithAutoConstructFlag<T> jobs
Job objects that have the specified status.java.lang.String nextPageToken
NextPageToken is null.
Constraints:
Pattern: ^\d{13}-\w{6}$
ListWithAutoConstructFlag<T> pipelines
Pipeline objects.ListWithAutoConstructFlag<T> presets
Preset objects.java.lang.String progressing
Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)
java.lang.String completed
Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)
java.lang.String warning
Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)
java.lang.String error
Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)
java.lang.String granteeType
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.
Constraints:
Pattern: (^Canonical$)|(^Email$)|(^Group$)
java.lang.String grantee
Constraints:
Length: 1 - 255
ListWithAutoConstructFlag<T> access
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.
Constraints:
Length: 0 - 30
java.lang.String id
Constraints:
Pattern: ^\d{13}-\w{6}$
java.lang.String arn
java.lang.String name
Constraints: Maximum 40 characters
Constraints:
Length: 1 - 40
java.lang.String status
Active: The
pipeline is processing jobs.Paused: The
pipeline is not currently processing jobs.
Constraints:
Pattern: (^Active$)|(^Paused$)
java.lang.String inputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
java.lang.String outputBucket
ContentConfig and
ThumbnailConfig.
Constraints:
Pattern: ^(\w|\.|-){1,255}$
java.lang.String role
Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$
Notifications notifications
PipelineOutputConfig contentConfig
ContentConfig and ThumbnailConfig, or
you specify OutputBucket. 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.PipelineOutputConfig thumbnailConfig
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.
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 thumbnail files.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.java.lang.String bucket
ContentConfig
and ThumbnailConfig instead.
Constraints:
Pattern: ^(\w|\.|-){1,255}$
java.lang.String storageClass
Standard or
ReducedRedundancy, that you want Elastic Transcoder to
assign to the video files and playlists that it stores in your Amazon
S3 bucket.
Constraints:
Pattern: (^ReducedRedundancy$)|(^Standard$)
ListWithAutoConstructFlag<T> permissions
Permissions object specifies which users
and/or predefined Amazon S3 groups you want to have access to
transcoded files and playlists, 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. If you include
Permissions, Elastic Transcoder grants only the
permissions that you specify. It does not grant full permissions to
the owner of the role specified by Role. If you want that
user to have full control, you must explicitly grant full control to
the user.
If you omit Permissions, Elastic Transcoder
grants full control over the transcoded files and playlists to the
owner of the role specified by Role, and grants no other
permissions to any other user or group.
Constraints:
Length: 0 - 30
java.lang.String name
Name objects must be
unique. Note: 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
java.lang.String format
HLSv3.
Constraints:
Pattern: (^HLSv3$)
ListWithAutoConstructFlag<T> outputKeys
SegmentDuration for all of the outputs must be the same.
Constraints:
Length: 0 - 30
java.lang.String status
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
java.lang.String statusDetail
Constraints:
Length: 0 - 255
java.lang.String id
Constraints:
Pattern: ^\d{13}-\w{6}$
java.lang.String name
Constraints:
Length: 1 - 40
java.lang.String description
Constraints:
Length: 0 - 255
java.lang.String container
mp4.
Constraints:
Pattern: (^mp4$)|(^ts$)|(^webm$)
AudioParameters audio
VideoParameters video
Thumbnails thumbnails
java.lang.String type
System) or a preset that you have defined
(Custom).
Constraints:
Pattern: (^System$)|(^Custom$)
java.lang.String id
Id can be up to 40 characters long.
Constraints:
Length: 1 - 40
java.lang.String maxWidth
MaxWidth.Target to specify whether you want Elastic
Transcoder to include the black bars that are added by Elastic
Transcoder, if any, in the calculation.MaxWidth.
Constraints:
Pattern: (^\d{1,3}([.]\d{0,5})?%$)|(^\d{2,4}?px$)
java.lang.String maxHeight
MaxHeight.Target to specify whether you want Elastic
Transcoder to include the black bars that are added by Elastic
Transcoder, if any, in the calculation.MaxHeight.
Constraints:
Pattern: (^\d{1,3}([.]\d{0,5})?%$)|(^\d{2,4}?px$)
java.lang.String sizingPolicy
MaxWidth or
MaxHeight without exceeding the other value.MaxWidth and
MaxHeight. If the relative proportions of the watermark
and the values of MaxWidth and MaxHeight are
different, the watermark will be distorted.MaxWidth and MaxHeight without
exceeding either value. If you specify this option, Elastic Transcoder
does not scale the watermark up.
Constraints:
Pattern: (^Fit$)|(^Stretch$)|(^ShrinkToFit$)
java.lang.String horizontalAlign
HorizontalOffset:
Constraints:
Pattern: (^Left$)|(^Right$)|(^Center$)
java.lang.String horizontalOffset
HorizontalAlign and 5px for
HorizontalOffset, the left side of the watermark appears
5 pixels from the left border of the output video.
HorizontalOffset is only valid when the value of
HorizontalAlign is Left or
Right. If you specify an offset that causes the watermark
to extend beyond the left or right border and Elastic Transcoder has
not added black bars, the watermark is cropped. If Elastic Transcoder
has added black bars, the watermark extends into the black bars. If
the watermark extends beyond the black bars, it is cropped.
Use the
value of Target to specify whether you want to include
the black bars that are added by Elastic Transcoder, if any, in the
offset calculation.
Constraints:
Pattern: (^\d{1,3}([.]\d{0,5})?%$)|(^\d{2,4}?px$)
java.lang.String verticalAlign
VerticalOffset:
Constraints:
Pattern: (^Top$)|(^Bottom$)|(^Center$)
java.lang.String verticalOffset
VerticalOffset The amount by which you want the vertical position of the watermark to be offset from the position specified by VerticalAlign:
MaxHeight.Top for VerticalAlign and 5px
for VerticalOffset, the top of the watermark appears 5
pixels from the top border of the output video.
VerticalOffset is only valid when the value of
VerticalAlign is Top or Bottom.
If you specify an offset that causes the watermark to extend beyond the top or bottom border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped.
Use the value of Target to specify whether
you want Elastic Transcoder to include the black bars that are added
by Elastic Transcoder, if any, in the offset calculation.
Constraints:
Pattern: (^\d{1,3}([.]\d{0,5})?%$)|(^\d{2,4}?px$)
java.lang.String opacity
Opacity
is float. Elastic Transcoder supports transparent .png graphics. If
you use a transparent .png, the transparent portion of the video
appears as if you had specified a value of 0 for Opacity.
The .jpg file format doesn't support transparency.
Constraints:
Pattern: ^\d{1,3}([.]\d{0,20})?$
java.lang.String target
HorizontalOffset,
VerticalOffset, MaxWidth, and
MaxHeight: HorizontalOffset and VerticalOffset values
are calculated based on the borders of the video excluding black bars
added by Elastic Transcoder, if any. In addition,
MaxWidth and MaxHeight, if specified as a
percentage, are calculated based on the borders of the video excluding
black bars added by Elastic Transcoder, if any.HorizontalOffset and VerticalOffset values
are calculated based on the borders of the video including black bars
added by Elastic Transcoder, if any.MaxWidth and MaxHeight, if specified as a
percentage, are calculated based on the borders of the video including
black bars added by Elastic Transcoder, if any.
Constraints:
Pattern: (^Content$)|(^Frame$)
Job job
Pipeline pipeline
Preset preset
java.lang.String role
Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$
java.lang.String inputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
java.lang.String outputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
ListWithAutoConstructFlag<T> topics
Constraints:
Length: 0 - 30
java.lang.String success
true;
otherwise, the value is false.
Constraints:
Pattern: (^true$)|(^false$)
ListWithAutoConstructFlag<T> messages
Success element contains false, this
value is an array of one or more error messages that were generated
during the test process.java.lang.String format
jpg
and png. You specify whether you want Elastic Transcoder to create thumbnails when you create a job.
Constraints:
Pattern: (^jpg$)|(^png$)
java.lang.String interval
Constraints:
Pattern: ^\d{1,5}$
java.lang.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}$
java.lang.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$)
java.lang.String maxWidth
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
java.lang.String maxHeight
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
java.lang.String sizingPolicy
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$)
java.lang.String paddingPolicy
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$)
java.lang.String id
Constraints:
Pattern: ^\d{13}-\w{6}$
Notifications notifications
Pipeline pipeline
java.lang.String id
Constraints:
Pattern: ^\d{13}-\w{6}$
java.lang.String name
Constraints: Maximum 40 characters
Constraints:
Length: 1 - 40
java.lang.String inputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
java.lang.String role
Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$
Notifications notifications
PipelineOutputConfig contentConfig
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.
Grantee object: 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. Grantee object is the
registered email address of an AWS account.Grantee object is one of the following
predefined Amazon S3 groups: AllUsers,
AuthenticatedUsers, or LogDelivery.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.Standard or ReducedRedundancy, that you want
Elastic Transcoder to assign to the video files and playlists that it
stores in your Amazon S3 bucket.PipelineOutputConfig thumbnailConfig
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.
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.Grantee object is
either the canonical user ID for an AWS account or an origin access
identity for an Amazon CloudFront distribution. Grantee object is the
registered email address of an AWS account. Grantee object is one of the following
predefined Amazon S3 groups: AllUsers,
AuthenticatedUsers, or LogDelivery.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. Standard or
ReducedRedundancy, that you want Elastic Transcoder to
assign to the thumbnails that it stores in your Amazon S3 bucket.Pipeline pipeline
java.lang.String id
Constraints:
Pattern: ^\d{13}-\w{6}$
java.lang.String status
Active: The
pipeline is processing jobs.Paused: The
pipeline is not currently processing jobs.
Constraints:
Pattern: (^Active$)|(^Paused$)
Pipeline pipeline
java.lang.String codec
H.264 and vp8. You can only specify
vp8 when the container type is webm.
Constraints:
Pattern: (^H\.264$)|(^vp8$)
java.util.Map<K,V> codecOptions
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 (H.264 Only)
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 (H.264 Only)
Applicable only when the value of Video:Codec is H.264. 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 either
MaxWidth and MaxHeight, or Resolution. Maximum decoded picture
buffer in macroblocks depends on the value of the
Level object. See the list below. (A macroblock is a
block of pixels measuring 16x16.)
MaxBitRate
The maximum number
of bits per second in a video buffer; the size of the buffer is
specified by BufferSize. Specify a value between 16 and
62,500. You can reduce the bandwidth required to stream a video by
reducing the maximum bit rate, but this also reduces the quality of
the video.
BufferSize
The maximum number of bits in any
x seconds of the output video. This window is commonly 10 seconds, the
standard segment duration when you���re using MPEG-TS for the
container type of the output video. Specify an integer greater than 0.
If you specify MaxBitRate and omit
BufferSize, Elastic Transcoder sets
BufferSize to 10 times the value of
MaxBitRate.
Constraints:
Length: 0 - 30
java.lang.String keyframesMaxDist
Constraints:
Pattern: ^\d{1,6}$
java.lang.String fixedGOP
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$)
java.lang.String bitRate
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)
Constraints:
Pattern: (^\d{2,5}$)|(^auto$)
java.lang.String frameRate
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:
The maximum recommended decoding speed in Luma samples/second for each level is described in the following list (Level - Decoding speed):
Constraints:
Pattern: (^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^60$)
java.lang.String maxFrameRate
auto for FrameRate, Elastic
Transcoder uses the frame rate of the input video for the frame rate
of the output video. Specify the maximum frame rate that you want
Elastic Transcoder to use when the frame rate of the input video is
greater than the desired maximum frame rate of the output video. Valid
values include: 10, 15, 23.97,
24, 25, 29.97, 30,
60.
Constraints:
Pattern: (^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^60$)
java.lang.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:
Constraints:
Pattern: (^auto$)|(^\d{1,5}x\d{1,5}$)
java.lang.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$)
java.lang.String maxWidth
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}$)
java.lang.String maxHeight
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}$)
java.lang.String displayAspectRatio
Constraints:
Pattern: (^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)
java.lang.String sizingPolicy
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$)
java.lang.String paddingPolicy
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$)
ListWithAutoConstructFlag<T> watermarks
Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.
When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions.
java.lang.String accountId
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.java.lang.String vaultName
java.lang.String uploadId
java.lang.String accountId
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.java.lang.String vaultName
java.lang.String uploadId
java.lang.String archiveSize
java.lang.String checksum
java.lang.String location
java.lang.String checksum
java.lang.String archiveId
java.lang.String accountId
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.java.lang.String vaultName
java.lang.String accountId
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.java.lang.String vaultName
java.lang.String archiveId
java.lang.String accountId
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.java.lang.String vaultName
java.lang.String accountId
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.java.lang.String vaultName
java.lang.String accountId
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.java.lang.String vaultName
java.lang.String jobId
java.lang.String jobId
java.lang.String jobDescription
java.lang.String action
Constraints:
Allowed Values: ArchiveRetrieval, InventoryRetrieval
java.lang.String archiveId
java.lang.String vaultARN
java.lang.String creationDate
java.lang.Boolean completed
java.lang.String statusCode
Constraints:
Allowed Values: InProgress, Succeeded, Failed
java.lang.String statusMessage
java.lang.Long archiveSizeInBytes
java.lang.Long inventorySizeInBytes
java.lang.String sNSTopic
java.lang.String completionDate
java.lang.String sHA256TreeHash
java.lang.String archiveSHA256TreeHash
java.lang.String retrievalByteRange
java.lang.String vaultARN
java.lang.String vaultName
java.lang.String creationDate
java.lang.String lastInventoryDate
java.lang.Long numberOfArchives
null if an inventory has not yet
run on the vault, for example, if you just created the vault.java.lang.Long sizeInBytes
java.lang.String accountId
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.java.lang.String vaultName
java.lang.String vaultARN
java.lang.String vaultName
java.lang.String creationDate
java.lang.String lastInventoryDate
java.lang.Long numberOfArchives
null if an inventory has not yet
run on the vault, for example, if you just created the vault.java.lang.Long sizeInBytes
java.lang.String accountId
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.java.lang.String vaultName
java.lang.String jobId
java.lang.String range
java.io.InputStream body
java.lang.String checksum
java.lang.Integer status
java.lang.String contentRange
java.lang.String acceptRanges
java.lang.String contentType
java.lang.String archiveDescription
java.lang.String accountId
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.java.lang.String vaultName
VaultNotificationConfig vaultNotificationConfig
java.lang.String jobId
java.lang.String jobDescription
java.lang.String action
Constraints:
Allowed Values: ArchiveRetrieval, InventoryRetrieval
java.lang.String archiveId
java.lang.String vaultARN
java.lang.String creationDate
java.lang.Boolean completed
java.lang.String statusCode
Constraints:
Allowed Values: InProgress, Succeeded, Failed
java.lang.String statusMessage
java.lang.Long archiveSizeInBytes
java.lang.Long inventorySizeInBytes
java.lang.String sNSTopic
java.lang.String completionDate
java.lang.String sHA256TreeHash
java.lang.String archiveSHA256TreeHash
java.lang.String retrievalByteRange
java.lang.String accountId
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.java.lang.String vaultName
JobParameters jobParameters
java.lang.String accountId
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.java.lang.String vaultName
java.lang.String archiveDescription
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).
java.lang.String partSize
java.lang.String format
java.lang.String type
java.lang.String archiveId
Type is set to archive-retrieval. An
error occurs if you specify this request parameter for an inventory
retrieval job request.java.lang.String description
java.lang.String sNSTopic
java.lang.String retrievalByteRange
java.lang.String accountId
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.java.lang.String vaultName
java.lang.String limit
java.lang.String marker
java.lang.String statuscode
java.lang.String completed
true or false.ListWithAutoConstructFlag<T> jobList
java.lang.String marker
null.java.lang.String accountId
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.java.lang.String vaultName
java.lang.String uploadIdMarker
java.lang.String limit
ListWithAutoConstructFlag<T> uploadsList
java.lang.String marker
null.java.lang.String accountId
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.java.lang.String vaultName
java.lang.String uploadId
java.lang.String marker
java.lang.String limit
java.lang.String multipartUploadId
java.lang.String vaultARN
java.lang.String archiveDescription
java.lang.Long partSizeInBytes
java.lang.String creationDate
ListWithAutoConstructFlag<T> parts
java.lang.String marker
null.java.lang.String accountId
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.java.lang.String marker
java.lang.String limit
ListWithAutoConstructFlag<T> vaultList
java.lang.String marker
java.lang.String accountId
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.java.lang.String vaultName
VaultNotificationConfig vaultNotificationConfig
java.lang.Long contentLength
java.lang.String vaultName
java.lang.String accountId
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.java.lang.String archiveDescription
java.lang.String checksum
java.io.InputStream body
java.lang.String location
java.lang.String checksum
java.lang.String archiveId
java.lang.String multipartUploadId
java.lang.String vaultARN
java.lang.String archiveDescription
java.lang.Long partSizeInBytes
java.lang.String creationDate
java.lang.String accountId
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.java.lang.String vaultName
java.lang.String uploadId
java.lang.String checksum
java.lang.String range
java.io.InputStream body
java.lang.String sNSTopic
ListWithAutoConstructFlag<T> events
java.lang.String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String accessKeyId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String status
Active means the key is
valid for API calls, while Inactive means it is not.
Constraints:
Allowed Values: Active, Inactive
java.lang.String secretAccessKey
java.util.Date createDate
java.lang.String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String accessKeyId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String status
Active means the key is
valid for API calls, while Inactive means it is not.
Constraints:
Allowed Values: Active, Inactive
java.util.Date createDate
AccessKey accessKey
java.lang.String path
This parameter is optional. If it is not included, it defaults to a slash (/).
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
java.lang.String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
Group group
java.lang.String instanceProfileName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String path
This parameter is optional. If it is not included, it defaults to a slash (/).
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
InstanceProfile instanceProfile
LoginProfile loginProfile
java.lang.String path
This parameter is optional. If it is not included, it defaults to a slash (/).
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
java.lang.String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String assumeRolePolicyDocument
Constraints:
Length: 1 - 131072
Pattern: [
-ÿ]+
Role role
java.lang.String path
This parameter is optional. If it is not included, it defaults to a slash (/).
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
java.lang.String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
User user
java.lang.String path
This parameter is optional. If it is not included, it defaults to a slash (/).
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
java.lang.String virtualMFADeviceName
Constraints:
Length: 1 -
Pattern: [\w+=,.@-]*
VirtualMFADevice virtualMFADevice
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String serialNumber
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String accessKeyId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String serialNumber
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
java.lang.String authenticationCode1
Constraints:
Length: 6 - 6
Pattern: [\d]*
java.lang.String authenticationCode2
Constraints:
Length: 6 - 6
Pattern: [\d]*
PasswordPolicy passwordPolicy
This data type is used as a response element in the action GetAccountPasswordPolicy.
java.util.Map<K,V> summaryMap
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
java.lang.String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [
-ÿ]+
java.lang.String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String marker
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.Integer maxItems
IsTruncated
response element is true.
Constraints:
Range: 1 - 1000
Group group
ListWithAutoConstructFlag<T> users
java.lang.Boolean isTruncated
Marker request parameter to retrieve
more user names in the list.java.lang.String marker
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: [ -ÿ]*
InstanceProfile instanceProfile
LoginProfile loginProfile
java.lang.String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [
-ÿ]+
Role role
ServerCertificate serverCertificate
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [
-ÿ]+
User user
java.lang.String path
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
java.lang.String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String groupId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String arn
Constraints:
Length: 20 - 2048
java.util.Date createDate
java.lang.String path
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
java.lang.String instanceProfileName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String instanceProfileId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String arn
Constraints:
Length: 20 - 2048
java.util.Date createDate
ListWithAutoConstructFlag<T> roles
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String marker
Marker element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.Integer maxItems
IsTruncated response element is true.
Constraints:
Range: 1 - 1000
ListWithAutoConstructFlag<T> accessKeyMetadata
java.lang.Boolean isTruncated
Marker request parameter to retrieve more keys
in the list.java.lang.String marker
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: [ -ÿ]*
java.lang.String marker
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.Integer maxItems
IsTruncated response element is true.
Constraints:
Range: 1 - 1000
ListWithAutoConstructFlag<T> accountAliases
java.lang.Boolean isTruncated
Marker request parameter to retrieve
more account aliases in the list.java.lang.String marker
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String marker
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.Integer maxItems
IsTruncated response element is true.
Constraints:
Range: 1 - 1000
ListWithAutoConstructFlag<T> policyNames
java.lang.Boolean isTruncated
Marker request parameter to retrieve
more policy names in the list.java.lang.String marker
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: [ -ÿ]*
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String marker
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.Integer maxItems
IsTruncated response
element is true.
Constraints:
Range: 1 - 1000
ListWithAutoConstructFlag<T> groups
java.lang.Boolean isTruncated
Marker request parameter to retrieve more
groups in the list.java.lang.String marker
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: [ -ÿ]*
java.lang.String pathPrefix
/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: /[!-]*
java.lang.String marker
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.Integer maxItems
IsTruncated response
element is true.
Constraints:
Range: 1 - 1000
ListWithAutoConstructFlag<T> groups
java.lang.Boolean isTruncated
Marker request parameter to retrieve more
groups in the list.java.lang.String marker
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: [ -ÿ]*
java.lang.String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String marker
Marker element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.Integer maxItems
IsTruncated response element is true.
Constraints:
Range: 1 - 1000
ListWithAutoConstructFlag<T> instanceProfiles
java.lang.Boolean isTruncated
Marker request parameter to
retrieve more instance profiles in the list.java.lang.String marker
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: [ -ÿ]*
java.lang.String pathPrefix
/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: /[!-]*
java.lang.String marker
Marker element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.Integer maxItems
IsTruncated response element is true.
Constraints:
Range: 1 - 1000
ListWithAutoConstructFlag<T> instanceProfiles
java.lang.Boolean isTruncated
Marker request parameter to
retrieve more instance profiles in the list.java.lang.String marker
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: [ -ÿ]*
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String marker
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.Integer maxItems
IsTruncated
response element is true.
Constraints:
Range: 1 - 1000
ListWithAutoConstructFlag<T> mFADevices
java.lang.Boolean isTruncated
Marker request parameter to retrieve
more MFA devices in the list.java.lang.String marker
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: [ -ÿ]*
java.lang.String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String marker
Marker element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.Integer maxItems
IsTruncated response element is true.
Constraints:
Range: 1 - 1000
ListWithAutoConstructFlag<T> policyNames
java.lang.Boolean isTruncated
Marker request parameter to retrieve
more policy names in the list.java.lang.String marker
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: [ -ÿ]*
java.lang.String pathPrefix
/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: /[!-]*
java.lang.String marker
Marker element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.Integer maxItems
IsTruncated response element is true.
Constraints:
Range: 1 - 1000
ListWithAutoConstructFlag<T> roles
java.lang.Boolean isTruncated
Marker request parameter to retrieve more roles
in the list.java.lang.String marker
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: [ -ÿ]*
java.lang.String pathPrefix
/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: /[!-]*
java.lang.String marker
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.Integer maxItems
IsTruncated response element will be set to
true.
Constraints:
Range: 1 - 1000
ListWithAutoConstructFlag<T> serverCertificateMetadataList
java.lang.Boolean isTruncated
Marker request parameter to
retrieve more server certificates in the list.java.lang.String marker
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: [ -ÿ]*
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String marker
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.Integer maxItems
IsTruncated response element is true.
Constraints:
Range: 1 - 1000
ListWithAutoConstructFlag<T> certificates
java.lang.Boolean isTruncated
Marker request parameter to retrieve
more certificates in the list.java.lang.String marker
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: [ -ÿ]*
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String marker
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.Integer maxItems
IsTruncated response element is true.
Constraints:
Range: 1 - 1000
ListWithAutoConstructFlag<T> policyNames
java.lang.Boolean isTruncated
Marker request parameter to retrieve
more policy names in the list.java.lang.String marker
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: [ -ÿ]*
java.lang.String pathPrefix
/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: /[!-]*
java.lang.String marker
Marker element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.Integer maxItems
IsTruncated response element is true.
Constraints:
Range: 1 - 1000
ListWithAutoConstructFlag<T> users
java.lang.Boolean isTruncated
Marker request parameter to retrieve
more users in the list.java.lang.String marker
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: [ -ÿ]*
java.lang.String assignmentStatus
AssignmentStatus, the action defaults to
Any which lists both assigned and unassigned virtual MFA
devices.
Constraints:
Allowed Values: Assigned, Unassigned, Any
java.lang.String marker
Marker element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
java.lang.Integer maxItems
IsTruncated response element is true.
Constraints:
Range: 1 - 1000
ListWithAutoConstructFlag<T> virtualMFADevices
java.lang.Boolean isTruncated
Marker request parameter to retrieve more items
the list.java.lang.String marker
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: [ -ÿ]*
java.lang.String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String serialNumber
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
java.util.Date enableDate
java.lang.Integer minimumPasswordLength
Constraints:
Range: 6 - 128
java.lang.Boolean requireSymbols
java.lang.Boolean requireNumbers
java.lang.Boolean requireUppercaseCharacters
java.lang.Boolean requireLowercaseCharacters
java.lang.Boolean allowUsersToChangePassword
java.lang.String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [
-ÿ]+
java.lang.String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [
-ÿ]+
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [
-ÿ]+
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String serialNumber
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
java.lang.String authenticationCode1
Constraints:
Length: 6 - 6
Pattern: [\d]*
java.lang.String authenticationCode2
Constraints:
Length: 6 - 6
Pattern: [\d]*
java.lang.String path
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
java.lang.String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String roleId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String arn
Constraints:
Length: 20 - 2048
java.util.Date createDate
java.lang.String assumeRolePolicyDocument
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: [
-ÿ]+
ServerCertificateMetadata serverCertificateMetadata
java.lang.String certificateBody
Constraints:
Length: 1 - 16384
Pattern: [
-ÿ]+
java.lang.String certificateChain
Constraints:
Length: 1 - 2097152
Pattern: [
-ÿ]*
java.lang.String path
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
java.lang.String serverCertificateName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String serverCertificateId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String arn
Constraints:
Length: 20 - 2048
java.util.Date uploadDate
java.lang.String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String certificateId
Constraints:
Length: 24 - 128
Pattern: [\w]*
java.lang.String certificateBody
Constraints:
Length: 1 - 16384
Pattern: [
-ÿ]+
java.lang.String status
Active means the
key is valid for API calls, while Inactive means it is
not.
Constraints:
Allowed Values: Active, Inactive
java.util.Date uploadDate
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String accessKeyId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String status
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
java.lang.Integer minimumPasswordLength
java.lang.Boolean requireSymbols
java.lang.Boolean requireNumbers
java.lang.Boolean requireUppercaseCharacters
java.lang.Boolean requireLowercaseCharacters
java.lang.Boolean allowUsersToChangePassword
java.lang.String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String newPath
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
java.lang.String newGroupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String serverCertificateName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String newPath
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
java.lang.String newServerCertificateName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String certificateId
Constraints:
Length: 24 - 128
Pattern: [\w]*
java.lang.String status
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
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String newPath
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
java.lang.String newUserName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String path
This parameter is optional. If it is not included, it defaults to a slash (/).
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
java.lang.String serverCertificateName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String certificateBody
Constraints:
Length: 1 - 16384
Pattern: [
-ÿ]+
java.lang.String privateKey
Constraints:
Length: 1 - 16384
Pattern: [
-ÿ]*
java.lang.String certificateChain
Constraints:
Length: 1 - 2097152
Pattern: [
-ÿ]*
ServerCertificateMetadata serverCertificateMetadata
SigningCertificate certificate
java.lang.String path
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
java.lang.String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String userId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String arn
Constraints:
Length: 20 - 2048
java.util.Date createDate
java.lang.String serialNumber
VirtualMFADevice.
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
java.nio.ByteBuffer base32StringSeed
Base32StringSeed is
Base64-encoded.java.nio.ByteBuffer qRCodePNG
Base32String is Base64-encoded.User user
This data type is used as a response element in the following actions:
java.util.Date enableDate
java.lang.String jobType
Constraints:
Allowed Values: Import, Export
java.lang.String manifest
java.lang.String manifestAddendum
java.lang.Boolean validateOnly
java.lang.String jobId
java.lang.String jobType
Constraints:
Allowed Values: Import, Export
java.lang.String awsShippingAddress
java.lang.String signature
java.lang.String signatureFileContents
java.lang.String warningMessage
java.lang.String jobId
java.lang.String jobType
Constraints:
Allowed Values: Import, Export
java.lang.String awsShippingAddress
java.lang.String locationCode
java.lang.String locationMessage
java.lang.String progressCode
java.lang.String progressMessage
java.lang.String carrier
java.lang.String trackingNumber
java.lang.String logBucket
java.lang.String logKey
java.lang.Integer errorCount
java.lang.String signature
java.lang.String signatureFileContents
java.lang.String currentManifest
java.util.Date creationDate
java.lang.String jobId
java.util.Date creationDate
java.lang.Boolean isCanceled
java.lang.String jobType
Constraints:
Allowed Values: Import, Export
java.lang.Integer maxJobs
java.lang.String marker
ListWithAutoConstructFlag<T> jobs
java.lang.Boolean isTruncated
java.lang.String jobId
java.lang.String manifest
java.lang.String jobType
Constraints:
Allowed Values: Import, Export
java.lang.Boolean validateOnly
java.lang.String appId
java.lang.String stackId
java.lang.String shortname
java.lang.String name
java.lang.String description
java.lang.String type
Constraints:
Allowed Values: rails, php, nodejs, static, other
Source appSource
Source object that describes the app repository.ListWithAutoConstructFlag<T> domains
'www.example.com, example.com'java.lang.Boolean enableSsl
SslConfiguration sslConfiguration
SslConfiguration object with the SSL configuration.java.util.Map<K,V> attributes
java.lang.String createdAt
java.lang.Integer instanceCount
java.lang.Integer thresholdsWaitTime
Constraints:
Range: 1 - 100
java.lang.Integer ignoreMetricsTime
IgnoreMetricsTime allows you to direct
AWS OpsWorks to not raise any scaling events long enough to get the
new instances online.
Constraints:
Range: 1 - 100
java.lang.Double cpuThreshold
java.lang.Double memoryThreshold
java.lang.Double loadThreshold
java.lang.String sourceStackId
java.lang.String name
java.lang.String region
java.util.Map<K,V> attributes
java.lang.String serviceRoleArn
java.lang.String defaultInstanceProfileArn
java.lang.String defaultOs
Amazon
Linux or Ubuntu 12.04 LTSCustomThe default option is Amazon
Linux. If you set this parameter to Custom, you
must use the CreateInstance action's AmiId parameter to specify
the custom AMI that you want to use. For more information on the
standard operating systems, see Operating
SystemsFor more information on how to use custom AMIs with
OpsWorks, see Using
Custom AMIs.
java.lang.String hostnameTheme
HostnameTheme is set to Layer_Dependent, which
creates host names by appending integers to the layer's short name.
The other themes are: To obtain a generated host name, call
GetHostNameSuggestion, which returns a host name based on
the current theme.
java.lang.String defaultAvailabilityZone
java.lang.String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}" For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON
StackConfigurationManager configurationManager
java.lang.Boolean useCustomCookbooks
Source customCookbooksSource
java.lang.String defaultSshKeyName
java.lang.Boolean clonePermissions
ListWithAutoConstructFlag<T> cloneAppIds
java.lang.String defaultRootDeviceType
Constraints:
Allowed Values: ebs, instance-store
java.lang.String commandId
java.lang.String instanceId
java.lang.String deploymentId
java.lang.String createdAt
java.lang.String acknowledgedAt
java.lang.String completedAt
java.lang.String status
java.lang.Integer exitCode
java.lang.String logUrl
java.lang.String type
java.lang.String stackId
java.lang.String shortname
java.lang.String name
java.lang.String description
java.lang.String type
Constraints:
Allowed Values: rails, php, nodejs, static, other
Source appSource
Source object that specifies the app repository.ListWithAutoConstructFlag<T> domains
'www.example.com, example.com'java.lang.Boolean enableSsl
SslConfiguration sslConfiguration
SslConfiguration object with the SSL configuration.java.util.Map<K,V> attributes
java.lang.String stackId
java.lang.String appId
ListWithAutoConstructFlag<T> instanceIds
DeploymentCommand command
DeploymentCommand object that specifies the deployment
command and any associated arguments.java.lang.String comment
java.lang.String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}" For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
java.lang.String stackId
ListWithAutoConstructFlag<T> layerIds
java.lang.String instanceType
java.lang.String autoScalingType
Constraints:
Allowed Values: load, timer
java.lang.String hostname
java.lang.String os
Amazon
Linux or Ubuntu 12.04 LTSCustomThe default option is Amazon
Linux. If you set this parameter to Custom, you
must use the CreateInstance action's AmiId parameter to specify
the custom AMI that you want to use. For more information on the
standard operating systems, see Operating
SystemsFor more information on how to use custom AMIs with
OpsWorks, see Using
Custom AMIs.
java.lang.String amiId
java.lang.String sshKeyName
java.lang.String availabilityZone
java.lang.String architecture
Constraints:
Allowed Values: x86_64, i386
java.lang.String rootDeviceType
Constraints:
Allowed Values: ebs, instance-store
java.lang.Boolean installUpdatesOnBoot
true. To control
when updates are installed, set this value to false. You
must then update your instances manually by using
CreateDeployment to run the update_dependencies
stack command or manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances. true, to ensure that
your instances have the latest security updates.java.lang.String stackId
java.lang.String type
Constraints:
Allowed Values: lb, web, php-app, rails-app, nodejs-app, memcached, db-master, monitoring-master, custom
java.lang.String name
java.lang.String shortname
java.util.Map<K,V> attributes
java.lang.String customInstanceProfileArn
ListWithAutoConstructFlag<T> customSecurityGroupIds
ListWithAutoConstructFlag<T> packages
Package objects that describe the layer
packages.ListWithAutoConstructFlag<T> volumeConfigurations
VolumeConfigurations object that describes the layer
Amazon EBS volumes.java.lang.Boolean enableAutoHealing
java.lang.Boolean autoAssignElasticIps
Recipes customRecipes
LayerCustomRecipes object that specifies the layer
custom recipes.java.lang.Boolean installUpdatesOnBoot
true. To control
when updates are installed, set this value to false. You
must then update your instances manually by using
CreateDeployment to run the update_dependencies
stack command or manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances. true, to ensure that
your instances have the latest security updates.java.lang.String name
java.lang.String region
java.util.Map<K,V> attributes
java.lang.String serviceRoleArn
java.lang.String defaultInstanceProfileArn
java.lang.String defaultOs
Amazon
Linux or Ubuntu 12.04 LTSCustomThe default option is Amazon
Linux. If you set this parameter to Custom, you
must use the CreateInstance action's AmiId parameter to specify
the custom AMI that you want to use. For more information on the
standard operating systems, see Operating
SystemsFor more information on how to use custom AMIs with
OpsWorks, see Using
Custom AMIs.
java.lang.String hostnameTheme
HostnameTheme is set to Layer_Dependent, which
creates host names by appending integers to the layer's short name.
The other themes are: To obtain a generated host name, call
GetHostNameSuggestion, which returns a host name based on
the current theme.
java.lang.String defaultAvailabilityZone
java.lang.String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}" For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
StackConfigurationManager configurationManager
java.lang.Boolean useCustomCookbooks
Source customCookbooksSource
java.lang.String defaultSshKeyName
java.lang.String defaultRootDeviceType
Constraints:
Allowed Values: ebs, instance-store
java.lang.String deploymentId
java.lang.String stackId
java.lang.String appId
java.lang.String createdAt
java.lang.String completedAt
java.lang.Integer duration
java.lang.String iamUserArn
java.lang.String comment
DeploymentCommand command
java.lang.String status
java.lang.String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}" For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
ListWithAutoConstructFlag<T> instanceIds
java.lang.String name
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, AWS 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
java.util.Map<K,V> args
ExecuteRecipes command.java.lang.String stackId
DescribeApps
returns a description of the apps in the specified stack.ListWithAutoConstructFlag<T> appIds
DescribeApps returns a description of the
specified apps. Otherwise, it returns a description of every app.ListWithAutoConstructFlag<T> apps
App objects that describe the specified apps.java.lang.String deploymentId
DescribeCommands returns a description of the commands
associated with the specified deployment.java.lang.String instanceId
DescribeCommands returns a description of the commands
associated with the specified instance.ListWithAutoConstructFlag<T> commandIds
DescribeCommands returns a description of the specified
commands. Otherwise, it returns a description of every command.ListWithAutoConstructFlag<T> commands
Command objects that describe each of the
specified commands.java.lang.String stackId
DescribeDeployments returns a description of the commands
associated with the specified stack.java.lang.String appId
DescribeDeployments returns a description of the commands
associated with the specified app.ListWithAutoConstructFlag<T> deploymentIds
DescribeDeployments returns a description of
the specified deployments. Otherwise, it returns a description of
every deployment.ListWithAutoConstructFlag<T> deployments
Deployment objects that describe the
deployments.java.lang.String instanceId
DescribeElasticIps returns a description of the Elastic
IP addresses associated with the specified instance.ListWithAutoConstructFlag<T> ips
DescribeElasticIps returns a description of
the specified Elastic IP addresses. Otherwise, it returns a
description of every Elastic IP address.ListWithAutoConstructFlag<T> elasticIps
ElasticIps object that describes the specified Elastic
IP addresses.java.lang.String stackId
ListWithAutoConstructFlag<T> layerIds
ListWithAutoConstructFlag<T> elasticLoadBalancers
ElasticLoadBalancer objects that describe the
specified Elastic Load Balancing instances.java.lang.String stackId
DescribeInstances
returns descriptions of the instances associated with the specified
stack.java.lang.String layerId
DescribeInstances
returns descriptions of the instances associated with the specified
layer.ListWithAutoConstructFlag<T> instanceIds
DescribeInstances returns a description of the specified
instances. Otherwise, it returns a description of every instance.ListWithAutoConstructFlag<T> instances
Instance objects that describe the instances.java.lang.String stackId
ListWithAutoConstructFlag<T> layerIds
DescribeLayers returns a description
of every layer in the specified stack.ListWithAutoConstructFlag<T> layers
Layer objects that describe the layers.ListWithAutoConstructFlag<T> layerIds
ListWithAutoConstructFlag<T> loadBasedAutoScalingConfigurations
LoadBasedAutoScalingConfiguration objects
that describe each layer's configuration.java.lang.String iamUserArn
java.lang.String stackId
ListWithAutoConstructFlag<T> permissions
Permission objects that describe the stack
permissions. Permission object with permissions
for each of the stack IAM ARNs.Permission
object with permissions for each of the user's stack IDs.Permission object with permissions for the
specified stack and IAM ARN.java.lang.String instanceId
DescribeRaidArrays returns descriptions of the RAID
arrays associated with the specified instance.ListWithAutoConstructFlag<T> raidArrayIds
DescribeRaidArrays returns descriptions of the specified
arrays. Otherwise, it returns a description of every array.ListWithAutoConstructFlag<T> raidArrays
RaidArrays object that describes the specified RAID
arrays.java.lang.String stackId
DescribeServiceErrors returns descriptions of the errors
associated with the specified stack.java.lang.String instanceId
DescribeServiceErrors returns descriptions of the errors
associated with the specified instance.ListWithAutoConstructFlag<T> serviceErrorIds
DescribeServiceErrors returns descriptions of the
specified errors. Otherwise, it returns a description of every error.ListWithAutoConstructFlag<T> serviceErrors
ServiceError objects that describe the
specified service errors.ListWithAutoConstructFlag<T> stackIds
DescribeStacks returns a description
of every stack.ListWithAutoConstructFlag<T> stacks
Stack objects that describe the stacks.ListWithAutoConstructFlag<T> instanceIds
ListWithAutoConstructFlag<T> timeBasedAutoScalingConfigurations
TimeBasedAutoScalingConfiguration objects
that describe the configuration for the specified instances.ListWithAutoConstructFlag<T> iamUserArns
ListWithAutoConstructFlag<T> userProfiles
Users object that describes the specified users.java.lang.String instanceId
DescribeVolumes returns descriptions of the volumes
associated with the specified instance.java.lang.String raidArrayId
DescribeVolumes returns descriptions of the volumes
associated with the specified RAID array.ListWithAutoConstructFlag<T> volumeIds
DescribeVolumes returns descriptions of the specified
volumes. Otherwise, it returns a description of every volume.ListWithAutoConstructFlag<T> volumes
java.lang.String ip
java.lang.String name
java.lang.String domain
java.lang.String region
java.lang.String elasticLoadBalancerName
java.lang.String region
java.lang.String dnsName
java.lang.String stackId
java.lang.String layerId
java.lang.String vpcId
ListWithAutoConstructFlag<T> availabilityZones
ListWithAutoConstructFlag<T> ec2InstanceIds
java.lang.String instanceId
java.lang.String ec2InstanceId
java.lang.String hostname
java.lang.String stackId
ListWithAutoConstructFlag<T> layerIds
ListWithAutoConstructFlag<T> securityGroupIds
java.lang.String instanceType
java.lang.String instanceProfileArn
java.lang.String status
java.lang.String os
java.lang.String amiId
java.lang.String availabilityZone
java.lang.String publicDns
java.lang.String privateDns
java.lang.String publicIp
java.lang.String privateIp
java.lang.String elasticIp
java.lang.String autoScalingType
Constraints:
Allowed Values: load, timer
java.lang.String sshKeyName
java.lang.String sshHostRsaKeyFingerprint
java.lang.String sshHostDsaKeyFingerprint
java.lang.String createdAt
java.lang.String lastServiceErrorId
java.lang.String architecture
Constraints:
Allowed Values: x86_64, i386
java.lang.String rootDeviceType
Constraints:
Allowed Values: ebs, instance-store
java.lang.String rootDeviceVolumeId
java.lang.Boolean installUpdatesOnBoot
true. If this value
is set to false, you must then update your instances
manually by using CreateDeployment to run the
update_dependencies stack command or manually running
yum (Amazon Linux) or apt-get (Ubuntu) on
the instances. true, to ensure that your instances have the latest
security updates.java.lang.String stackId
java.lang.String layerId
java.lang.String type
Constraints:
Allowed Values: lb, web, php-app, rails-app, nodejs-app, memcached, db-master, monitoring-master, custom
java.lang.String name
java.lang.String shortname
java.util.Map<K,V> attributes
java.lang.String customInstanceProfileArn
ListWithAutoConstructFlag<T> customSecurityGroupIds
ListWithAutoConstructFlag<T> defaultSecurityGroupNames
ListWithAutoConstructFlag<T> packages
Package objects that describe the layer's
packages.ListWithAutoConstructFlag<T> volumeConfigurations
VolumeConfigurations object that describes the layer's
Amazon EBS volumes.java.lang.Boolean enableAutoHealing
java.lang.Boolean autoAssignElasticIps
Recipes defaultRecipes
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.
Recipes customRecipes
LayerCustomRecipes object that specifies the layer's
custom recipes.java.lang.String createdAt
java.lang.Boolean installUpdatesOnBoot
true. If this value
is set to false, you must then update your instances
manually by using CreateDeployment to run the
update_dependencies stack command or manually running
yum (Amazon Linux) or apt-get (Ubuntu) on
the instances. true, to ensure that your instances have the latest
security updates.java.lang.String layerId
java.lang.Boolean enable
AutoScalingThresholds upScaling
LoadBasedAutoscalingInstruction object that describes
the upscaling configuration, which defines how and when AWS OpsWorks
increases the number of instances.AutoScalingThresholds downScaling
LoadBasedAutoscalingInstruction object that describes
the downscaling configuration, which defines how and when AWS OpsWorks
reduces the number of instances.java.lang.String stackId
java.lang.String iamUserArn
java.lang.Boolean allowSsh
java.lang.Boolean allowSudo
java.lang.String raidArrayId
java.lang.String instanceId
java.lang.String name
java.lang.Integer raidLevel
java.lang.Integer numberOfDisks
java.lang.Integer size
java.lang.String device
java.lang.String mountPoint
java.lang.String availabilityZone
java.lang.String createdAt
ListWithAutoConstructFlag<T> setup
setup event.ListWithAutoConstructFlag<T> configure
configure event.ListWithAutoConstructFlag<T> deploy
deploy event.ListWithAutoConstructFlag<T> undeploy
undeploy event.ListWithAutoConstructFlag<T> shutdown
shutdown event.java.lang.String serviceErrorId
java.lang.String stackId
java.lang.String instanceId
java.lang.String type
java.lang.String message
java.lang.String createdAt
java.lang.String layerId
java.lang.Boolean enable
AutoScalingThresholds upScaling
AutoScalingThresholds object with the upscaling
threshold configuration. If the load exceeds these thresholds for a
specified amount of time, AWS OpsWorks starts a specified number of
instances.AutoScalingThresholds downScaling
AutoScalingThresholds object with the downscaling
threshold configuration. If the load falls below these thresholds for
a specified amount of time, AWS OpsWorks stops a specified number of
instances.java.lang.String stackId
java.lang.String iamUserArn
java.lang.Boolean allowSsh
java.lang.Boolean allowSudo
java.lang.String instanceId
WeeklyAutoScalingSchedule autoScalingSchedule
AutoScalingSchedule with the instance schedule.java.lang.String type
Constraints:
Allowed Values: git, svn, archive, s3
java.lang.String url
java.lang.String username
Username to the appropriate AWS access
key.Username to the user name.java.lang.String password
Password to the appropriate AWS secret
key.Password to the password.java.lang.String sshKey
java.lang.String revision
java.lang.String certificate
java.lang.String privateKey
java.lang.String chain
java.lang.String stackId
java.lang.String name
java.lang.String region
java.util.Map<K,V> attributes
java.lang.String serviceRoleArn
java.lang.String defaultInstanceProfileArn
java.lang.String defaultOs
Amazon
Linux or Ubuntu 12.04 LTS"CustomThe default option is Amazon
Linux. If you set this parameter to Custom, you
must use the CreateInstance action's AmiId parameter to specify
the custom AMI that you want to use. For more information on the
standard operating systems, see Operating
SystemsFor more information on how to use custom AMIs with
OpsWorks, see Using
Custom AMIs.
java.lang.String hostnameTheme
java.lang.String defaultAvailabilityZone
java.lang.String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}" For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
StackConfigurationManager configurationManager
java.lang.Boolean useCustomCookbooks
Source customCookbooksSource
java.lang.String defaultSshKeyName
java.lang.String createdAt
java.lang.String defaultRootDeviceType
Constraints:
Allowed Values: ebs, instance-store
java.lang.String instanceId
WeeklyAutoScalingSchedule autoScalingSchedule
WeeklyAutoScalingSchedule object with the instance
schedule.java.lang.String appId
java.lang.String name
java.lang.String description
java.lang.String type
Constraints:
Allowed Values: rails, php, nodejs, static, other
Source appSource
Source object that specifies the app repository.ListWithAutoConstructFlag<T> domains
'www.example.com, example.com'java.lang.Boolean enableSsl
SslConfiguration sslConfiguration
SslConfiguration object with the SSL configuration.java.util.Map<K,V> attributes
java.lang.String instanceId
ListWithAutoConstructFlag<T> layerIds
java.lang.String instanceType
java.lang.String autoScalingType
Constraints:
Allowed Values: load, timer
java.lang.String hostname
java.lang.String os
Amazon
Linux or Ubuntu 12.04 LTSCustomThe default option is Amazon
Linux. If you set this parameter to Custom, you
must use the CreateInstance action's AmiId parameter to specify
the custom AMI that you want to use. For more information on the
standard operating systems, see Operating
SystemsFor more information on how to use custom AMIs with
OpsWorks, see Using
Custom AMIs.
java.lang.String amiId
java.lang.String sshKeyName
java.lang.String architecture
Constraints:
Allowed Values: x86_64, i386
java.lang.Boolean installUpdatesOnBoot
true. To control
when updates are installed, set this value to false. You
must then update your instances manually by using
CreateDeployment to run the update_dependencies
stack command or manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances. true, to ensure that
your instances have the latest security updates.java.lang.String layerId
java.lang.String name
java.lang.String shortname
java.util.Map<K,V> attributes
java.lang.String customInstanceProfileArn
ListWithAutoConstructFlag<T> customSecurityGroupIds
ListWithAutoConstructFlag<T> packages
Package objects that describe the layer's
packages.ListWithAutoConstructFlag<T> volumeConfigurations
VolumeConfigurations object that describes the layer's
Amazon EBS volumes.java.lang.Boolean enableAutoHealing
java.lang.Boolean autoAssignElasticIps
Recipes customRecipes
LayerCustomRecipes object that specifies the layer's
custom recipes.java.lang.Boolean installUpdatesOnBoot
true. To control
when updates are installed, set this value to false. You
must then update your instances manually by using
CreateDeployment to run the update_dependencies
stack command or manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances. true, to ensure that
your instances have the latest security updates.java.lang.String stackId
java.lang.String name
java.util.Map<K,V> attributes
java.lang.String serviceRoleArn
java.lang.String defaultInstanceProfileArn
java.lang.String defaultOs
Amazon
Linux or Ubuntu 12.04 LTSCustomThe default option is Amazon
Linux. If you set this parameter to Custom, you
must use the CreateInstance action's AmiId parameter to specify
the custom AMI that you want to use. For more information on the
standard operating systems, see Operating
SystemsFor more information on how to use custom AMIs with
OpsWorks, see Using
Custom AMIs.
java.lang.String hostnameTheme
HostnameTheme is set to
Layer_Dependent, which creates host names by appending integers to the
layer's short name. The other themes are: To obtain a generated host name, call
GetHostNameSuggestion, which returns a host name based on
the current theme.
java.lang.String defaultAvailabilityZone
java.lang.String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}" For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
StackConfigurationManager configurationManager
java.lang.Boolean useCustomCookbooks
Source customCookbooksSource
java.lang.String defaultSshKeyName
java.lang.String defaultRootDeviceType
Constraints:
Allowed Values: ebs, instance-store
java.lang.String volumeId
java.lang.String ec2VolumeId
java.lang.String name
java.lang.String raidArrayId
java.lang.String instanceId
java.lang.String status
java.lang.Integer size
java.lang.String device
java.lang.String mountPoint
java.lang.String region
java.lang.String availabilityZone
java.lang.String mountPoint
java.lang.Integer raidLevel
java.lang.Integer numberOfDisks
java.lang.Integer size
java.util.Map<K,V> monday
java.util.Map<K,V> tuesday
java.util.Map<K,V> wednesday
java.util.Map<K,V> thursday
java.util.Map<K,V> friday
java.util.Map<K,V> saturday
java.util.Map<K,V> sunday
java.lang.String subscriptionName
java.lang.String sourceIdentifier
注意:
java.lang.String resourceName
ListWithAutoConstructFlag<T> tags
java.lang.String dBSecurityGroupName
java.lang.String cIDRIP
java.lang.String eC2SecurityGroupName
EC2SecurityGroupId must be provided. Otherwise,
EC2SecurityGroupOwnerId and either EC2SecurityGroupName
or EC2SecurityGroupId must be provided.java.lang.String eC2SecurityGroupId
EC2SecurityGroupId must be provided. Otherwise,
EC2SecurityGroupOwnerId and either EC2SecurityGroupName
or EC2SecurityGroupId must be provided.java.lang.String eC2SecurityGroupOwnerId
EC2SecurityGroupId must be provided. Otherwise,
EC2SecurityGroupOwnerId and either EC2SecurityGroupName
or EC2SecurityGroupId must be provided.java.lang.String name
java.lang.Boolean provisionedIopsCapable
ListWithAutoConstructFlag<T> niftyStorageTypes
java.lang.String sourceDBSnapshotIdentifier
Constraints:
Example:
rds:mydb-2012-04-02-00-01
java.lang.String targetDBSnapshotIdentifier
Constraints:
Example: my-db-snapshot
java.lang.String dBInstanceIdentifier
java.lang.String sourceDBInstanceIdentifier
Constraints: Must be the identifier of an existing DB Instance that is not already a Read Replica DB Instance.
java.lang.String dBInstanceClass
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.
java.lang.String availabilityZone
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
java.lang.Integer port
Default: Inherits from the source DB Instance
Valid Values:
1150-65535
java.lang.Boolean autoMinorVersionUpgrade
Default: Inherits from the source DB Instance
java.lang.Integer iops
java.lang.String optionGroupName
java.lang.Boolean publiclyAccessible
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.
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.
java.lang.Integer niftyStorageType
java.lang.String niftyReadReplicaPrivateAddress
java.lang.String dBName
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:
Type: String
Oracle
The Oracle System ID (SID) of the created DB Instance.
Default: ORCL
Constraints:
SQL Server
Not applicable. Must be null.
java.lang.String dBInstanceIdentifier
Constraints:
Example:
mydbinstance
java.lang.Integer allocatedStorage
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)
java.lang.String dBInstanceClass
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
java.lang.String engine
Valid Values: MySQL | oracle-se1 |
oracle-se | oracle-ee |
sqlserver-ee | sqlserver-se |
sqlserver-ex | sqlserver-web
java.lang.String masterUsername
MySQL
Constraints:
Type: String
Oracle
Constraints:
SQL Server
Constraints:
java.lang.String masterUserPassword
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.
ListWithAutoConstructFlag<T> dBSecurityGroups
Default: The default DB Security Group for the database engine.
ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Default: The default EC2 VPC Security Group for the DB Subnet group's VPC.
java.lang.String availabilityZone
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.
java.lang.String dBSubnetGroupName
If there is no DB Subnet Group, then it is a non-VPC DB instance.
java.lang.String preferredMaintenanceWindow
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.
java.lang.String dBParameterGroupName
Constraints:
java.lang.Integer backupRetentionPeriod
Default: 1
Constraints:
java.lang.String preferredBackupWindow
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.
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.
java.lang.Integer port
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.
java.lang.Boolean multiAZ
java.lang.Integer niftyMultiAZType
java.lang.String niftyReadReplicaDBInstanceIdentifier
java.lang.String engineVersion
MySQL
Example: 5.1.42
Type: String
Oracle
Example: 11.2.0.2.v2
Type: String
SQL Server
Example: 10.50.2789.0.v1
java.lang.Boolean autoMinorVersionUpgrade
Default:
true
java.lang.String licenseModel
Valid values:
license-included | bring-your-own-license |
general-public-license
java.lang.Integer iops
Constraints: Must be an integer greater than 1000.
java.lang.String optionGroupName
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
java.lang.String characterSetName
java.lang.Boolean publiclyAccessible
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.
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.
java.lang.Integer niftyStorageType
java.lang.String niftyVirtualPrivateAddress
java.lang.String niftyMasterPrivateAddress
java.lang.String niftySlavePrivateAddress
java.lang.String niftyReadReplicaPrivateAddress
java.lang.String dBParameterGroupName
Constraints:
java.lang.String dBParameterGroupFamily
java.lang.String description
java.lang.String dBSecurityGroupName
前提条件:255文字以内の英数字またはハイフンであること。初期値ではないこと。
例:mysecuritygroup
java.lang.String dBSecurityGroupDescription
java.lang.String niftyAvailabilityZone
java.lang.String dBSnapshotIdentifier
前提条件:
例:my-snapshot-id
java.lang.String dBInstanceIdentifier
前提条件:
java.lang.String dBSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".
Example:
mySubnetgroup
java.lang.String dBSubnetGroupDescription
ListWithAutoConstructFlag<T> subnetIds
java.lang.String subscriptionName
Constraints: The name must be less than 255 characters.
java.lang.String snsTopicArn
java.lang.String sourceType
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
ListWithAutoConstructFlag<T> eventCategories
ListWithAutoConstructFlag<T> sourceIds
Constraints:
java.lang.Boolean enabled
ListWithAutoConstructFlag<T> niftyEmailAddresses
java.lang.String niftyDescription
java.lang.String optionGroupName
Constraints:
Example:
myOptiongroup
java.lang.String engineName
java.lang.String majorEngineVersion
java.lang.String optionGroupDescription
java.util.Date timestamp
java.lang.Double sampleCount
java.lang.Double sum
java.lang.String niftyTargetName
java.lang.String engine
java.lang.String engineVersion
java.lang.String dBParameterGroupFamily
java.lang.String dBEngineDescription
java.lang.String dBEngineVersionDescription
CharacterSet defaultCharacterSet
CharacterSetName parameter of the CreateDBInstance
API is not specified.ListWithAutoConstructFlag<T> supportedCharacterSets
CharacterSetName parameter of the CreateDBInstance API.java.lang.String dBInstanceIdentifier
java.lang.String dBInstanceClass
java.lang.String engine
java.lang.String dBInstanceStatus
java.lang.String masterUsername
java.lang.String dBName
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
java.lang.Integer allocatedStorage
java.util.Date instanceCreateTime
java.lang.String preferredBackupWindow
BackupRetentionPeriod.java.lang.Integer backupRetentionPeriod
ListWithAutoConstructFlag<T> dBSecurityGroups
DBSecurityGroup.Name and
DBSecurityGroup.Status subelements.ListWithAutoConstructFlag<T> vpcSecurityGroups
ListWithAutoConstructFlag<T> dBParameterGroups
java.lang.String availabilityZone
DBSubnetGroup dBSubnetGroup
java.lang.String preferredMaintenanceWindow
PendingModifiedValues pendingModifiedValues
java.util.Date latestRestorableTime
java.lang.Boolean multiAZ
java.lang.String engineVersion
java.lang.Boolean autoMinorVersionUpgrade
java.lang.String readReplicaSourceDBInstanceIdentifier
ListWithAutoConstructFlag<T> readReplicaDBInstanceIdentifiers
java.lang.String licenseModel
java.lang.Integer iops
ListWithAutoConstructFlag<T> optionGroupMemberships
java.lang.String characterSetName
java.lang.String secondaryAvailabilityZone
java.lang.Boolean publiclyAccessible
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.
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.
ListWithAutoConstructFlag<T> statusInfos
java.lang.Integer niftyStorageType
java.lang.Integer niftyMultiAZType
java.lang.String statusType
java.lang.Boolean normal
java.lang.String status
java.lang.String message
java.lang.String dBParameterGroupName
java.lang.String dBParameterGroupFamily
java.lang.String description
java.lang.String ownerId
java.lang.String dBSecurityGroupName
java.lang.String dBSecurityGroupDescription
java.lang.String vpcId
ListWithAutoConstructFlag<T> eC2SecurityGroups
ListWithAutoConstructFlag<T> iPRanges
java.lang.String niftyAvailabilityZone
java.lang.String dBSnapshotIdentifier
java.lang.String dBInstanceIdentifier
java.util.Date snapshotCreateTime
java.lang.String engine
java.lang.Integer allocatedStorage
java.lang.String status
java.lang.Integer port
java.lang.String availabilityZone
java.lang.String vpcId
java.util.Date instanceCreateTime
java.lang.String masterUsername
java.lang.String engineVersion
java.lang.String licenseModel
java.lang.String snapshotType
java.lang.Integer iops
java.lang.String optionGroupName
java.lang.String dBSubnetGroupName
java.lang.String dBSubnetGroupDescription
java.lang.String vpcId
java.lang.String subnetGroupStatus
ListWithAutoConstructFlag<T> subnets
java.lang.String dBInstanceIdentifier
Constraints:
java.lang.Boolean skipFinalSnapshot
true is specified, no DBSnapshot
is created. If false is specified, a DB Snapshot is created before the
DB Instance is deleted. false.Default: false
java.lang.String finalDBSnapshotIdentifier
false. Constraints:
java.lang.String dBSecurityGroupName
Constraints:
java.lang.String dBSubnetGroupName
Constraints:
java.lang.String engine
java.lang.String engineVersion
Example: 5.1.49
java.lang.String dBParameterGroupFamily
Constraints:
java.lang.Integer maxRecords
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
java.lang.String marker
MaxRecords.java.lang.Boolean defaultOnly
java.lang.Boolean listSupportedCharacterSets
java.lang.String marker
MaxRecords.ListWithAutoConstructFlag<T> dBEngineVersions
DBEngineVersion elements.java.lang.String dBInstanceIdentifier
Constraints:
java.lang.Integer maxRecords
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
java.lang.String marker
MaxRecords .java.lang.String marker
MaxRecords .ListWithAutoConstructFlag<T> dBInstances
java.lang.String dBInstanceIdentifier
Constraints:
java.lang.String filenameContains
java.lang.Long fileLastWritten
java.lang.Long fileSize
java.lang.Integer maxRecords
java.lang.String marker
ListWithAutoConstructFlag<T> describeDBLogFiles
java.lang.String marker
java.lang.String dBParameterGroupName
Constraints:
java.lang.Integer maxRecords
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
java.lang.String marker
MaxRecords.java.lang.String marker
MaxRecords.ListWithAutoConstructFlag<T> dBParameterGroups
java.lang.String dBParameterGroupName
Constraints:
java.lang.String source
Default: All parameter types returned
Valid Values: user | system | engine-default
java.lang.Integer maxRecords
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
java.lang.String marker
MaxRecords.ListWithAutoConstructFlag<T> parameters
java.lang.String marker
MaxRecords.java.lang.String dBSecurityGroupName
java.lang.Integer maxRecords
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
java.lang.String marker
MaxRecords.java.lang.String marker
MaxRecords.ListWithAutoConstructFlag<T> dBSecurityGroups
java.lang.String dBInstanceIdentifier
Constraints:
java.lang.String dBSnapshotIdentifier
Constraints:
SnapshotType parameter must also be specified.java.lang.String snapshotType
java.lang.Integer maxRecords
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
java.lang.String marker
MaxRecords.java.lang.String marker
MaxRecords.ListWithAutoConstructFlag<T> dBSnapshots
java.lang.String dBSubnetGroupName
java.lang.Integer maxRecords
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
java.lang.String marker
MaxRecords.java.lang.String marker
MaxRecords.ListWithAutoConstructFlag<T> dBSubnetGroups
java.lang.String dBParameterGroupFamily
java.lang.Integer maxRecords
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
java.lang.String marker
MaxRecords.ListWithAutoConstructFlag<T> eventCategoriesMapList
java.lang.String sourceIdentifier
Constraints:
java.lang.String sourceType
Constraints:
Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot
java.util.Date startTime
Example: 2009-07-08T18:00Z
java.util.Date endTime
Example: 2009-07-08T18:00Z
java.lang.Integer duration
Default: 60
ListWithAutoConstructFlag<T> eventCategories
java.lang.Integer maxRecords
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
java.lang.String marker
MaxRecords.java.lang.String marker
MaxRecords .ListWithAutoConstructFlag<T> events
java.lang.String subscriptionName
java.lang.Integer maxRecords
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
java.lang.String marker
MaxRecords .ListWithAutoConstructFlag<T> niftyFilters
java.lang.String niftySortKey
java.lang.Integer niftySortDesc
java.lang.String marker
MaxRecords.ListWithAutoConstructFlag<T> eventSubscriptionsList
java.lang.String engineName
java.lang.String majorEngineVersion
java.lang.Integer maxRecords
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
java.lang.String marker
MaxRecords.ListWithAutoConstructFlag<T> optionGroupOptions
java.lang.String marker
MaxRecords.java.lang.String optionGroupName
java.lang.String marker
MaxRecords.java.lang.Integer maxRecords
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
java.lang.String engineName
java.lang.String majorEngineVersion
ListWithAutoConstructFlag<T> optionGroupsList
java.lang.String marker
MaxRecords.java.lang.String engine
java.lang.String engineVersion
java.lang.String dBInstanceClass
java.lang.String licenseModel
java.lang.Boolean vpc
java.lang.Integer maxRecords
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
java.lang.String marker
MaxRecords .ListWithAutoConstructFlag<T> orderableDBInstanceOptions
java.lang.String marker
MaxRecords .java.lang.String reservedDBInstancesOfferingId
Example:
438012d3-4052-4cc7-b2e3-8d3372e0e706
java.lang.String dBInstanceClass
java.lang.String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
java.lang.String productDescription
java.lang.String offeringType
Valid
Values: "Light Utilization" | "Medium Utilization" | "Heavy
Utilization"
java.lang.Boolean multiAZ
java.lang.Integer maxRecords
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
java.lang.String marker
MaxRecords.java.lang.String marker
MaxRecords.ListWithAutoConstructFlag<T> reservedDBInstancesOfferings
java.lang.String reservedDBInstanceId
java.lang.String reservedDBInstancesOfferingId
java.lang.String dBInstanceClass
java.lang.String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
java.lang.String productDescription
java.lang.String offeringType
Valid
Values: "Light Utilization" | "Medium Utilization" | "Heavy
Utilization"
java.lang.Boolean multiAZ
java.lang.Integer maxRecords
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
java.lang.String marker
MaxRecords.java.lang.String marker
MaxRecords.ListWithAutoConstructFlag<T> reservedDBInstances
java.lang.String dBInstanceIdentifier
Constraints:
java.lang.String logFileName
java.lang.String marker
java.lang.Integer numberOfLines
java.lang.String logFileData
java.lang.String marker
java.lang.Boolean additionalDataPending
java.lang.String status
java.lang.String eC2SecurityGroupName
java.lang.String eC2SecurityGroupId
java.lang.String eC2SecurityGroupOwnerId
EC2SecurityGroupName field.java.lang.String dBParameterGroupFamily
java.lang.String marker
MaxRecords .ListWithAutoConstructFlag<T> parameters
java.lang.String sourceIdentifier
java.lang.String sourceType
Constraints:
Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot
java.lang.String message
ListWithAutoConstructFlag<T> eventCategories
java.util.Date date
java.lang.String sourceType
ListWithAutoConstructFlag<T> eventCategories
java.lang.String customerAwsId
java.lang.String custSubscriptionId
java.lang.String snsTopicArn
java.lang.String status
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.
java.lang.String subscriptionCreationTime
java.lang.String sourceType
ListWithAutoConstructFlag<T> sourceIdsList
ListWithAutoConstructFlag<T> eventCategoriesList
ListWithAutoConstructFlag<T> niftyEmailAddresses
java.lang.String niftyDescription
java.lang.Boolean enabled
java.lang.String resourceName
ListWithAutoConstructFlag<T> tagList
java.lang.String dBInstanceIdentifier
前提条件:
java.lang.Integer allocatedStorage
ApplyImmediatelyパラメータが
trueに設定されていない限り、変更は次のメンテナンスウィンドウの間に適用されます。
MySQL
デフォルト値:既存の設定を使用
有効な値:5~1024
前提条件:指定された値が既存の値よりも少なくとも10%以上でなければなりません。 既存の値より10%以上でない値は、10%以上となるように切り上げられます。
Integer型
Oracle
デフォルト値:既存の設定を使用
有効な値:10~1024
前提条件:指定された値が既存の値よりも少なくとも10%以上でなければなりません。 既存の値より10%以上でない値は、10%以上となるように切り上げられます。
SQL Server
変更することはできません。
標準のストレージを使用してからプロビジョニングIOPSを使用する、 もしくはプロビジョニングされたIOPSを使用してから標準のストレージを使用して、 DBインスタンス移行することを選択した場合、プロセスに時間がかかることがあります。 移行期間は、データベース負荷、ストレージサイズ、ストレージタイプ (標準またはプロビジョニングIOPS)、(もしあれば)プロビジョニングIOPSの量、 および前の規模ストレージ操作の数など、いくつかの要因に依存します。 典型的な移行時間は24時間未満ですが、プロセスはいくつかのケースでは数日かかる場合があります。 移行時に、DBインスタンスは使用可能になりますが、 パフォーマンスの低下が発生する可能性があります。 移行の実行中、インスタンスの夜間のバックアップが中断されます。 他のAmazon RDS操作は、インスタンスの変更、インスタンスの再起動、インスタンスの削除、 リードレプリカの作成、インスタンスのDBスナップショットの作成などを含めて、 インスタンスのための場所を取ることはできません。
java.lang.String dBInstanceClass
ApplyImmediatelyパラメータが
trueに設定されていない限り、このパラメータの値を渡すことで
変更時にシステム停止が発生し、次のメンテナンスウィンドウの間に適用されます。
デフォルト値:既存の設定を使用
有効な値:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large
| db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge
ListWithAutoConstructFlag<T> dBSecurityGroups
前提条件:
ListWithAutoConstructFlag<T> vpcSecurityGroupIds
前提条件:
java.lang.Boolean applyImmediately
PreferredMaintenanceWindow設定に関係なく、
このリクエストでの修正およびいずれかの未決の修正に対して
非同期にできるだけ早く適用されるかどうかを指定します。
このパラメータがfalseとして渡された場合、DBインスタンスへの変更は、 RebootDBInstanceの次回の呼び出し、次のメンテナンスのリブート、 または次の故障のリブート、のいずれかの早いタイミングに適用されます。 変更がいつ適用されるか決めるために、各パラメータを参照してください。
初期値: false
java.lang.String masterUserPassword
このパラメータを変更することで、システム停止は生じませんし、
変更は非同期にできるだけ早く適用されます。
リクエストとリクエストの完了までの間、 デフォルト値:既存の設定を使用
前提条件:
8~41文字の英数字であること(MySQL)、8~30文字の英数字であること(Oracle)、
8~128文字の英数字であること(Oracle)。
MasterUserPassword要素は、
操作応答のPendingModifiedValues要素に存在します。
java.lang.String dBParameterGroupName
このパラメータを変更することでシステム停止は生じませんし、
このリクエストに対するApplyImmediatelyパラメータが
trueに設定されていない限り、変更は非同期にできるだけ早く適用されます。
デフォルト値:既存の設定を使用
前提条件: DBパラメータグループは、このDBインスタンスと同一の DBパラメータグループファミリーでなければなりません。
java.lang.Integer backupRetentionPeriod
0から0でない値、あるいは0でない値から0に変えた場合、
このパラメータの変更はシステム停止を伴う場合があります。
このリクエストに対するApplyImmediatelyパラメータが
trueに設定されていない限り、変更は次のメンテナンスウィンドウの間に適用されます。
0でない値から別の0でない値までパラメータを変更した場合、
変更は非同期にできるだけ早く適用されます。
デフォルト値:既存の設定を使用
前提条件:
java.lang.String preferredBackupWindow
BackupRetentionPeriodを使用して指定されます。
このパラメータを変更することで、システム停止は生じませんし、
変更は非同期にできるだけ早く適用されます。
前提条件:
java.lang.String preferredMaintenanceWindow
デフォルト値:既存の設定を使用
フォーマット: ddd:hh24:mi-ddd:hh24:mi
有効な値: Mon | Tue | Wed | Thu | Fri | Sat | Sun
前提条件:少なくとも30分が必要です
java.lang.Boolean multiAZ
ApplyImmediatelyパラメータが
trueに設定されていない限り、
変更は次のメンテナンスウィンドウの間に適用されます。
前提条件:DBインスタンスがリードレプリカの場合、指定することができません。
java.lang.Integer niftyMultiAZType
java.lang.String niftyReadReplicaDBInstanceIdentifier
前提条件:
java.lang.String engineVersion
ApplyImmediatelyパラメータが
trueに設定されていない限り、変更は次のメンテナンスウィンドウの間に適用されます。
メジャーバージョンのアップグレードについては、 デフォルト以外のDBパラメータグループが現在使用中である場合、 新しいエンジンバージョンのDBパラメータグループファミリーから 新しいDBパラメータグループを指定する必要があります。 新しいDBパラメータグループは、DBパラメータグループファミリーのデフォルトすることができます。
例:5.1.42
java.lang.Boolean allowMajorVersionUpgrade
前提条件:DBインスタンスの現在のバージョンと異なるメジャーバージョンで ENGINEVERSIONパラメータの値を指定する場合、 このパラメータをtrueに設定する必要があります。
java.lang.Boolean autoMinorVersionUpgrade
trueに設定されている場合、
新しいマイナーバージョンが利用可能になった場合、
RDSがそのエンジンのバージョンの自動パッチ適用が可能になった場合、
システム停止が発生します。java.lang.Integer iops
ApplyImmediatelyパラメータが
trueに設定されていない限り、変更は次のメンテナンスウィンドウの間に適用されます。
デフォルト値:既存の設定を使用
前提条件: 指定された値が既存の値よりも少なくとも10%以上でなければなりません。 既存の値より10%以上でない値は、10%以上となるように切り上げられます。
Integer型
標準のストレージを使用してからプロビジョニングIOPSを使用する、 もしくはプロビジョニングされたIOPSを使用してから標準のストレージを使用して DBインスタンス移行することを選択した場合、プロセスに時間がかかることがあります。 移行期間は、データベース負荷、ストレージサイズ、ストレージタイプ(標準またはプロビジョニングIOPS)、 (もしあれば)プロビジョニングIOPSの量、および前の規模ストレージ操作の数など、 いくつかの要因に依存します。 典型的な移行時間は24時間未満ですが、 プロセスはいくつかのケースでは数日かかる場合があります。 移行時に、DBインスタンスは使用可能になりますが、 パフォーマンスの低下が発生する可能性があります。 移行の実行中、インスタンスの夜間のバックアップが中断されます。 他のAmazon RDS操作は、インスタンスの変更、インスタンスの再起動、 インスタンスの削除、リードレプリカの作成、インスタンスのDBスナップショットの作成などを含めて、 インスタンスのための場所を取ることはできません。
java.lang.String optionGroupName
ApplyImmediatelyパラメータがtrueに設定されていない限り、
変更は次のメンテナンスウィンドウの間に適用されます。
OEMを可能にするオプショングループのパラメータ変更の場合、
既存の接続は中断されませんが、新しい接続が短い(サブ秒)期間
拒絶される可能性があります。
Oracle Advanced Security TDE のTDEオプションなどの永続的なオプションは、 オプショングループから削除することはできませんし、 DBインスタンスに関連付けられたオプショングループは DBインスタンスから削除することはできません。
java.lang.String newDBInstanceIdentifier
前提条件:
java.lang.String niftySlavePrivateAddress
java.lang.String niftyReadReplicaPrivateAddress
java.lang.String dBParameterGroupName
前提条件:
ListWithAutoConstructFlag<T> parameters
有効な値:immediate |pending-reboot
java.lang.String dBSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".
Example:
mySubnetgroup
java.lang.String dBSubnetGroupDescription
ListWithAutoConstructFlag<T> subnetIds
java.lang.String subscriptionName
java.lang.String snsTopicArn
java.lang.String sourceType
値:db-instance | db-parameter-group | db-security-group | db-snapshot
ListWithAutoConstructFlag<T> eventCategories
java.lang.Boolean enabled
ListWithAutoConstructFlag<T> niftyEmailAddresses
ListWithAutoConstructFlag<T> niftySourceIds
java.lang.String niftyDescription
java.lang.String optionGroupName
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
ListWithAutoConstructFlag<T> optionsToInclude
ListWithAutoConstructFlag<T> optionsToRemove
java.lang.Boolean applyImmediately
java.lang.String metricName
前提条件
文字長: 1 - 255
ListWithAutoConstructFlag<T> dimensions
前提条件
文字長: 0 - 10
java.util.Date startTime
java.util.Date endTime
java.lang.String label
ListWithAutoConstructFlag<T> datapoints
java.lang.String optionName
java.lang.String optionDescription
java.lang.Boolean persistent
java.lang.Boolean permanent
java.lang.Integer port
ListWithAutoConstructFlag<T> optionSettings
ListWithAutoConstructFlag<T> dBSecurityGroupMemberships
ListWithAutoConstructFlag<T> vpcSecurityGroupMemberships
java.lang.String optionName
java.lang.Integer port
ListWithAutoConstructFlag<T> dBSecurityGroupMemberships
ListWithAutoConstructFlag<T> vpcSecurityGroupMemberships
ListWithAutoConstructFlag<T> optionSettings
java.lang.String optionGroupName
java.lang.String optionGroupDescription
java.lang.String engineName
java.lang.String majorEngineVersion
ListWithAutoConstructFlag<T> options
java.lang.Boolean allowsVpcAndNonVpcInstanceMemberships
java.lang.String vpcId
java.lang.String name
java.lang.String description
java.lang.String engineName
java.lang.String majorEngineVersion
java.lang.String minimumRequiredMinorEngineVersion
java.lang.Boolean portRequired
java.lang.Integer defaultPort
ListWithAutoConstructFlag<T> optionsDependedOn
java.lang.Boolean persistent
java.lang.Boolean permanent
ListWithAutoConstructFlag<T> optionGroupOptionSettings
java.lang.String settingName
java.lang.String settingDescription
java.lang.String defaultValue
java.lang.String applyType
java.lang.String allowedValues
java.lang.Boolean isModifiable
java.lang.String name
java.lang.String value
java.lang.String defaultValue
java.lang.String description
java.lang.String applyType
java.lang.String dataType
java.lang.String allowedValues
java.lang.Boolean isModifiable
java.lang.Boolean isCollection
java.lang.String engine
java.lang.String engineVersion
java.lang.String dBInstanceClass
java.lang.String licenseModel
ListWithAutoConstructFlag<T> availabilityZones
java.lang.Boolean multiAZCapable
java.lang.Boolean readReplicaCapable
java.lang.Boolean vpc
java.lang.String parameterName
java.lang.String parameterValue
java.lang.String description
java.lang.String source
java.lang.String applyType
java.lang.String dataType
java.lang.String allowedValues
java.lang.Boolean isModifiable
true)(false)示します。
一部のパラメータは変更されるのを防ぐため、セキュリティや運用の意味を持っています。java.lang.String minimumEngineVersion
java.lang.String applyMethod
前提条件:
有効な値:immediate, pending-reboot
java.lang.String dBInstanceClass
DBInstanceClassを含んでいます。java.lang.Integer allocatedStorage
AllocatedStorageサイズを含んでいます。java.lang.String masterUserPassword
java.lang.Integer port
java.lang.Integer backupRetentionPeriod
java.lang.Boolean multiAZ
java.lang.String engineVersion
java.lang.Integer iops
java.lang.String dBInstanceIdentifier
DBInstanceIdentifierを含んでいます。java.lang.String dBInstanceIdentifier
Constraints:
Example:
java.lang.Integer backupRetentionPeriod
Default: 1
Constraints:
java.lang.String preferredBackupWindow
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.
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.
java.lang.String reservedDBInstancesOfferingId
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
java.lang.String reservedDBInstanceId
Example: myreservationID
java.lang.Integer dBInstanceCount
Default: 1
java.lang.String dBInstanceIdentifier
前提条件:
java.lang.Boolean forceFailover
trueの場合、MultiAZフェイルオーバーを通して再起動が行われます。
前提条件:インスタンスがMultiAZ用に構成されていない場合は
trueを指定することはできません。
java.lang.String resourceName
ListWithAutoConstructFlag<T> tagKeys
java.lang.String reservedDBInstanceId
java.lang.String reservedDBInstancesOfferingId
java.lang.String dBInstanceClass
java.util.Date startTime
java.lang.Integer duration
java.lang.Double fixedPrice
java.lang.Double usagePrice
java.lang.String currencyCode
java.lang.Integer dBInstanceCount
java.lang.String productDescription
java.lang.String offeringType
java.lang.Boolean multiAZ
java.lang.String state
ListWithAutoConstructFlag<T> recurringCharges
java.lang.String reservedDBInstancesOfferingId
java.lang.String dBInstanceClass
java.lang.Integer duration
java.lang.Double fixedPrice
java.lang.Double usagePrice
java.lang.String currencyCode
java.lang.String productDescription
java.lang.String offeringType
java.lang.Boolean multiAZ
ListWithAutoConstructFlag<T> recurringCharges
java.lang.String dBParameterGroupName
前提条件:
java.lang.Boolean resetAllParameters
true)、そうでないか(false)を指定します。
初期値: true
ListWithAutoConstructFlag<T> parameters
MySQL
有効な値:immediate |pending-reboot
動的パラメータのみで即時の値を使用できます。
動的および静的の両方のパラメータでpending-rebootを使用することができ、
DBインスタンスの再起動時に変更が適用されます。
Oracle
有効な値: pending-reboot
java.lang.String dBInstanceIdentifier
前提条件:
java.lang.String dBSnapshotIdentifier
前提条件:
例: my-snapshot-id
java.lang.String dBInstanceClass
有効な値:db.t1.micro | db.m1.small | db.m1.medium | db.m1.large
| db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge
初期値:オリジナルのDBインスタンスと同じDBInstanceClass。
java.lang.Integer port
初期値:オリジナルのDBインスタンスと同じポート
前提条件:値は、1150-65535でなければなりません。
java.lang.String availabilityZone
初期値:ランダム、システムによって選ばれた有効ゾーン。
前提条件:MultiAZパラメータがtrueに設定されている場合は、 AvailabilityZoneパラメータを指定することはできません。
例:us-east-1a
java.lang.String dBSubnetGroupName
java.lang.Boolean multiAZ
前提条件:MultiAZパラメータがtrueに設定されている場合は、
AvailabilityZoneパラメータを指定することはできません。
java.lang.Integer niftyMultiAZType
java.lang.String niftyReadReplicaDBInstanceIdentifier
java.lang.Boolean publiclyAccessible
初期値:デフォルトの動作では、VPCが要求されているかどうかによって異なります。 以下のリストは、それぞれの場合のデフォルトの動作を示しています。
まだDBサブネットグループがリクエストの一部として指定されていない、 かつPubliclyAccessible値が設定されていない場合、DBインスタンスがパブリックにアクセス可能になります。 特定のDBサブネットグループがリクエストの一部として指定されている、 かつPubliclyAccessible値が設定されていない場合、DBインスタンスはプライベートになります。
java.lang.Boolean autoMinorVersionUpgrade
java.lang.String licenseModel
初期値:ソースと同じです。
有効な値:license-included | bring-your-own-license
| general-public-license
java.lang.String dBName
このパラメータはMySQLのエンジンには使用されません。
java.lang.String engine
初期値:ソースと同じです。
前提条件:ソースのエンジンと互換性がある必要があります。
例: oracle-ee
java.lang.Integer iops
前提条件:1000より大きい整数でなければなりません。
java.lang.String optionGroupName
Oracle Advanced Security TDE のTDEオプションなどの永続的なオプションは、 オプショングループから削除することはできませんし、 DBインスタンスに関連付けられたオプショングループは DBインスタンスから削除することはできません。
java.lang.Integer niftyStorageType
java.lang.String niftyVirtualPrivateAddress
java.lang.String niftyMasterPrivateAddress
java.lang.String niftySlavePrivateAddress
java.lang.String niftyReadReplicaPrivateAddress
java.lang.String sourceDBInstanceIdentifier
前提条件:
java.lang.String targetDBInstanceIdentifier
前提条件:
java.util.Date restoreTime
有効な値:値はUTC時間でなければなりません。
前提条件:
例: 2009-09-07T23:45:00Z
java.lang.Boolean useLatestRestorableTime
true)もしくは(false)を指定します。
初期値:false
前提条件:RestoreTimeパラメータが提供されている場合は指定できません。
java.lang.String dBInstanceClass
有効な値:db.t1.micro | db.m1.small | db.m1.medium | db.m1.large
| db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge
初期値:オリジナルのDBインスタンスと同じDBInstanceClass。
java.lang.Integer port
前提条件:値は、1150-65535でなければなりません。
初期値:オリジナルのDBインスタンスと同じポート。
java.lang.String availabilityZone
初期値:ランダム、システムによって選ばれた有効ゾーン。
前提条件:MultiAZパラメータがtrueに設定されている場合は、 AvailabilityZoneパラメータを指定することはできません。
例:us-east-1a
java.lang.String dBSubnetGroupName
java.lang.Boolean multiAZ
前提条件:MultiAZパラメータがtrueに設定されている場合は、
AvailabilityZoneパラメータを指定することはできません。
java.lang.Integer niftyMultiAZType
java.lang.String niftyReadReplicaDBInstanceIdentifier
java.lang.Boolean publiclyAccessible
初期値:デフォルトの動作では、VPCが要求されているかどうかによって異なります。 以下のリストは、それぞれの場合のデフォルトの動作を示しています。
まだDBサブネットグループがリクエストの一部として指定されていない、 かつPubliclyAccessible値が設定されていない場合、DBインスタンスがパブリックにアクセス可能になります。 特定のDBサブネットグループがリクエストの一部として指定されている、 かつPubliclyAccessible値が設定されていない場合、DBインスタンスはプライベートになります。
java.lang.Boolean autoMinorVersionUpgrade
java.lang.String licenseModel
初期値:ソースと同じです。
有効な値:license-included | bring-your-own-license | general-public-license
java.lang.String dBName
このパラメータはMySQLのエンジンには使用されません。
java.lang.String engine
初期値:ソースと同じです。
前提条件:ソースのエンジンと互換性がある必要があります。
例: oracle-ee
java.lang.Integer iops
前提条件:1000より大きい整数でなければなりません。
java.lang.String optionGroupName
それはDBインスタンスに関連付けられていたら、Oracle Advanced Security TDE の TDEオプションなどの永続的なオプションは、オプショングループから削除することはできませんし、 そのオプショングループはDBインスタンスから削除することはできません。
java.lang.Integer niftyStorageType
java.lang.String niftyVirtualPrivateAddress
java.lang.String niftyMasterPrivateAddress
java.lang.String niftySlavePrivateAddress
java.lang.String niftyReadReplicaPrivateAddress
java.lang.String dBSecurityGroupName
java.lang.String cIDRIP
CIDRIPが指定されている場合、EC2SecurityGroupName、
EC2SecurityGroupIdとEC2SecurityGroupOwnerIdを
提供することができません。java.lang.String eC2SecurityGroupName
EC2SecurityGroupIdを提供する必要があります。
それ以外の場合、EC2SecurityGroupOwnerIdEC2SecurityGroupName
またはEC2SecurityGroupIdのどちらかを指定する必要があります。java.lang.String eC2SecurityGroupId
EC2SecurityGroupIdを提供する必要があります。
それ以外の場合、EC2SecurityGroupOwnerIdEC2SecurityGroupName
またはEC2SecurityGroupIdのどちらかを指定する必要があります。java.lang.String eC2SecurityGroupOwnerId
EC2SecurityGroupNameパラメータで指定された
EC2セキュリティグループの所有者のAWSアカウント番号。
AWSアクセスキーIDが許容値ではありません。
VPC DBセキュリティグループについては、
EC2SecurityGroupIdを提供する必要があります。
それ以外の場合、EC2SecurityGroupOwnerIdEC2SecurityGroupName
またはEC2SecurityGroupIdのどちらかを指定する必要があります。java.lang.String subnetIdentifier
AvailabilityZone subnetAvailabilityZone
This data type is used as an element in the following data type:
java.lang.String subnetStatus
java.lang.String key
java.lang.String value
java.lang.String clusterSecurityGroupName
java.lang.String cIDRIP
java.lang.String eC2SecurityGroupName
java.lang.String eC2SecurityGroupOwnerId
Example: 111122223333
java.lang.String clusterIdentifier
java.lang.String nodeType
java.lang.String clusterStatus
available, creating, deleting,
rebooting, and resizing.java.lang.String modifyStatus
java.lang.String masterUsername
java.lang.String dBName
Endpoint endpoint
java.util.Date clusterCreateTime
java.lang.Integer automatedSnapshotRetentionPeriod
ListWithAutoConstructFlag<T> clusterSecurityGroups
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.
ListWithAutoConstructFlag<T> vpcSecurityGroups
ListWithAutoConstructFlag<T> clusterParameterGroups
java.lang.String clusterSubnetGroupName
java.lang.String vpcId
java.lang.String availabilityZone
java.lang.String preferredMaintenanceWindow
PendingModifiedValues pendingModifiedValues
java.lang.String clusterVersion
java.lang.Boolean allowVersionUpgrade
true, version upgrades will be applied automatically
to the cluster during the maintenance window.java.lang.Integer numberOfNodes
java.lang.Boolean publiclyAccessible
true, the cluster can be accessed from a public
network.java.lang.Boolean encrypted
true, data in cluster is encrypted at rest.java.lang.String parameterGroupName
java.lang.String parameterGroupFamily
java.lang.String description
java.lang.String clusterSecurityGroupName
java.lang.String description
ListWithAutoConstructFlag<T> eC2SecurityGroups
ListWithAutoConstructFlag<T> iPRanges
java.lang.String clusterSubnetGroupName
java.lang.String description
java.lang.String vpcId
java.lang.String subnetGroupStatus
Complete, Incomplete and
Invalid.ListWithAutoConstructFlag<T> subnets
java.lang.String clusterVersion
java.lang.String clusterParameterGroupFamily
java.lang.String description
java.lang.String sourceSnapshotIdentifier
Constraints:
java.lang.String targetSnapshotIdentifier
Constraints:
java.lang.String parameterGroupName
Constraints:
java.lang.String parameterGroupFamily
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".
java.lang.String description
java.lang.String dBName
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:
java.lang.String clusterIdentifier
Constraints:
Example: myexamplecluster
java.lang.String clusterType
single-node, the NumberOfNodes parameter is
not required.multi-node, the
NumberOfNodes parameter is required. Valid
Values: multi-node | single-node
Default:
multi-node
java.lang.String nodeType
Valid Values: dw.hs1.xlarge |
dw.hs1.8xlarge.
java.lang.String masterUsername
Constraints:
java.lang.String masterUserPassword
Constraints:
ListWithAutoConstructFlag<T> clusterSecurityGroups
Default: The default cluster security group for Amazon Redshift.
ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Default: The default VPC security group is associated with the cluster.
java.lang.String clusterSubnetGroupName
If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
java.lang.String availabilityZone
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.
java.lang.String preferredMaintenanceWindow
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.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
java.lang.String clusterParameterGroupName
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
java.lang.Integer automatedSnapshotRetentionPeriod
Default: 1
Constraints: Must be a value from 0 to 35.
java.lang.Integer port
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
java.lang.String clusterVersion
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
java.lang.Boolean allowVersionUpgrade
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
java.lang.Integer numberOfNodes
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.
java.lang.Boolean publiclyAccessible
true, the cluster can be accessed from a public
network.java.lang.Boolean encrypted
true, the data in cluster is encrypted at rest.
Default: false
java.lang.String clusterSecurityGroupName
Constraints:
Example:
examplesecuritygroup
java.lang.String description
java.lang.String snapshotIdentifier
Constraints:
Example:
my-snapshot-id
java.lang.String clusterIdentifier
java.lang.String clusterSubnetGroupName
Constraints:
Example:
examplesubnetgroup
java.lang.String description
ListWithAutoConstructFlag<T> subnetIds
java.lang.String parameterGroupFamily
java.lang.String marker
ListWithAutoConstructFlag<T> parameters
java.lang.String clusterIdentifier
Constraints:
java.lang.Boolean skipFinalClusterSnapshot
true, a final
cluster snapshot is not created. If false, a final
cluster snapshot is created before the cluster is deleted. false.Default: false
java.lang.String finalClusterSnapshotIdentifier
false.
Constraints:
java.lang.String parameterGroupName
java.lang.Integer maxRecords
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.
java.lang.String marker
java.lang.String marker
ListWithAutoConstructFlag<T> parameterGroups
java.lang.String parameterGroupName
java.lang.String source
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
java.lang.Integer maxRecords
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.
java.lang.String marker
MaxRecords.ListWithAutoConstructFlag<T> parameters
java.lang.String marker
java.lang.String clusterSecurityGroupName
Example:
securitygroup1
java.lang.Integer maxRecords
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.
java.lang.String marker
java.lang.String marker
ListWithAutoConstructFlag<T> clusterSecurityGroups
java.lang.String clusterIdentifier
java.lang.String snapshotIdentifier
java.lang.String snapshotType
Valid Values:
automated | manual
java.util.Date startTime
Example: 2012-07-16T18:00:00Z
java.util.Date endTime
Example: 2012-07-16T18:00:00Z
java.lang.Integer maxRecords
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.
java.lang.String marker
java.lang.String ownerAccount
java.lang.String marker
ListWithAutoConstructFlag<T> snapshots
java.lang.String clusterIdentifier
The default is that all clusters defined for an account are returned.
java.lang.Integer maxRecords
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.
java.lang.String marker
You can specify either a Marker parameter or a ClusterIdentifier parameter in a DescribeClusters request, but not both.
java.lang.String marker
ListWithAutoConstructFlag<T> clusters
java.lang.String clusterSubnetGroupName
java.lang.Integer maxRecords
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.
java.lang.String marker
java.lang.String marker
ListWithAutoConstructFlag<T> clusterSubnetGroups
java.lang.String clusterVersion
Example: 1.0
java.lang.String clusterParameterGroupFamily
Constraints:
java.lang.Integer maxRecords
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.
java.lang.String marker
MaxRecords.java.lang.String marker
ListWithAutoConstructFlag<T> clusterVersions
Version elements.java.lang.String parameterGroupFamily
java.lang.Integer maxRecords
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.
java.lang.String marker
MaxRecords.java.lang.String sourceIdentifier
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
cluster.cluster-security-group.cluster-parameter-group.cluster-snapshot.java.lang.String sourceType
Constraints:
If SourceType is supplied, SourceIdentifier must also be provided.
cluster when SourceIdentifier is a
cluster identifier.cluster-security-group when SourceIdentifier is a
cluster security group name.cluster-parameter-group when SourceIdentifier is a
cluster parameter group name.cluster-snapshot when SourceIdentifier is a
cluster snapshot identifier.
Constraints:
Allowed Values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot
java.util.Date startTime
Example: 2009-07-08T18:00Z
java.util.Date endTime
Example: 2009-07-08T18:00Z
java.lang.Integer duration
Default: 60
java.lang.Integer maxRecords
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.
java.lang.String marker
MaxRecords.java.lang.String marker
ListWithAutoConstructFlag<T> events
java.lang.String clusterVersion
Default: All versions.
Constraints: Must be one of the version returned from DescribeClusterVersions.
java.lang.String nodeType
java.lang.Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results may
be retrieved. Default: 100
Constraints: minimum 20, maximum 100.
java.lang.String marker
MaxRecords.ListWithAutoConstructFlag<T> orderableClusterOptions
java.lang.String marker
java.lang.String reservedNodeOfferingId
java.lang.Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results may
be retrieved. Default: 100
Constraints: minimum 20, maximum 100.
java.lang.String marker
You can specify either a Marker parameter or a ClusterIdentifier parameter in a DescribeClusters request, but not both.
java.lang.String marker
ListWithAutoConstructFlag<T> reservedNodeOfferings
java.lang.String reservedNodeId
java.lang.Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results may
be retrieved. Default: 100
Constraints: minimum 20, maximum 100.
java.lang.String marker
java.lang.String marker
ListWithAutoConstructFlag<T> reservedNodes
java.lang.String targetNodeType
java.lang.Integer targetNumberOfNodes
java.lang.String targetClusterType
Valid Values:
multi-node | single-node
java.lang.String status
Valid Values: NONE
| IN_PROGRESS | FAILED |
SUCCEEDED
ListWithAutoConstructFlag<T> importTablesCompleted
Valid Values: List of table names.
ListWithAutoConstructFlag<T> importTablesInProgress
Valid Values: List of table names.
ListWithAutoConstructFlag<T> importTablesNotStarted
Valid Values: List of table names
java.lang.String status
java.lang.String eC2SecurityGroupName
java.lang.String eC2SecurityGroupOwnerId
EC2SecurityGroupName field.java.lang.String sourceIdentifier
java.lang.String sourceType
Constraints:
Allowed Values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot
java.lang.String message
java.util.Date date
java.lang.String parameterGroupName
ListWithAutoConstructFlag<T> parameters
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.
java.lang.String parameterGroupName
java.lang.String parameterGroupStatus
java.lang.String clusterIdentifier
Example:
examplecluster
java.lang.String clusterType
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
java.lang.String nodeType
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
java.lang.Integer numberOfNodes
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.
ListWithAutoConstructFlag<T> clusterSecurityGroups
Security groups currently associated with the cluster and not in the list of groups to apply, will be revoked from the cluster.
Constraints:
ListWithAutoConstructFlag<T> vpcSecurityGroupIds
java.lang.String masterUserPassword
MasterUserPassword element exists in the
PendingModifiedValues element of the operation response.
Default: Uses existing setting.
Constraints:
java.lang.String clusterParameterGroupName
Default: Uses existing setting.
Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.
java.lang.Integer automatedSnapshotRetentionPeriod
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.
java.lang.String preferredMaintenanceWindow
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.
java.lang.String clusterVersion
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
java.lang.Boolean allowVersionUpgrade
true, upgrades will be applied automatically to the
cluster during the maintenance window. Default: false
java.lang.String clusterSubnetGroupName
java.lang.String description
ListWithAutoConstructFlag<T> subnetIds
java.lang.String clusterVersion
java.lang.String clusterType
multi-node.java.lang.String nodeType
ListWithAutoConstructFlag<T> availabilityZones
java.lang.String parameterName
java.lang.String parameterValue
java.lang.String description
java.lang.String source
java.lang.String dataType
java.lang.String allowedValues
java.lang.Boolean isModifiable
true, the parameter can be modified. Some parameters
have security or operational implications that prevent them from being
changed.java.lang.String minimumEngineVersion
java.lang.String masterUserPassword
java.lang.String nodeType
java.lang.Integer numberOfNodes
java.lang.String clusterType
java.lang.String clusterVersion
java.lang.Integer automatedSnapshotRetentionPeriod
java.lang.String reservedNodeId
java.lang.String reservedNodeOfferingId
java.lang.String nodeType
java.util.Date startTime
java.lang.Integer duration
java.lang.Double fixedPrice
java.lang.Double usagePrice
java.lang.String currencyCode
java.lang.Integer nodeCount
java.lang.String state
Possible Values:
java.lang.String offeringType
ListWithAutoConstructFlag<T> recurringCharges
java.lang.String reservedNodeOfferingId
java.lang.String nodeType
java.lang.Integer duration
java.lang.Double fixedPrice
java.lang.Double usagePrice
java.lang.String currencyCode
java.lang.String offeringType
ListWithAutoConstructFlag<T> recurringCharges
java.lang.String parameterGroupName
java.lang.Boolean resetAllParameters
true, all parameters in the specified parameter group
will be reset to their default values. Default: true
ListWithAutoConstructFlag<T> parameters
Constraints: A maximum of 20 parameters can be reset in a single request.
java.lang.String parameterGroupName
java.lang.String parameterGroupStatus
java.lang.String clusterIdentifier
Constraints:
java.lang.String snapshotIdentifier
Example:
my-snapshot-id
java.lang.Integer port
Default: The same port as the original cluster.
Constraints: Must be between
1115 and 65535.
java.lang.String availabilityZone
Default: A random, system-chosen Availability Zone.
Example:
us-east-1a
java.lang.Boolean allowVersionUpgrade
true, upgrades can be applied during the maintenance
window to the Amazon Redshift engine that is running on the cluster.
Default: true
java.lang.String clusterSubnetGroupName
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.
java.lang.Boolean publiclyAccessible
true, the cluster can be accessed from a public
network.java.lang.String ownerAccount
java.lang.String clusterSecurityGroupName
java.lang.String cIDRIP
CIDRIP is specified, EC2SecurityGroupName
and EC2SecurityGroupOwnerId cannot be provided.java.lang.String eC2SecurityGroupName
EC2SecurityGroupName is specified,
EC2SecurityGroupOwnerId must also be provided and
CIDRIP cannot be provided.java.lang.String eC2SecurityGroupOwnerId
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
java.lang.String snapshotIdentifier
java.lang.String clusterIdentifier
java.util.Date snapshotCreateTime
java.lang.String status
java.lang.Integer port
java.lang.String availabilityZone
java.util.Date clusterCreateTime
java.lang.String masterUsername
java.lang.String clusterVersion
java.lang.String snapshotType
java.lang.String nodeType
java.lang.Integer numberOfNodes
java.lang.String dBName
java.lang.String vpcId
java.lang.Boolean encrypted
true, the data in the snapshot is encrypted at rest.ListWithAutoConstructFlag<T> accountsWithRestoreAccess
null if no accounts are authorized.
Visible only to the snapshot owner.java.lang.String ownerAccount
java.lang.Double totalBackupSizeInMegaBytes
java.lang.Double actualIncrementalBackupSizeInMegaBytes
java.lang.Double backupProgressInMegaBytes
java.lang.Double currentBackupRateInMegaBytesPerSecond
0 for a completed backup.java.lang.Long estimatedSecondsToCompletion
0 for a completed backup.java.lang.Long elapsedTimeInSeconds
java.lang.String subnetIdentifier
AvailabilityZone subnetAvailabilityZone
java.lang.String subnetStatus
java.lang.String hostedZoneId
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide.
Constraints:
Length: 0 - 32
java.lang.String dNSName
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide.
Constraints:
Length: 0 - 1024
java.lang.Boolean evaluateTargetHealth
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide.
java.lang.String action
Valid values: CREATE |
DELETE
Constraints:
Allowed Values: CREATE, DELETE
ResourceRecordSet resourceRecordSet
java.lang.String comment
Constraints:
Length: 0 - 256
ListWithAutoConstructFlag<T> changes
Change element for each
resource record set that you want to create or delete.
Constraints:
Length: 1 -
java.lang.String id
Constraints:
Length: 0 - 32
java.lang.String status
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
java.util.Date submittedAt
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.java.lang.String comment
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
Constraints:
Length: 0 - 256
java.lang.String hostedZoneId
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
Changes element.java.lang.String version
ChangeInfo changeInfo
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
java.lang.String callerReference
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
java.lang.String version
HealthCheck healthCheck
java.lang.String location
Constraints:
Length: 0 - 1024
java.lang.String name
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
java.lang.String callerReference
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
java.lang.String version
HostedZone hostedZone
ChangeInfo changeInfo
DelegationSet delegationSet
java.lang.String location
Constraints:
Length: 0 - 1024
ListWithAutoConstructFlag<T> nameServers
NameServer that is
assigned to your hosted zone.
Constraints:
Length: 1 -
java.lang.String id
Constraints:
Length: 0 - 32
java.lang.String version
ChangeInfo changeInfo
java.lang.String id
ChangeResourceRecordSets returned in the
Id element when you submitted the request.
Constraints:
Length: 0 - 32
java.lang.String version
ChangeInfo changeInfo
HealthCheck healthCheck
HostedZone hostedZone
DelegationSet delegationSet
java.lang.String id
Constraints:
Length: 0 - 64
java.lang.String callerReference
Constraints:
Length: 1 - 64
HealthCheckConfig healthCheckConfig
java.lang.String iPAddress
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])$
java.lang.Integer port
Constraints:
Range: 1 - 65535
java.lang.String type
Constraints:
Allowed Values: HTTP, TCP
java.lang.String resourcePath
Constraints:
Length: 0 - 255
java.lang.String fullyQualifiedDomainName
Constraints:
Length: 0 - 255
java.lang.String id
Constraints:
Length: 0 - 32
java.lang.String name
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
java.lang.String callerReference
Constraints:
Length: 1 - 128
HostedZoneConfig config
Comment element.java.lang.Long resourceRecordSetCount
java.lang.String marker
NextMarker from the last
response in the marker parameter to get the next page of
results.
Constraints:
Length: 0 - 64
java.lang.String maxItems
java.lang.String version
ListWithAutoConstructFlag<T> healthChecks
java.lang.String marker
NextMarker from the last
response in the marker parameter to get the next page of
results.
Constraints:
Length: 0 - 64
java.lang.Boolean isTruncated
Marker element.
Valid Values: true | false
java.lang.String nextMarker
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
java.lang.String maxItems
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.java.lang.String marker
NextMarker from the last
response in the marker parameter to get the next page of
results.
Constraints:
Length: 0 - 64
java.lang.String maxItems
java.lang.String version
ListWithAutoConstructFlag<T> hostedZones
java.lang.String marker
NextMarker from the last
response in the marker parameter to get the next page of
results.
Constraints:
Length: 0 - 64
java.lang.Boolean isTruncated
Marker element.
Valid Values: true | false
java.lang.String nextMarker
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
java.lang.String maxItems
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.java.lang.String hostedZoneId
Constraints:
Length: 0 - 32
java.lang.String startRecordName
ListResourceRecordSets request to list.
Constraints:
Length: 0 - 1024
java.lang.String startRecordType
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
java.lang.String startRecordIdentifier
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
java.lang.String maxItems
java.lang.String version
ListWithAutoConstructFlag<T> resourceRecordSets
java.lang.Boolean isTruncated
Valid
Values: true | false
java.lang.String nextRecordName
Constraints:
Length: 0 - 1024
java.lang.String nextRecordType
Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA
java.lang.String nextRecordIdentifier
SetIdentifier
for the next resource record set that has the current DNS name and
type.
Constraints:
Length: 1 - 128
java.lang.String maxItems
MaxItems is 100.java.lang.String name
Constraints:
Length: 0 - 1024
java.lang.String type
Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA
java.lang.String setIdentifier
Constraints:
Length: 1 - 128
java.lang.Long weight
Constraints:
Range: 0 - 255
java.lang.String region
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
java.lang.String failover
Valid values: PRIMARY |
SECONDARY
Constraints:
Allowed Values: PRIMARY, SECONDARY
java.lang.Long tTL
Constraints:
Range: 0 - 2147483647
java.lang.String niftyDefaultHost
NiftyHealthCheckConfig niftyHealthCheckConfig
java.lang.String niftyComment
ListWithAutoConstructFlag<T> resourceRecords
Constraints:
Length: 1 -
AliasTarget aliasTarget
java.lang.String healthCheckId
Constraints:
Length: 0 - 64
java.util.HashSet<E> grants
Owner owner
java.lang.String assumedRoleId
Constraints:
Length: 2 - 96
Pattern: [\w+=,.@:-]*
java.lang.String arn
Constraints:
Length: 20 - 2048
java.lang.String roleArn
Constraints:
Length: 20 - 2048
java.lang.String roleSessionName
AssumedRoleUser.
Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*
java.lang.String policy
AssumeRole call. The resulting
permissions of the temporary security credentials are an intersection
of this policy and the access policy that is associated with the role.
Use this policy to further restrict the permissions of the temporary
security credentials.
Constraints:
Length: 1 - 2048
Pattern: [
-ÿ]+
java.lang.Integer durationSeconds
Constraints:
Range: 900 - 3600
java.lang.String externalId
Constraints:
Length: 2 - 96
Pattern: [\w+=,.@:-]*
Credentials credentials
AssumedRoleUser assumedRoleUser
RoleSessionName that
you specified when you called AssumeRole.java.lang.Integer packedPolicySize
Constraints:
Range: 0 -
java.lang.String roleArn
Constraints:
Length: 20 - 2048
java.lang.String roleSessionName
AssumedRoleUser response element.
Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*
java.lang.String webIdentityToken
AssumeRoleWithWebIdentity call.
Constraints:
Length: 4 - 2048
java.lang.String providerId
accounts.google.com. Do not include URL schemes and port
numbers. Currently, www.amazon.com and
graph.facebook.com are supported.
Constraints:
Length: 4 - 2048
java.lang.String policy
AssumeRoleWithWebIdentity call. The
resulting permissions of the temporary security credentials are an
intersection of this policy and the access policy that is associated
with the role. Use this policy to further restrict the permissions of
the temporary security credentials.
Constraints:
Length: 1 - 2048
Pattern: [
-ÿ]+
java.lang.Integer durationSeconds
Constraints:
Range: 900 - 129600
Credentials credentials
java.lang.String subjectFromWebIdentityToken
WebIdentityToken
that was submitted with the AssumeRoleWithWebIdentity
call. The identifier is typically unique to the user and the
application that acquired the WebIdentityToken (pairwise
identifier). If an OpenID Connect ID token was submitted in the
WebIdentityToken, this value is returned by the identity
provider as the token's sub (Subject) claim.
Constraints:
Length: 6 - 255
AssumedRoleUser assumedRoleUser
RoleSessionName that
you specified when you called AssumeRole.java.lang.Integer packedPolicySize
Constraints:
Range: 0 -
java.lang.String accessKeyId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String secretAccessKey
java.lang.String sessionToken
java.util.Date expiration
java.lang.String federatedUserId
Constraints:
Length: 2 - 96
Pattern: [\w+=,.@\:-]*
java.lang.String arn
Constraints:
Length: 20 - 2048
java.lang.String name
Bob). For
example, you can reference the federated user name in a resource-based
policy, such as in an Amazon S3 bucket policy.
Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*
java.lang.String policy
Constraints:
Length: 1 - 2048
Pattern: [
-ÿ]+
java.lang.Integer durationSeconds
Constraints:
Range: 900 - 129600
Credentials credentials
FederatedUser federatedUser
arn:aws:sts::123456789012:federated-user/Bob or
123456789012:Bob). You can use the federated user's ARN
in your resource policies like in an Amazon S3 bucket policy.java.lang.Integer packedPolicySize
Constraints:
Range: 0 -
java.lang.Integer durationSeconds
Constraints:
Range: 900 - 129600
java.lang.String serialNumber
GetSessionToken call.
Specify this value if the IAM user has a policy that requires MFA
authentication. The value is either the serial number for a hardware
device (such as GAHT12345678) or an Amazon Resource Name
(ARN) for a virtual device (such as
arn:aws:iam::123456789012:mfa/user). You can find the
device for an IAM user by going to the AWS Management Console and
viewing the user's security credentials.
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
java.lang.String tokenCode
Constraints:
Length: 6 - 6
Pattern: [\d]*
Credentials credentials
java.lang.String domainName
ListWithAutoConstructFlag<T> items
java.lang.String domainName
ListWithAutoConstructFlag<T> items
java.lang.String name
ListWithAutoConstructFlag<T> attributes
java.lang.String domainName
java.lang.String itemName
ListWithAutoConstructFlag<T> attributes
UpdateCondition expected
java.lang.Integer itemCount
java.lang.Long itemNamesSizeBytes
java.lang.Integer attributeNameCount
java.lang.Long attributeNamesSizeBytes
java.lang.Integer attributeValueCount
java.lang.Long attributeValuesSizeBytes
java.lang.Integer timestamp
java.lang.String domainName
java.lang.String itemName
ListWithAutoConstructFlag<T> attributeNames
java.lang.Boolean consistentRead
true, any data previously
written to SimpleDB will be returned. Otherwise, results will be
consistent eventually, and the client may not see data that was
written immediately before your read.ListWithAutoConstructFlag<T> attributes
java.lang.String name
java.lang.String alternateNameEncoding
ListWithAutoConstructFlag<T> attributes
ListWithAutoConstructFlag<T> domainNames
java.lang.String nextToken
MaxNumberOfDomains still available.java.lang.String domainName
java.lang.String itemName
ListWithAutoConstructFlag<T> attributes
UpdateCondition expected
java.lang.String name
java.lang.String value
java.lang.Boolean replace
false.java.lang.String name
ListWithAutoConstructFlag<T> attributes
java.lang.String selectExpression
java.lang.String nextToken
ItemNames.java.lang.Boolean consistentRead
true, any data previously
written to SimpleDB will be returned. Otherwise, results will be
consistent eventually, and the client may not see data that was
written immediately before your read.ListWithAutoConstructFlag<T> items
java.lang.String nextToken
MaxNumberOfItems were matched, the response size exceeded
1 megabyte, or the execution time exceeded 5 seconds.java.lang.String name
java.lang.String value
Exists parameter is equal to true.java.lang.Boolean exists
true if the attribute must exist for
the update condition to be satisfied. Specify false if
the attribute should not exist in order for the update condition to be
satisfied.ListWithAutoConstructFlag<T> toAddresses
ListWithAutoConstructFlag<T> ccAddresses
ListWithAutoConstructFlag<T> bccAddresses
ListWithAutoConstructFlag<T> identities
ListWithAutoConstructFlag<T> identities
ListWithAutoConstructFlag<T> identities
java.lang.Double max24HourSend
java.lang.Double maxSendRate
java.lang.Double sentLast24Hours
ListWithAutoConstructFlag<T> sendDataPoints
java.lang.Boolean dkimEnabled
java.lang.String dkimVerificationStatus
Constraints:
Allowed Values: Pending, Success, Failed, TemporaryFailure
ListWithAutoConstructFlag<T> dkimTokens
CNAME DNS records that point to DKIM public keys hosted
by Amazon SES. (This only applies to domain entities, not email
address identities.)java.lang.String bounceTopic
java.lang.String complaintTopic
java.lang.Boolean forwardingEnabled
true indicates that Amazon SES will forward feedback as
email, while false indicates that feedback will be
published only to the specified Bounce and Complaint topics.java.lang.String verificationStatus
Constraints:
Allowed Values: Pending, Success, Failed, TemporaryFailure
java.lang.String verificationToken
java.lang.String identityType
Constraints:
Allowed Values: EmailAddress, Domain
java.lang.String nextToken
java.lang.Integer maxItems
ListWithAutoConstructFlag<T> identities
java.lang.String nextToken
ListWithAutoConstructFlag<T> verifiedEmailAddresses
java.nio.ByteBuffer data
For more information, go to theAmazon SES Developer Guide.
java.util.Date timestamp
java.lang.Long deliveryAttempts
java.lang.Long bounces
java.lang.Long complaints
java.lang.Long rejects
java.lang.String source
Destination destination
Message message
ListWithAutoConstructFlag<T> replyToAddresses
java.lang.String returnPath
ReturnPath parameter.java.lang.String source
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. ListWithAutoConstructFlag<T> destinations
RawMessage rawMessage
java.lang.String identity
user@example.com, example.com.java.lang.Boolean forwardingEnabled
true specifies that Amazon SES will forward feedback
notifications as email, in addition to any Amazon SNS topic publishing
otherwise specified. false specifies that Amazon SES will
publish feedback notifications only through Amazon SNS. This value can
only be set to false when topics are specified for both
Bounce and Complaint topic types.java.lang.String identity
user@example.com, example.com.java.lang.String notificationType
Constraints:
Allowed Values: Bounce, Complaint
java.lang.String snsTopic
ListWithAutoConstructFlag<T> dkimTokens
ActivityType activityType
java.lang.String activityId
ActivityTaskTimeoutType timeoutType
java.lang.String details
WorkflowExecution workflowExecution
WorkflowType workflowType
ScheduleActivityTaskFailedCause failureCause
SignalExternalWorkflowExecutionFailedCause failureCause
WorkflowExecution signaledExecution
StartChildWorkflowExecutionFailedCause failureCause
StartTimerFailedCause failureCause
java.lang.String taskToken
Constraints:
Length: 1 - 1024
java.lang.String activityId
Constraints:
Length: 1 - 256
java.lang.Long startedEventId
ActivityTaskStarted event recorded in the
history.WorkflowExecution workflowExecution
ActivityType activityType
java.lang.String input
Constraints:
Length: 0 - 32768
java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.Long scheduledEventId
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.java.lang.Long startedEventId
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.java.lang.Long latestCancelRequestedEventId
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.java.lang.Long decisionTaskCompletedEventId
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.java.lang.String activityId
Constraints:
Length: 1 - 256
java.lang.String result
Constraints:
Length: 0 - 32768
java.lang.Long scheduledEventId
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.java.lang.Long startedEventId
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.java.lang.String reason
Constraints:
Length: 0 - 256
java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.Long scheduledEventId
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.java.lang.Long startedEventId
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.ActivityType activityType
java.lang.String activityId
Constraints:
Length: 1 - 256
java.lang.String input
Constraints:
Length: 0 - 32768
java.lang.String control
Constraints:
Length: 0 - 32768
java.lang.String scheduleToStartTimeout
Constraints:
Length: 0 - 8
java.lang.String scheduleToCloseTimeout
Constraints:
Length: 0 - 8
java.lang.String startToCloseTimeout
Constraints:
Length: 0 - 8
TaskList taskList
java.lang.Long decisionTaskCompletedEventId
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.java.lang.String heartbeatTimeout
Constraints:
Length: 0 - 8
java.lang.String identity
Constraints:
Length: 0 - 256
java.lang.Long scheduledEventId
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.java.lang.String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE, SCHEDULE_TO_START, SCHEDULE_TO_CLOSE, HEARTBEAT
java.lang.Long scheduledEventId
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.java.lang.Long startedEventId
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.java.lang.String details
details parameter for the
last call made by the activity to
RecordActivityTaskHeartbeat.
Constraints:
Length: 0 - 2048
java.lang.String name
Constraints:
Length: 1 - 256
java.lang.String version
Constraints:
Length: 1 - 64
java.lang.String defaultTaskStartToCloseTimeout
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
java.lang.String defaultTaskHeartbeatTimeout
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
TaskList defaultTaskList
ScheduleActivityTask Decision. You can override
this default when scheduling a task through the
ScheduleActivityTask Decision.java.lang.String defaultTaskScheduleToStartTimeout
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
java.lang.String defaultTaskScheduleToCloseTimeout
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
ActivityTypeInfo typeInfo
The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.
ActivityTypeConfiguration configuration
ActivityType activityType
java.lang.String status
Constraints:
Allowed Values: REGISTERED, DEPRECATED
java.lang.String description
Constraints:
Length: 0 - 1024
java.util.Date creationDate
java.util.Date deprecationDate
ListWithAutoConstructFlag<T> typeInfos
java.lang.String nextPageToken
Constraints:
Length: 0 - 2048
java.lang.String timerId
CancelTimer decision that
failed.
Constraints:
Length: 1 - 256
java.lang.String cause
Constraints:
Allowed Values: TIMER_ID_UNKNOWN, OPERATION_NOT_PERMITTED
java.lang.Long decisionTaskCompletedEventId
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.java.lang.String cause
Constraints:
Allowed Values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED
java.lang.Long decisionTaskCompletedEventId
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.WorkflowExecution workflowExecution
WorkflowType workflowType
java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.Long initiatedEventId
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.java.lang.Long startedEventId
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.WorkflowExecution workflowExecution
WorkflowType workflowType
java.lang.String result
Constraints:
Length: 0 - 32768
java.lang.Long initiatedEventId
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.java.lang.Long startedEventId
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.WorkflowExecution workflowExecution
WorkflowType workflowType
java.lang.String reason
Constraints:
Length: 0 - 256
java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.Long initiatedEventId
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.java.lang.Long startedEventId
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.WorkflowExecution workflowExecution
WorkflowType workflowType
java.lang.Long initiatedEventId
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.WorkflowExecution workflowExecution
WorkflowType workflowType
java.lang.Long initiatedEventId
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.java.lang.Long startedEventId
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.WorkflowExecution workflowExecution
WorkflowType workflowType
java.lang.String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE
java.lang.Long initiatedEventId
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.java.lang.Long startedEventId
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.java.lang.String cause
Constraints:
Allowed Values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED
java.lang.Long decisionTaskCompletedEventId
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.java.lang.String input
Constraints:
Length: 0 - 32768
java.lang.String executionStartToCloseTimeout
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.
Constraints:
Length: 0 - 8
TaskList taskList
java.lang.String taskStartToCloseTimeout
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.
Constraints:
Length: 0 - 8
java.lang.String childPolicy
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
java.lang.String workflowTypeVersion
java.lang.String cause
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
java.lang.Long decisionTaskCompletedEventId
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.java.lang.String domain
Constraints:
Length: 1 - 256
ExecutionTimeFilter startTimeFilter
startTimeFilter
and closeTimeFilter are mutually exclusive. You must
specify one of these in a request but not both.ExecutionTimeFilter closeTimeFilter
startTimeFilter
and closeTimeFilter are mutually exclusive. You must
specify one of these in a request but not both.WorkflowExecutionFilter executionFilter
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.WorkflowTypeFilter typeFilter
closeStatusFilter,
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.TagFilter tagFilter
closeStatusFilter,
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.CloseStatusFilter closeStatusFilter
executionStatus is specified as CLOSED.
closeStatusFilter, executionFilter,
typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.java.lang.String domain
Constraints:
Length: 1 - 256
ExecutionTimeFilter startTimeFilter
WorkflowTypeFilter typeFilter
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.TagFilter tagFilter
executionFilter,
typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.WorkflowExecutionFilter executionFilter
WorkflowId in the filter are counted.
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.java.lang.String domain
Constraints:
Length: 1 - 256
TaskList taskList
java.lang.String domain
Constraints:
Length: 1 - 256
TaskList taskList
java.lang.String decisionType
Constraints:
Allowed Values: ScheduleActivityTask, RequestCancelActivityTask, CompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution, ContinueAsNewWorkflowExecution, RecordMarker, StartTimer, CancelTimer, SignalExternalWorkflowExecution, RequestCancelExternalWorkflowExecution, StartChildWorkflowExecution
ScheduleActivityTaskDecisionAttributes scheduleActivityTaskDecisionAttributes
ScheduleActivityTask decision. It
is not set for other decision types.RequestCancelActivityTaskDecisionAttributes requestCancelActivityTaskDecisionAttributes
RequestCancelActivityTask
decision. It is not set for other decision types.CompleteWorkflowExecutionDecisionAttributes completeWorkflowExecutionDecisionAttributes
CompleteWorkflowExecution
decision. It is not set for other decision types.FailWorkflowExecutionDecisionAttributes failWorkflowExecutionDecisionAttributes
FailWorkflowExecution decision.
It is not set for other decision types.CancelWorkflowExecutionDecisionAttributes cancelWorkflowExecutionDecisionAttributes
CancelWorkflowExecution decision.
It is not set for other decision types.ContinueAsNewWorkflowExecutionDecisionAttributes continueAsNewWorkflowExecutionDecisionAttributes
ContinueAsNewWorkflowExecution
decision. It is not set for other decision types.RecordMarkerDecisionAttributes recordMarkerDecisionAttributes
RecordMarker decision. It is not
set for other decision types.StartTimerDecisionAttributes startTimerDecisionAttributes
StartTimer decision. It is not
set for other decision types.CancelTimerDecisionAttributes cancelTimerDecisionAttributes
CancelTimer decision. It is not
set for other decision types.SignalExternalWorkflowExecutionDecisionAttributes signalExternalWorkflowExecutionDecisionAttributes
SignalExternalWorkflowExecution
decision. It is not set for other decision types.RequestCancelExternalWorkflowExecutionDecisionAttributes requestCancelExternalWorkflowExecutionDecisionAttributes
RequestCancelExternalWorkflowExecution decision. It is
not set for other decision types.StartChildWorkflowExecutionDecisionAttributes startChildWorkflowExecutionDecisionAttributes
StartChildWorkflowExecution
decision. It is not set for other decision types.java.lang.String taskToken
Constraints:
Length: 1 - 1024
java.lang.Long startedEventId
DecisionTaskStarted event recorded in the
history.WorkflowExecution workflowExecution
WorkflowType workflowType
ListWithAutoConstructFlag<T> events
java.lang.String nextPageToken
Constraints:
Length: 0 - 2048
java.lang.Long previousStartedEventId
java.lang.String executionContext
Constraints:
Length: 0 - 32768
java.lang.Long scheduledEventId
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.java.lang.Long startedEventId
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.TaskList taskList
java.lang.String startToCloseTimeout
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
java.lang.String identity
Constraints:
Length: 0 - 256
java.lang.Long scheduledEventId
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.java.lang.String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE
java.lang.Long scheduledEventId
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.java.lang.Long startedEventId
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.java.lang.String domain
Constraints:
Length: 1 - 256
ActivityType activityType
java.lang.String domain
Constraints:
Length: 1 - 256
WorkflowType workflowType
java.lang.String domain
Constraints:
Length: 1 - 256
ActivityType activityType
java.lang.String domain
Constraints:
Length: 1 - 256
WorkflowExecution execution
java.lang.String domain
Constraints:
Length: 1 - 256
WorkflowType workflowType
DomainInfo domainInfo
DomainConfiguration configuration
java.lang.String name
Constraints:
Length: 1 - 256
java.lang.String status
Constraints:
Allowed Values: REGISTERED, DEPRECATED
java.lang.String description
Constraints:
Length: 0 - 1024
ListWithAutoConstructFlag<T> domainInfos
java.lang.String nextPageToken
Constraints:
Length: 0 - 2048
WorkflowExecution workflowExecution
java.lang.Long initiatedEventId
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.WorkflowExecution workflowExecution
java.lang.Long initiatedEventId
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.java.lang.String cause
Constraints:
Allowed Values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED
java.lang.Long decisionTaskCompletedEventId
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.java.lang.String domain
Constraints:
Length: 1 - 256
WorkflowExecution execution
java.lang.String nextPageToken
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
java.lang.Integer maximumPageSize
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
java.lang.Boolean reverseOrder
true, returns the events in reverse order. By
default the results are returned in ascending order of the
eventTimeStamp of the events.ListWithAutoConstructFlag<T> events
java.lang.String nextPageToken
Constraints:
Length: 0 - 2048
java.util.Date eventTimestamp
java.lang.String eventType
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
java.lang.Long eventId
WorkflowExecutionStartedEventAttributes workflowExecutionStartedEventAttributes
WorkflowExecutionStarted then
this member is set and provides detailed information about the event.
It is not set for other event types.WorkflowExecutionCompletedEventAttributes workflowExecutionCompletedEventAttributes
WorkflowExecutionCompleted then
this member is set and provides detailed information about the event.
It is not set for other event types.CompleteWorkflowExecutionFailedEventAttributes completeWorkflowExecutionFailedEventAttributes
CompleteWorkflowExecutionFailed
then this member is set and provides detailed information about the
event. It is not set for other event types.WorkflowExecutionFailedEventAttributes workflowExecutionFailedEventAttributes
WorkflowExecutionFailed then this
member is set and provides detailed information about the event. It is
not set for other event types.FailWorkflowExecutionFailedEventAttributes failWorkflowExecutionFailedEventAttributes
FailWorkflowExecutionFailed then
this member is set and provides detailed information about the event.
It is not set for other event types.WorkflowExecutionTimedOutEventAttributes workflowExecutionTimedOutEventAttributes
WorkflowExecutionTimedOut then
this member is set and provides detailed information about the event.
It is not set for other event types.WorkflowExecutionCanceledEventAttributes workflowExecutionCanceledEventAttributes
WorkflowExecutionCanceled then
this member is set and provides detailed information about the event.
It is not set for other event types.CancelWorkflowExecutionFailedEventAttributes cancelWorkflowExecutionFailedEventAttributes
CancelWorkflowExecutionFailed
then this member is set and provides detailed information about the
event. It is not set for other event types.WorkflowExecutionContinuedAsNewEventAttributes workflowExecutionContinuedAsNewEventAttributes
WorkflowExecutionContinuedAsNew
then this member is set and provides detailed information about the
event. It is not set for other event types.ContinueAsNewWorkflowExecutionFailedEventAttributes continueAsNewWorkflowExecutionFailedEventAttributes
ContinueAsNewWorkflowExecutionFailed then this member is
set and provides detailed information about the event. It is not set
for other event types.WorkflowExecutionTerminatedEventAttributes workflowExecutionTerminatedEventAttributes
WorkflowExecutionTerminated then
this member is set and provides detailed information about the event.
It is not set for other event types.WorkflowExecutionCancelRequestedEventAttributes workflowExecutionCancelRequestedEventAttributes
WorkflowExecutionCancelRequested
then this member is set and provides detailed information about the
event. It is not set for other event types.DecisionTaskScheduledEventAttributes decisionTaskScheduledEventAttributes
DecisionTaskScheduled then this
member is set and provides detailed information about the event. It is
not set for other event types.DecisionTaskStartedEventAttributes decisionTaskStartedEventAttributes
DecisionTaskStarted then this
member is set and provides detailed information about the event. It is
not set for other event types.DecisionTaskCompletedEventAttributes decisionTaskCompletedEventAttributes
DecisionTaskCompleted then this
member is set and provides detailed information about the event. It is
not set for other event types.DecisionTaskTimedOutEventAttributes decisionTaskTimedOutEventAttributes
DecisionTaskTimedOut then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskScheduledEventAttributes activityTaskScheduledEventAttributes
ActivityTaskScheduled then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskStartedEventAttributes activityTaskStartedEventAttributes
ActivityTaskStarted then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskCompletedEventAttributes activityTaskCompletedEventAttributes
ActivityTaskCompleted then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskFailedEventAttributes activityTaskFailedEventAttributes
ActivityTaskFailed then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskTimedOutEventAttributes activityTaskTimedOutEventAttributes
ActivityTaskTimedOut then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskCanceledEventAttributes activityTaskCanceledEventAttributes
ActivityTaskCanceled then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskCancelRequestedEventAttributes activityTaskCancelRequestedEventAttributes
ActivityTaskcancelRequested then
this member is set and provides detailed information about the event.
It is not set for other event types.WorkflowExecutionSignaledEventAttributes workflowExecutionSignaledEventAttributes
WorkflowExecutionSignaled then
this member is set and provides detailed information about the event.
It is not set for other event types.MarkerRecordedEventAttributes markerRecordedEventAttributes
MarkerRecorded then this member
is set and provides detailed information about the event. It is not
set for other event types.RecordMarkerFailedEventAttributes recordMarkerFailedEventAttributes
DecisionTaskFailed then this
member is set and provides detailed information about the event. It is
not set for other event types.TimerStartedEventAttributes timerStartedEventAttributes
TimerStarted then this member is
set and provides detailed information about the event. It is not set
for other event types.TimerFiredEventAttributes timerFiredEventAttributes
TimerFired then this member is
set and provides detailed information about the event. It is not set
for other event types.TimerCanceledEventAttributes timerCanceledEventAttributes
TimerCanceled then this member is
set and provides detailed information about the event. It is not set
for other event types.StartChildWorkflowExecutionInitiatedEventAttributes startChildWorkflowExecutionInitiatedEventAttributes
StartChildWorkflowExecutionInitiated then this member is
set and provides detailed information about the event. It is not set
for other event types.ChildWorkflowExecutionStartedEventAttributes childWorkflowExecutionStartedEventAttributes
ChildWorkflowExecutionStarted
then this member is set and provides detailed information about the
event. It is not set for other event types.ChildWorkflowExecutionCompletedEventAttributes childWorkflowExecutionCompletedEventAttributes
ChildWorkflowExecutionCompleted
then this member is set and provides detailed information about the
event. It is not set for other event types.ChildWorkflowExecutionFailedEventAttributes childWorkflowExecutionFailedEventAttributes
ChildWorkflowExecutionFailed then
this member is set and provides detailed information about the event.
It is not set for other event types.ChildWorkflowExecutionTimedOutEventAttributes childWorkflowExecutionTimedOutEventAttributes
ChildWorkflowExecutionTimedOut
then this member is set and provides detailed information about the
event. It is not set for other event types.ChildWorkflowExecutionCanceledEventAttributes childWorkflowExecutionCanceledEventAttributes
ChildWorkflowExecutionCanceled
then this member is set and provides detailed information about the
event. It is not set for other event types.ChildWorkflowExecutionTerminatedEventAttributes childWorkflowExecutionTerminatedEventAttributes
ChildWorkflowExecutionTerminated
then this member is set and provides detailed information about the
event. It is not set for other event types.SignalExternalWorkflowExecutionInitiatedEventAttributes signalExternalWorkflowExecutionInitiatedEventAttributes
SignalExternalWorkflowExecutionInitiated then this member
is set and provides detailed information about the event. It is not
set for other event types.ExternalWorkflowExecutionSignaledEventAttributes externalWorkflowExecutionSignaledEventAttributes
ExternalWorkflowExecutionSignaled
then this member is set and provides detailed information about the
event. It is not set for other event types.SignalExternalWorkflowExecutionFailedEventAttributes signalExternalWorkflowExecutionFailedEventAttributes
SignalExternalWorkflowExecutionFailed then this member is
set and provides detailed information about the event. It is not set
for other event types.ExternalWorkflowExecutionCancelRequestedEventAttributes externalWorkflowExecutionCancelRequestedEventAttributes
ExternalWorkflowExecutionCancelRequested then this member
is set and provides detailed information about the event. It is not
set for other event types.RequestCancelExternalWorkflowExecutionInitiatedEventAttributes requestCancelExternalWorkflowExecutionInitiatedEventAttributes
RequestCancelExternalWorkflowExecutionInitiated then this
member is set and provides detailed information about the event. It is
not set for other event types.RequestCancelExternalWorkflowExecutionFailedEventAttributes requestCancelExternalWorkflowExecutionFailedEventAttributes
RequestCancelExternalWorkflowExecutionFailed then this
member is set and provides detailed information about the event. It is
not set for other event types.ScheduleActivityTaskFailedEventAttributes scheduleActivityTaskFailedEventAttributes
ScheduleActivityTaskFailed then
this member is set and provides detailed information about the event.
It is not set for other event types.RequestCancelActivityTaskFailedEventAttributes requestCancelActivityTaskFailedEventAttributes
RequestCancelActivityTaskFailed
then this member is set and provides detailed information about the
event. It is not set for other event types.StartTimerFailedEventAttributes startTimerFailedEventAttributes
StartTimerFailed then this member
is set and provides detailed information about the event. It is not
set for other event types.CancelTimerFailedEventAttributes cancelTimerFailedEventAttributes
CancelTimerFailed then this
member is set and provides detailed information about the event. It is
not set for other event types.StartChildWorkflowExecutionFailedEventAttributes startChildWorkflowExecutionFailedEventAttributes
StartChildWorkflowExecutionFailed
then this member is set and provides detailed information about the
event. It is not set for other event types.java.lang.String domain
Constraints:
Length: 1 - 256
java.lang.String name
Constraints:
Length: 1 - 256
java.lang.String registrationStatus
Constraints:
Allowed Values: REGISTERED, DEPRECATED
java.lang.String nextPageToken
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
java.lang.Integer maximumPageSize
Constraints:
Range: 0 - 1000
java.lang.Boolean reverseOrder
true, returns the results in reverse order.
By default the results are returned in ascending alphabetical order of
the name of the activity types.java.lang.String domain
Constraints:
Length: 1 - 256
ExecutionTimeFilter startTimeFilter
startTimeFilter and closeTimeFilter
are mutually exclusive. You must specify one of these in a request but
not both.ExecutionTimeFilter closeTimeFilter
startTimeFilter and closeTimeFilter
are mutually exclusive. You must specify one of these in a request but
not both.WorkflowExecutionFilter executionFilter
closeStatusFilter, executionFilter,
typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.CloseStatusFilter closeStatusFilter
closeStatusFilter, executionFilter,
typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.WorkflowTypeFilter typeFilter
closeStatusFilter,
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.TagFilter tagFilter
closeStatusFilter, executionFilter,
typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.java.lang.String nextPageToken
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
java.lang.Integer maximumPageSize
Constraints:
Range: 0 - 1000
java.lang.Boolean reverseOrder
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.java.lang.String nextPageToken
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
java.lang.String registrationStatus
Constraints:
Allowed Values: REGISTERED, DEPRECATED
java.lang.Integer maximumPageSize
Constraints:
Range: 0 - 1000
java.lang.Boolean reverseOrder
true, returns the results in reverse order.
By default the results are returned in ascending alphabetical order of
the name of the domains.java.lang.String domain
Constraints:
Length: 1 - 256
ExecutionTimeFilter startTimeFilter
WorkflowTypeFilter typeFilter
executionFilter, typeFilter
and tagFilter are mutually exclusive. You can specify at
most one of these in a request.TagFilter tagFilter
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.java.lang.String nextPageToken
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
java.lang.Integer maximumPageSize
Constraints:
Range: 0 - 1000
java.lang.Boolean reverseOrder
true, returns the results in reverse order.
By default the results are returned in descending order of the start
time of the executions.WorkflowExecutionFilter executionFilter
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.java.lang.String domain
Constraints:
Length: 1 - 256
java.lang.String name
Constraints:
Length: 1 - 256
java.lang.String registrationStatus
Constraints:
Allowed Values: REGISTERED, DEPRECATED
java.lang.String nextPageToken
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
java.lang.Integer maximumPageSize
Constraints:
Range: 0 - 1000
java.lang.Boolean reverseOrder
true, returns the results in reverse order.
By default the results are returned in ascending alphabetical order of
the name of the workflow types.java.lang.String markerName
Constraints:
Length: 1 - 256
java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.Long decisionTaskCompletedEventId
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.java.lang.String domain
Constraints:
Length: 1 - 256
TaskList taskList
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".
java.lang.String identity
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
java.lang.String domain
Constraints:
Length: 1 - 256
TaskList taskList
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".
java.lang.String identity
Constraints:
Length: 0 - 256
java.lang.String nextPageToken
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. 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
java.lang.Integer maximumPageSize
Constraints:
Range: 0 - 1000
java.lang.Boolean reverseOrder
true, returns the events in reverse order. By
default the results are returned in ascending order of the
eventTimestamp of the events.java.lang.String taskToken
taskToken of the ActivityTask. 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
java.lang.String details
Constraints:
Length: 0 - 2048
java.lang.String markerName
Constraints:
Length: 1 - 256
java.lang.String cause
Constraints:
Allowed Values: OPERATION_NOT_PERMITTED
java.lang.Long decisionTaskCompletedEventId
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.java.lang.String domain
Constraints:
Length: 1 - 256
java.lang.String name
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
java.lang.String version
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
java.lang.String description
Constraints:
Length: 0 - 1024
java.lang.String defaultTaskStartToCloseTimeout
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
java.lang.String defaultTaskHeartbeatTimeout
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
TaskList defaultTaskList
ScheduleActivityTask Decision.java.lang.String defaultTaskScheduleToStartTimeout
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
java.lang.String defaultTaskScheduleToCloseTimeout
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
java.lang.String name
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
java.lang.String description
Constraints:
Length: 0 - 1024
java.lang.String workflowExecutionRetentionPeriodInDays
NONE is specified, the records for workflow
executions in this domain are not retained at all.
Constraints:
Length: 1 - 8
java.lang.String domain
Constraints:
Length: 1 - 256
java.lang.String name
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
java.lang.String version
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
java.lang.String description
Constraints:
Length: 0 - 1024
java.lang.String defaultTaskStartToCloseTimeout
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
java.lang.String defaultExecutionStartToCloseTimeout
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
TaskList defaultTaskList
StartChildWorkflowExecution Decision.java.lang.String defaultChildPolicy
StartChildWorkflowExecution Decision. The
supported child policies are: WorkflowExecutionCancelRequested event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
java.lang.String activityId
RequestCancelActivityTask
decision that failed.
Constraints:
Length: 1 - 256
java.lang.String cause
Constraints:
Allowed Values: ACTIVITY_ID_UNKNOWN, OPERATION_NOT_PERMITTED
java.lang.Long decisionTaskCompletedEventId
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.java.lang.String workflowId
workflowId of the external workflow execution to
cancel. This field is required.
Constraints:
Length: 1 - 256
java.lang.String runId
runId of the external workflow execution to cancel.
Constraints:
Length: 0 - 64
java.lang.String control
Constraints:
Length: 0 - 32768
java.lang.String workflowId
workflowId of the external workflow to which the
cancel request was to be delivered.
Constraints:
Length: 1 - 256
java.lang.String runId
runId of the external workflow execution.
Constraints:
Length: 0 - 64
java.lang.String cause
Constraints:
Allowed Values: UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION, REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED
java.lang.Long initiatedEventId
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.java.lang.Long decisionTaskCompletedEventId
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.java.lang.String control
java.lang.String workflowId
workflowId of the external workflow execution to be
canceled.
Constraints:
Length: 1 - 256
java.lang.String runId
runId of the external workflow execution to be
canceled.
Constraints:
Length: 0 - 64
java.lang.Long decisionTaskCompletedEventId
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.java.lang.String control
Constraints:
Length: 0 - 32768
java.lang.String domain
Constraints:
Length: 1 - 256
java.lang.String workflowId
Constraints:
Length: 1 - 256
java.lang.String runId
Constraints:
Length: 0 - 64
java.lang.String taskToken
taskToken of the ActivityTask. 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
java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.String taskToken
taskToken of the ActivityTask. 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
java.lang.String result
Constraints:
Length: 0 - 32768
java.lang.String taskToken
taskToken of the ActivityTask. 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
java.lang.String reason
Constraints:
Length: 0 - 256
java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.String taskToken
taskToken from the DecisionTask. 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
ListWithAutoConstructFlag<T> decisions
java.lang.String executionContext
Constraints:
Length: 0 - 32768
ActivityType activityType
java.lang.String activityId
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
java.lang.String control
Constraints:
Length: 0 - 32768
java.lang.String input
Constraints:
Length: 0 - 32768
java.lang.String scheduleToCloseTimeout
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
defaultTaskList
registered with the activity type will be used. 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".
java.lang.String scheduleToStartTimeout
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
java.lang.String startToCloseTimeout
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
java.lang.String heartbeatTimeout
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
ActivityType activityType
ScheduleActivityTask
decision that failed.java.lang.String activityId
ScheduleActivityTask
decision that failed.
Constraints:
Length: 1 - 256
java.lang.String cause
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
java.lang.Long decisionTaskCompletedEventId
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.java.lang.String workflowId
workflowId of the workflow execution to be signaled.
This field is required.
Constraints:
Length: 1 - 256
java.lang.String runId
runId of the workflow execution to be signaled.
Constraints:
Length: 0 - 64
java.lang.String signalName
Constraints:
Length: 1 - 256
java.lang.String input
Constraints:
Length: 0 - 32768
java.lang.String control
Constraints:
Length: 0 - 32768
java.lang.String workflowId
workflowId of the external workflow execution that
the signal was being delivered to.
Constraints:
Length: 1 - 256
java.lang.String runId
runId of the external workflow execution that the
signal was being delivered to.
Constraints:
Length: 0 - 64
java.lang.String cause
Constraints:
Allowed Values: UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION, SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED
java.lang.Long initiatedEventId
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.java.lang.Long decisionTaskCompletedEventId
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.java.lang.String control
java.lang.String workflowId
workflowId of the external workflow execution.
Constraints:
Length: 1 - 256
java.lang.String runId
runId of the external workflow execution to send the
signal to.
Constraints:
Length: 0 - 64
java.lang.String signalName
Constraints:
Length: 1 - 256
java.lang.String input
Constraints:
Length: 0 - 32768
java.lang.Long decisionTaskCompletedEventId
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.java.lang.String control
Constraints:
Length: 0 - 32768
java.lang.String domain
Constraints:
Length: 1 - 256
java.lang.String workflowId
Constraints:
Length: 1 - 256
java.lang.String runId
Constraints:
Length: 0 - 64
java.lang.String signalName
Constraints:
Length: 1 - 256
java.lang.String input
WorkflowExecutionSignaled event in
the target workflow execution's history.
Constraints:
Length: 0 - 32768
WorkflowType workflowType
java.lang.String workflowId
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
java.lang.String control
Constraints:
Length: 0 - 32768
java.lang.String input
Constraints:
Length: 0 - 32768
java.lang.String executionStartToCloseTimeout
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
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".
java.lang.String taskStartToCloseTimeout
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.
Constraints:
Length: 0 - 8
java.lang.String childPolicy
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
WorkflowType workflowType
StartChildWorkflowExecution Decision that failed.java.lang.String cause
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
java.lang.String workflowId
workflowId of the child workflow execution.
Constraints:
Length: 1 - 256
java.lang.Long initiatedEventId
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.java.lang.Long decisionTaskCompletedEventId
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.java.lang.String control
java.lang.String workflowId
workflowId of the child workflow execution.
Constraints:
Length: 1 - 256
WorkflowType workflowType
java.lang.String control
Constraints:
Length: 0 - 32768
java.lang.String input
Constraints:
Length: 0 - 32768
java.lang.String executionStartToCloseTimeout
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
java.lang.Long decisionTaskCompletedEventId
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.java.lang.String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
java.lang.String taskStartToCloseTimeout
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
ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
java.lang.String timerId
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
java.lang.String control
Constraints:
Length: 0 - 32768
java.lang.String startToFireTimeout
The duration is specified in seconds. The valid values are integers greater than or equal to 0.
Constraints:
Length: 1 - 8
java.lang.String timerId
StartTimer decision that
failed.
Constraints:
Length: 1 - 256
java.lang.String cause
Constraints:
Allowed Values: TIMER_ID_ALREADY_IN_USE, OPEN_TIMERS_LIMIT_EXCEEDED, TIMER_CREATION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED
java.lang.Long decisionTaskCompletedEventId
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.java.lang.String domain
Constraints:
Length: 1 - 256
java.lang.String workflowId
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
TaskList taskList
defaultTaskList
specified when registering 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".
java.lang.String input
input is made available to the new workflow execution in
the WorkflowExecutionStarted history event.
Constraints:
Length: 0 - 32768
java.lang.String executionStartToCloseTimeout
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.
Constraints:
Length: 0 - 8
ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
java.lang.String taskStartToCloseTimeout
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.
Constraints:
Length: 0 - 8
java.lang.String childPolicy
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
java.lang.String domain
Constraints:
Length: 1 - 256
java.lang.String workflowId
Constraints:
Length: 1 - 256
java.lang.String runId
Constraints:
Length: 0 - 64
java.lang.String reason
Constraints:
Length: 0 - 256
java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.String childPolicy
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
java.lang.String timerId
Constraints:
Length: 1 - 256
java.lang.Long startedEventId
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.java.lang.Long decisionTaskCompletedEventId
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.java.lang.String timerId
Constraints:
Length: 1 - 256
java.lang.Long startedEventId
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.java.lang.String timerId
Constraints:
Length: 1 - 256
java.lang.String control
Constraints:
Length: 0 - 32768
java.lang.String startToFireTimeout
The duration is specified in seconds. The valid values are integers greater than or equal to 0.
Constraints:
Length: 1 - 8
java.lang.Long decisionTaskCompletedEventId
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.java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.Long decisionTaskCompletedEventId
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.WorkflowExecution externalWorkflowExecution
java.lang.Long externalInitiatedEventId
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.java.lang.String cause
Constraints:
Allowed Values: CHILD_POLICY_APPLIED
java.lang.String result
Constraints:
Length: 0 - 32768
java.lang.Long decisionTaskCompletedEventId
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.java.lang.String taskStartToCloseTimeout
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
java.lang.String executionStartToCloseTimeout
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
java.lang.String childPolicy
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
java.lang.String input
Constraints:
Length: 0 - 32768
java.lang.Long decisionTaskCompletedEventId
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.java.lang.String newExecutionRunId
runId of the new workflow execution.
Constraints:
Length: 1 - 64
java.lang.String executionStartToCloseTimeout
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
java.lang.String taskStartToCloseTimeout
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
java.lang.String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
WorkflowType workflowType
WorkflowExecutionInfo executionInfo
WorkflowExecutionConfiguration executionConfiguration
WorkflowExecutionOpenCounts openCounts
java.util.Date latestActivityTaskTimestamp
java.lang.String latestExecutionContext
Constraints:
Length: 0 - 32768
java.lang.String reason
Constraints:
Length: 0 - 256
java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.Long decisionTaskCompletedEventId
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.WorkflowExecution execution
WorkflowType workflowType
java.util.Date startTimestamp
java.util.Date closeTimestamp
java.lang.String executionStatus
Constraints:
Allowed Values: OPEN, CLOSED
java.lang.String closeStatus
Constraints:
Allowed Values: COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT
WorkflowExecution parent
ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
java.lang.Boolean cancelRequested
ListWithAutoConstructFlag<T> executionInfos
java.lang.String nextPageToken
Constraints:
Length: 0 - 2048
java.lang.Integer openActivityTasks
Constraints:
Range: 0 -
java.lang.Integer openDecisionTasks
Constraints:
Range: 0 - 1
java.lang.Integer openTimers
Constraints:
Range: 0 -
java.lang.Integer openChildWorkflowExecutions
Constraints:
Range: 0 -
java.lang.String signalName
Constraints:
Length: 1 - 256
java.lang.String input
Constraints:
Length: 0 - 32768
WorkflowExecution externalWorkflowExecution
java.lang.Long externalInitiatedEventId
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.java.lang.String input
Constraints:
Length: 0 - 32768
java.lang.String executionStartToCloseTimeout
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
java.lang.String taskStartToCloseTimeout
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
java.lang.String childPolicy
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
TaskList taskList
WorkflowType workflowType
ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
java.lang.String continuedExecutionRunId
ContinueAsNewWorkflowExecution decision, then it contains
the runId of the previous workflow execution that was
closed and continued as this execution.
Constraints:
Length: 0 - 64
WorkflowExecution parentWorkflowExecution
java.lang.Long parentInitiatedEventId
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.java.lang.String reason
Constraints:
Length: 0 - 256
java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.String childPolicy
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
java.lang.String cause
Constraints:
Allowed Values: CHILD_POLICY_APPLIED, EVENT_LIMIT_EXCEEDED, OPERATOR_INITIATED
java.lang.String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE
java.lang.String childPolicy
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
java.lang.String name
Constraints:
Length: 1 - 256
java.lang.String version
Constraints:
Length: 1 - 64
java.lang.String defaultTaskStartToCloseTimeout
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
java.lang.String defaultExecutionStartToCloseTimeout
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
TaskList defaultTaskList
StartChildWorkflowExecution Decision.java.lang.String defaultChildPolicy
StartChildWorkflowExecution Decision. The
supported child policies are: WorkflowExecutionCancelRequested event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
WorkflowTypeInfo typeInfo
The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.
WorkflowTypeConfiguration configuration
WorkflowType workflowType
java.lang.String status
Constraints:
Allowed Values: REGISTERED, DEPRECATED
java.lang.String description
Constraints:
Length: 0 - 1024
java.util.Date creationDate
java.util.Date deprecationDate
ListWithAutoConstructFlag<T> typeInfos
java.lang.String nextPageToken
Constraints:
Length: 0 - 2048
java.lang.String topicArn
java.lang.String label
ListWithAutoConstructFlag<T> aWSAccountIds
ListWithAutoConstructFlag<T> actionNames
Valid values: any Amazon SNS action name.
java.lang.String topicArn
java.lang.String token
Subscribe action.java.lang.String authenticateOnUnsubscribe
true and the request has an
AWS signature, then only the topic owner and the subscription owner
can unsubscribe the endpoint. The unsubscribe action will require AWS
authentication.java.lang.String topicArn
java.util.Map<K,V> attributes
SubscriptionArn -- the
subscription's ARNTopicArn -- the topic ARN
which the subscription is associated withOwner
-- the AWS account ID of the subscription's ownerConfirmationWasAuthenticated -- true if the
subscription confirmation request was authenticatedDeliveryPolicy -- the JSON serialization of the
subscription's delivery policyEffectiveDeliveryPolicy -- the JSON serialization of
the effective delivery policy which takes into the topic delivery
policy and account system defaultsjava.util.Map<K,V> attributes
TopicArn -- the topic's ARNOwner -- the AWS account ID of the topic's ownerPolicy -- the JSON serialization of the topic's
access control policyDisplayName -- the
human-readable name used in the "From" field for notifications to
email and email-json endpointsSubscriptionsPending -- the number of subscriptions
pending confirmation on this topicSubscriptionsConfirmed -- the number of confirmed
subscriptions on this topicSubscriptionsDeleted
-- the number of deleted subscriptions on this topicDeliveryPolicy -- the JSON serialization of the
topic's delivery policyEffectiveDeliveryPolicy
-- the JSON serialization of the effective delivery policy that takes
into account system defaultsListWithAutoConstructFlag<T> subscriptions
java.lang.String nextToken
ListSubscriptionsByTopic
request. This element is returned if there are more subscriptions to
retrieve.ListWithAutoConstructFlag<T> subscriptions
java.lang.String nextToken
ListSubscriptions
request. This element is returned if there are more subscriptions to
retrieve.ListWithAutoConstructFlag<T> topics
java.lang.String nextToken
ListTopics request. This
element is returned if there are additional topics to retrieve.java.lang.String topicArn
java.lang.String message
If you want to send the same message to all transport protocols, include the text of the message as a String value.
If you want to send different messages
for each transport protocol, set the value of the
MessageStructure parameter to json and use a
JSON object for the Message parameter. See the Examples
section for the format of the JSON object.
Constraints: Messages must be UTF-8 encoded strings at most 64 KB in size (65536 bytes, not 65536 characters).
JSON-specific constraints:
Publish call to return an error (no partial
delivery).java.lang.String subject
Constraints: Subjects must be ASCII text that begins with a letter, number or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
java.lang.String messageStructure
MessageStructure to json if you want to
send a different message for each protocol. For example, using one
publish action, you can send a short message to your SMS subscribers
and a longer message to your email subscribers. If you set
MessageStructure to json, the value of the
Message parameter must: You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").
For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide.
Valid value:
json
java.lang.String subscriptionArn
java.lang.String attributeName
Valid values:
DeliveryPolicy
java.lang.String attributeValue
java.lang.String topicArn
java.lang.String attributeName
Valid values: Policy |
DisplayName | DeliveryPolicy
java.lang.String attributeValue
java.lang.String topicArn
java.lang.String protocol
http -- delivery of JSON-encoded message via HTTP
POSThttps -- delivery of JSON-encoded message
via HTTPS POSTemail -- delivery of message via
SMTPemail-json -- delivery of JSON-encoded
message via SMTPsms -- delivery of message via
SMSsqs -- delivery of JSON-encoded message to
an Amazon SQS queuejava.lang.String endpoint
http protocol, the endpoint is
an URL beginning with "http://"https
protocol, the endpoint is a URL beginning with "https://"email protocol, the endpoint is an email addressemail-json protocol, the endpoint is an email
addresssms protocol, the endpoint is a
phone number of an SMS-enabled devicesqs protocol, the endpoint is the ARN of an Amazon SQS
queuejava.lang.String subscriptionArn
java.lang.String owner
java.lang.String protocol
java.lang.String endpoint
java.lang.String topicArn
java.lang.String queueUrl
java.lang.String label
ListWithAutoConstructFlag<T> aWSAccountIds
ListWithAutoConstructFlag<T> nIFTYAccountIds
ListWithAutoConstructFlag<T> actions
java.lang.String queueUrl
ListWithAutoConstructFlag<T> entries
ListWithAutoConstructFlag<T> successful
ListWithAutoConstructFlag<T> failed
java.util.Date timestamp
java.lang.Double sampleCount
java.lang.Double sum
java.lang.String niftyTargetName
java.lang.String queueUrl
ListWithAutoConstructFlag<T> entries
ListWithAutoConstructFlag<T> successful
ListWithAutoConstructFlag<T> failed
java.lang.String queueUrl
ListWithAutoConstructFlag<T> attributeNames
ListWithAutoConstructFlag<T> queueUrls
java.lang.String metricName
前提条件
文字長: 1 - 255
ListWithAutoConstructFlag<T> dimensions
前提条件
文字長: 0 - 10
java.util.Date startTime
java.util.Date endTime
java.lang.String label
ListWithAutoConstructFlag<T> datapoints
java.lang.String queueUrl
ListWithAutoConstructFlag<T> attributeNames
java.lang.Integer maxNumberOfMessages
java.lang.Integer visibilityTimeout
java.lang.Integer waitTimeSeconds
ListWithAutoConstructFlag<T> messages
java.lang.String queueUrl
ListWithAutoConstructFlag<T> entries
ListWithAutoConstructFlag<T> successful
ListWithAutoConstructFlag<T> failed
java.lang.String activationKey
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
java.lang.String gatewayName
Constraints:
Length: 2 - 255
Pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$
java.lang.String gatewayTimezone
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
java.lang.String gatewayRegion
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
java.lang.String gatewayType
STORED.
Constraints:
Allowed Values: STORED, CACHED
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
ListWithAutoConstructFlag<T> diskIds
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
ListWithAutoConstructFlag<T> diskIds
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
ListWithAutoConstructFlag<T> diskIds
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String volumeARN
Constraints:
Length: 50 - 500
java.lang.String volumeId
Constraints:
Length: 12 - 30
java.lang.String volumeType
Constraints:
Allowed Values: STORED iSCSI, CACHED iSCSI
java.lang.String volumeStatus
Constraints:
Allowed Values: CREATING, AVAILABLE, RESTORING, BOOTSTRAPPING, IRRECOVERABLE, PASS THROUGH, RESTORE AND PASS THROUGH, DELETED, WORKING STORAGE NOT CONFIGURED, UPLOAD BUFFER NOT CONFIGURED
java.lang.Long volumeSizeInBytes
java.lang.Double volumeProgress
java.lang.String sourceSnapshotId
Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z
VolumeiSCSIAttributes volumeiSCSIAttributes
java.lang.String targetARN
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
Constraints:
Length: 50 - 800
java.lang.String secretToAuthenticateInitiator
Constraints:
Length: 12 - 16
java.lang.String initiatorName
Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+
java.lang.String secretToAuthenticateTarget
Constraints:
Length: 12 - 16
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.Long volumeSizeInBytes
java.lang.String snapshotId
Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z
java.lang.String targetName
Constraints:
Length: 1 - 200
Pattern: ^[-\.;a-z0-9]+$
java.lang.String networkInterfaceId
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
java.lang.String clientToken
Constraints:
Length: 5 - 100
java.lang.String volumeARN
Constraints:
Length: 50 - 500
java.lang.String snapshotDescription
Length: Minimum length of 1. Maximum length of 255.
Constraints:
Length: 1 - 255
java.lang.String snapshotId
Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z
java.lang.String volumeARN
Constraints:
Length: 50 - 500
java.lang.String volumeRecoveryPointTime
java.lang.String volumeARN
Constraints:
Length: 50 - 500
java.lang.String snapshotDescription
Constraints:
Length: 1 - 255
java.lang.String volumeARN
Constraints:
Length: 50 - 500
java.lang.String snapshotId
DescribeSnapshots) or creating a volume from a
snapshot (CreateStorediSCSIVolume).
Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String diskId
Constraints:
Length: 1 - 300
java.lang.String snapshotId
Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z
java.lang.Boolean preserveExistingData
Valid Values: true, false
java.lang.String targetName
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]+$
java.lang.String networkInterfaceId
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
java.lang.String volumeARN
Constraints:
Length: 50 - 500
java.lang.Long volumeSizeInBytes
java.lang.String targetARN
Constraints:
Length: 50 - 800
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String bandwidthType
Valid Values:
Upload, Download, All
Constraints:
Allowed Values: UPLOAD, DOWNLOAD, ALL
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String targetARN
Constraints:
Length: 50 - 800
java.lang.String initiatorName
Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String volumeARN
Constraints:
Length: 50 - 500
java.lang.String volumeARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.Long averageUploadRateLimitInBitsPerSec
Constraints:
Range: 51200 -
java.lang.Long averageDownloadRateLimitInBitsPerSec
Constraints:
Range: 102400 -
ListWithAutoConstructFlag<T> volumeARNs
ListWithAutoConstructFlag<T> cachediSCSIVolumes
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
ListWithAutoConstructFlag<T> diskIds
DiskIds array is empty.java.lang.Long cacheAllocatedInBytes
java.lang.Double cacheUsedPercentage
java.lang.Double cacheDirtyPercentage
java.lang.Double cacheHitPercentage
java.lang.Double cacheMissPercentage
java.lang.String targetARN
Constraints:
Length: 50 - 800
ListWithAutoConstructFlag<T> chapCredentials
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.
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayId
Constraints:
Length: 12 - 30
java.lang.String gatewayTimezone
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
java.lang.String gatewayState
Constraints:
Allowed Values: RUNNING, SHUTDOWN
ListWithAutoConstructFlag<T> gatewayNetworkInterfaces
java.lang.String gatewayType
Constraints:
Allowed Values: STORED, CACHED
java.lang.String nextUpdateAvailabilityDate
Constraints:
Length: 1 - 25
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.Integer hourOfDay
Constraints:
Range: 0 - 23
java.lang.Integer minuteOfHour
Constraints:
Range: 0 - 59
java.lang.Integer dayOfWeek
Constraints:
Range: 0 - 6
java.lang.String timezone
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
java.lang.String volumeARN
Constraints:
Length: 50 - 500
java.lang.String volumeARN
Constraints:
Length: 50 - 500
java.lang.Integer startAt
Constraints:
Range: 0 - 23
java.lang.Integer recurrenceInHours
Constraints:
Range: 1 - 24
java.lang.String description
Constraints:
Length: 1 - 255
java.lang.String timezone
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
ListWithAutoConstructFlag<T> volumeARNs
ListWithAutoConstructFlag<T> storediSCSIVolumes
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.
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
ListWithAutoConstructFlag<T> diskIds
DiskIds array is
empty.java.lang.Long uploadBufferUsedInBytes
java.lang.Long uploadBufferAllocatedInBytes
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
ListWithAutoConstructFlag<T> diskIds
java.lang.Long workingStorageUsedInBytes
java.lang.Long workingStorageAllocatedInBytes
java.lang.String diskId
Constraints:
Length: 1 - 300
java.lang.String diskPath
java.lang.String diskNode
java.lang.Long diskSizeInBytes
java.lang.String diskAllocationType
Constraints:
Allowed Values: AVAILABLE, CACHE STORAGE, STORED iSCSI VOLUME, UPLOAD BUFFER, WORKING STORAGE
java.lang.String diskAllocationResource
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
StorageGatewayError error
StorageGatewayError error
java.lang.String marker
Constraints:
Length: 1 - 1000
java.lang.Integer limit
Constraints:
Range: 1 -
ListWithAutoConstructFlag<T> gateways
java.lang.String marker
Constraints:
Length: 1 - 1000
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
ListWithAutoConstructFlag<T> disks
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
ListWithAutoConstructFlag<T> volumeRecoveryPointInfos
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String marker
Constraints:
Length: 1 - 1000
java.lang.Integer limit
Constraints:
Range: 1 -
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String marker
Constraints:
Length: 1 - 1000
ListWithAutoConstructFlag<T> volumeInfos
VolumeInfos is an empty array "[]".java.lang.String ipv4Address
java.lang.String macAddress
java.lang.String ipv6Address
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String errorCode
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
java.util.Map<K,V> errorDetails
java.lang.String volumeARN
Constraints:
Length: 50 - 500
java.lang.String volumeId
Constraints:
Length: 12 - 30
java.lang.String volumeType
Constraints:
Allowed Values: STORED iSCSI, CACHED iSCSI
java.lang.String volumeStatus
Constraints:
Allowed Values: CREATING, AVAILABLE, RESTORING, BOOTSTRAPPING, IRRECOVERABLE, PASS THROUGH, RESTORE AND PASS THROUGH, DELETED, WORKING STORAGE NOT CONFIGURED, UPLOAD BUFFER NOT CONFIGURED
java.lang.Long volumeSizeInBytes
java.lang.Double volumeProgress
java.lang.String volumeDiskId
Constraints:
Length: 1 - 300
java.lang.String sourceSnapshotId
Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z
java.lang.Boolean preservedExistingData
Valid Values: true, false
VolumeiSCSIAttributes volumeiSCSIAttributes
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.Long averageUploadRateLimitInBitsPerSec
Constraints:
Range: 51200 -
java.lang.Long averageDownloadRateLimitInBitsPerSec
Constraints:
Range: 102400 -
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String targetARN
Constraints:
Length: 50 - 800
java.lang.String secretToAuthenticateInitiator
Constraints:
Length: 12 - 16
java.lang.String initiatorName
Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+
java.lang.String secretToAuthenticateTarget
Constraints:
Length: 12 - 16
java.lang.String targetARN
Constraints:
Length: 50 - 800
java.lang.String initiatorName
Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayName
Constraints:
Length: 2 - 255
Pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$
java.lang.String gatewayTimezone
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
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.Integer hourOfDay
Constraints:
Range: 0 - 23
java.lang.Integer minuteOfHour
Constraints:
Range: 0 - 59
java.lang.Integer dayOfWeek
Constraints:
Range: 0 - 6
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String volumeARN
Constraints:
Length: 50 - 500
java.lang.Integer startAt
Constraints:
Range: 0 - 23
java.lang.Integer recurrenceInHours
Constraints:
Range: 1 - 24
java.lang.String description
Constraints:
Length: 1 - 255
java.lang.String volumeARN
Constraints:
Length: 50 - 500
java.lang.String volumeARN
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
java.lang.String volumeType
Constraints:
Allowed Values: STORED iSCSI, CACHED iSCSI
java.lang.String targetARN
Constraints:
Length: 50 - 800
java.lang.String networkInterfaceId
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
java.lang.Integer networkInterfacePort
java.lang.Integer lunNumber
Constraints:
Range: 1 -
java.lang.Boolean chapEnabled
java.lang.String volumeARN
Constraints:
Length: 50 - 500
java.lang.Long volumeSizeInBytes
java.lang.Long volumeUsageInBytes
java.lang.String volumeRecoveryPointTime
java.lang.String caseId
java.lang.String communicationBody
Constraints:
Length: 1 - 8000
ListWithAutoConstructFlag<T> ccEmailAddresses
Constraints:
Length: 0 - 10
java.lang.Boolean result
java.lang.String caseId
java.lang.String displayId
java.lang.String subject
java.lang.String status
java.lang.String serviceCode
java.lang.String categoryCode
java.lang.String severityCode
java.lang.String submittedBy
java.lang.String timeCreated
RecentCaseCommunications recentCommunications
ListWithAutoConstructFlag<T> ccEmailAddresses
java.lang.String language
java.lang.String caseId
java.lang.String body
java.lang.String submittedBy
java.lang.String timeCreated
java.lang.String subject
java.lang.String serviceCode
Constraints:
Pattern: [0-9a-z\-_]+
java.lang.String severityCode
java.lang.String categoryCode
java.lang.String communicationBody
Constraints:
Length: 1 - 8000
ListWithAutoConstructFlag<T> ccEmailAddresses
Constraints:
Length: 0 - 10
java.lang.String language
java.lang.String issueType
ListWithAutoConstructFlag<T> caseIdList
Constraints:
Length: 0 - 100
java.lang.String displayId
java.lang.String afterTime
java.lang.String beforeTime
java.lang.Boolean includeResolvedCases
java.lang.String nextToken
java.lang.Integer maxResults
Constraints:
Range: 10 - 100
java.lang.String language
ListWithAutoConstructFlag<T> cases
java.lang.String nextToken
java.lang.String caseId
java.lang.String beforeTime
java.lang.String afterTime
java.lang.String nextToken
java.lang.Integer maxResults
Constraints:
Range: 10 - 100
ListWithAutoConstructFlag<T> communications
java.lang.String nextToken
ListWithAutoConstructFlag<T> serviceCodeList
Constraints:
Length: 0 - 100
java.lang.String language
ListWithAutoConstructFlag<T> services
java.lang.String language
ListWithAutoConstructFlag<T> severityLevels
ListWithAutoConstructFlag<T> checkIds
ListWithAutoConstructFlag<T> statuses
java.lang.String checkId
java.lang.String language
TrustedAdvisorCheckResult result
java.lang.String language
ListWithAutoConstructFlag<T> checks
ListWithAutoConstructFlag<T> checkIds
ListWithAutoConstructFlag<T> summaries
ListWithAutoConstructFlag<T> communications
java.lang.String nextToken
TrustedAdvisorCheckRefreshStatus status
java.lang.String initialCaseStatus
java.lang.String finalCaseStatus
java.lang.String code
java.lang.String name
ListWithAutoConstructFlag<T> categories
java.lang.String code
SeverityLevel.name.java.lang.String name
TrustedAdvisorCostOptimizingSummary costOptimizing
java.lang.String id
java.lang.String name
java.lang.String description
java.lang.String category
ListWithAutoConstructFlag<T> metadata
java.lang.String checkId
java.lang.String status
java.lang.Long millisUntilNextRefreshable
java.lang.String checkId
java.lang.String timestamp
java.lang.String status
TrustedAdvisorResourcesSummary resourcesSummary
TrustedAdvisorCategorySpecificSummary categorySpecificSummary
ListWithAutoConstructFlag<T> flaggedResources
java.lang.String checkId
java.lang.String timestamp
java.lang.String status
java.lang.Boolean hasFlaggedResources
TrustedAdvisorResourcesSummary resourcesSummary
TrustedAdvisorCategorySpecificSummary categorySpecificSummary
java.lang.Double estimatedMonthlySavings
java.lang.Double estimatedPercentMonthlySavings
java.lang.String status
java.lang.String region
java.lang.String resourceId
java.lang.Boolean isSuppressed
ListWithAutoConstructFlag<T> metadata
java.lang.Long resourcesProcessed
java.lang.Long resourcesFlagged
java.lang.Long resourcesIgnored
java.lang.Long resourcesSuppressed