String activityId
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String description
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String cause
Constraints:
Length: 1 - 1023
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Date startTime
Date endTime
String statusCode
Constraints:
Allowed Values: WaitingForSpotInstanceRequestId, WaitingForSpotInstanceId, WaitingForInstanceId, PreInService, InProgress, WaitingForELBConnectionDraining, MidLifecycleAction, Successful, Failed, Cancelled
String statusMessage
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer progress
String details
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String adjustmentType
ChangeInCapacity
, ExactCapacity
, and
PercentChangeInCapacity
.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String alarmName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String alarmARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer minSize
Integer maxSize
Integer desiredCapacity
Integer defaultCooldown
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Constraints:
Length: 1 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
String healthCheckType
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer healthCheckGracePeriod
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
Date createdTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> suspendedProcesses
String placementGroup
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String vPCZoneIdentifier
When
you specify VPCZoneIdentifier
with
AvailabilityZones
, ensure that the subnets' Availability
Zones match the values you specify for AvailabilityZones
.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> enabledMetrics
String status
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> terminationPolicies
String instanceId
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String availabilityZone
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String lifecycleState
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String healthStatus
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String virtualName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String deviceName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Ebs ebs
Boolean noDevice
NoDevice
is set
to true
for the root device, the instance might fail the
EC2 health check. Auto Scaling launches a replacement instance if the
instance fails the health check.String lifecycleHookName
Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String lifecycleActionToken
Constraints:
Length: 36 - 36
String lifecycleActionResult
CONTINUE
or ABANDON
.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String launchConfigurationName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String instanceId
When you use an instance to create an Auto Scaling group, a new
launch configuration is first created and then associated with the
Auto Scaling group. The new launch configuration derives all its
attributes from the instance that is used to create the Auto Scaling
group, with the exception of BlockDeviceMapping
.
For more information, see Create an Auto Scaling Group Using EC2 Instance in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer minSize
Integer maxSize
Integer desiredCapacity
Integer defaultCooldown
If a
DefaultCooldown
period is not specified, Auto Scaling
uses the default value of 300 as the default cool down period for the
Auto Scaling group. For more information, see Cooldown
Period
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Constraints:
Length: 1 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
For information on using load balancers, see Load Balance Your Auto Scaling Group in the Auto Scaling Developer Guide.
String healthCheckType
EC2
or ELB
.
By default, the Auto Scaling health check uses the results of Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Check.
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer healthCheckGracePeriod
This is
required if you are adding ELB
health check. Frequently,
new instances need to warm up, briefly, before they can pass a health
check. To provide ample warm-up time, set the health check grace
period of the group to match the expected startup period of your
application.
For more information, see Add an Elastic Load Balancing Health Check.
String placementGroup
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String vPCZoneIdentifier
If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.
For information on launching your Auto Scaling group into Amazon VPC subnets, see Auto Scaling in Amazon Virtual Private Cloud in the Auto Scaling Developer Guide .
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> terminationPolicies
For more information on configuring a termination policy for your Auto Scaling group, see Instance Termination Policy for Your Auto Scaling Group in the Auto Scaling Developer Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
For information about using tags, see Tag Your Auto Scaling Groups and Amazon EC2 Instances in the Auto Scaling Developer Guide.
String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String imageId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String keyName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
If your instances are launched in EC2, you can either specify Amazon EC2 security group names or the security group IDs. For more information about Amazon EC2 security groups, see Using Security Groups in the Amazon Elastic Compute Cloud User Guide.
If your instances are launched within VPC, specify Amazon VPC security group IDs. For more information about Amazon VPC security groups, see Security Groups in the Amazon Virtual Private Cloud User Guide.
String userData
Constraints:
Length: 0 - 21847
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String instanceId
When you use an
instance to create a launch configuration, all you need to specify is
the InstanceId
. The new launch configuration, by default,
derives all the attributes from the specified instance with the
exception of BlockDeviceMapping
.
If you want to create
a launch configuration with BlockDeviceMapping
or
override any other instance attributes, specify them as part of the
same request.
For more information on using an InstanceID to create a launch configuration, see Create a Launch Configuration Using an Amazon EC2 Instance in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String instanceType
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String kernelId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String ramdiskId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
InstanceMonitoring instanceMonitoring
When detailed monitoring is enabled, Amazon
Cloudwatch will generate metrics every minute and your account will be
charged a fee. When you disable detailed monitoring, by specifying
False
, Cloudwatch will generate metrics every 5 minutes.
For more information, see Monitor
Your Auto Scaling Instances. For information about Amazon
CloudWatch, see the Amazon
CloudWatch Developer Guide.
String spotPrice
Constraints:
Length: 1 - 255
String iamInstanceProfile
Amazon EC2 instances launched with an IAM role will automatically have AWS security credentials available. You can use IAM roles with Auto Scaling to automatically enable applications running on your Amazon EC2 instances to securely access other AWS resources. For information on launching EC2 instances with an IAM role, go to Launching Auto Scaling Instances With an IAM Role in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean ebsOptimized
Boolean associatePublicIpAddress
If you specify a value for this parameter, be sure to specify at least one VPC subnet using the VPCZoneIdentifier parameter when you create your Auto Scaling group.
Default: If the instance is launched into a
default subnet in a default VPC, the default is true
. If
the instance is launched into a nondefault subnet in a VPC, the
default is false
. For information about default VPC and
VPC platforms, see Supported
Platforms.
String placementTenancy
dedicated
runs on single-tenant hardware and can only be
launched in a VPC. You must set the value of this parameter to
dedicated
if want to launch Dedicated Instances in a
shared tenancy VPC (VPC with instance placement tenancy attribute set
to default
).
If you specify a value for this parameter, be sure to specify at least one VPC subnet using the VPCZoneIdentifier parameter when you create your Auto Scaling group.
For more information, see Auto Scaling in Amazon Virtual Private Cloud in the Auto Scaling Developer Guide.
Valid values: default
|
dedicated
Constraints:
Length: 1 - 64
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
auto-scaling-group
is the only supported resource type.
The valid value for the resource ID is groupname. The
PropagateAtLaunch
flag defines whether the new tag will
be applied to instances launched by the Auto Scaling group. Valid
values are true
or false
. However, instances
that are already running will not get the new or updated tag.
Likewise, when you modify a tag, the updated version will be applied
only to new instances launched by the Auto Scaling group after the
change. Running instances that had the previous version of the tag
will continue to have the older tag.
When you create a tag and a tag of the same name already exists, the operation overwrites the previous tag definition, but you will not get an error message.
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean forceDelete
String launchConfigurationName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String lifecycleHookName
Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String topicARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String policyName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String scheduledActionName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> adjustmentTypes
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingGroupNames
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer maxRecords
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingGroups
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
Integer maxRecords
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingInstances
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingNotificationTypes
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
com.amazonaws.internal.ListWithAutoConstructFlag<T> launchConfigurationNames
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer maxRecords
com.amazonaws.internal.ListWithAutoConstructFlag<T> launchConfigurations
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> lifecycleHookNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> lifecycleHooks
com.amazonaws.internal.ListWithAutoConstructFlag<T> lifecycleHookTypes
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
com.amazonaws.internal.ListWithAutoConstructFlag<T> metrics
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
The GroupStandbyInstances
metric is not
returned by default. You must explicitly request it when calling
EnableMetricsCollection.
com.amazonaws.internal.ListWithAutoConstructFlag<T> granularities
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingGroupNames
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer maxRecords
com.amazonaws.internal.ListWithAutoConstructFlag<T> notificationConfigurations
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer maxRecords
com.amazonaws.internal.ListWithAutoConstructFlag<T> scalingPolicies
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> activityIds
AutoScalingGroupName
is provided, the results are limited
to that group. The list of requested activities cannot contain more
than 50 items. If unknown activities are requested, they are ignored
with no error.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer maxRecords
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> activities
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> processes
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> scheduledActionNames
Date startTime
Date endTime
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer maxRecords
com.amazonaws.internal.ListWithAutoConstructFlag<T> scheduledUpdateGroupActions
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer maxRecords
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> terminationPolicyTypes
OldestInstance
, OldestLaunchConfiguration
,
NewestInstance
, ClosestToNextInstanceHour
,
Default
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean shouldDecrementDesiredCapacity
True
, the Auto Scaling group decrements the desired
capacity value by the number of instances detached.com.amazonaws.internal.ListWithAutoConstructFlag<T> activities
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> metrics
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
String snapshotId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer volumeSize
Valid values: If the volume type is
io1
, the minimum size of the volume is 10.
Default: If you're creating the volume from a snapshot, and you don't specify a volume size, the default is the snapshot size.
Required: Required
when the volume type is io1
.
Constraints:
Range: 1 - 1024
String volumeType
Valid values: standard | io1
Default: standard
Constraints:
Length: 1 - 255
Boolean deleteOnTermination
Default: true
Integer iops
The maximum ratio of IOPS to volume size is 30.0
Valid Values: Range is 100 to 4000.
Default: None.
Constraints:
Range: 100 - 4000
String metric
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String granularity
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> metrics
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
The GroupStandbyInstances
metric is not
returned by default. You must explicitly request it when calling
EnableMetricsCollection.
String granularity
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean shouldDecrementDesiredCapacity
com.amazonaws.internal.ListWithAutoConstructFlag<T> activities
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String policyName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean honorCooldown
True
if you want Auto Scaling to wait for the
cooldown period associated with the Auto Scaling group to complete
before executing the policy. Set to False
if you want
Auto Scaling to circumvent the cooldown period associated with the
Auto Scaling group and execute the policy before the cooldown period
ends.
For information about cooldown period, see Cooldown Period in the Auto Scaling Developer Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> activities
String name
"auto-scaling-group"
, "key"
,
"value"
, and "propagate-at-launch"
.
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
String instanceId
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String availabilityZone
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String lifecycleState
The Quarantined
lifecycle state is currently not used.
Constraints:
Allowed Values: Pending, Pending:Wait, Pending:Proceed, Quarantined, InService, Terminating, Terminating:Wait, Terminating:Proceed, Terminated, Detaching, Detached, EnteringStandby, Standby
String healthStatus
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean enabled
True
, instance monitoring is enabled.String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String launchConfigurationARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String imageId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String keyName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
String userData
Constraints:
Length: 0 - 21847
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String instanceType
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String kernelId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String ramdiskId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
InstanceMonitoring instanceMonitoring
String spotPrice
Constraints:
Length: 1 - 255
String iamInstanceProfile
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Date createdTime
Boolean ebsOptimized
Boolean associatePublicIpAddress
true
) or not (false
).String placementTenancy
default
or dedicated
. An instance with
dedicated
tenancy runs in an isolated, single-tenant
hardware and it can only be launched in a VPC.
Constraints:
Length: 1 - 64
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String lifecycleHookName
Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String lifecycleTransition
String notificationTargetARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String roleARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String notificationMetadata
Constraints:
Length: 1 - 1023
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer heartbeatTimeout
DefaultResult
parameter. You
can prevent the lifecycle hook from timing out by calling
RecordLifecycleActionHeartbeat.Integer globalTimeout
Pending:Wait
or Terminating:Wait
state.
Currently, this value is set at 48 hours.String defaultResult
CONTINUE
or
ABANDON
. The default value for this parameter is
CONTINUE
.String metric
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String granularity
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String topicARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String notificationType
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String processName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String lifecycleHookName
Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String lifecycleTransition
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
String roleARN
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String notificationTargetARN
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
The notification message sent to the target will include:
This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.
When you call this operation,
a test message is sent to the notification target. This test message
contains an additional key/value pair:
Event:autoscaling:TEST_NOTIFICATION
.
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String notificationMetadata
Constraints:
Length: 1 - 1023
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer heartbeatTimeout
DefaultResult
parameter. You can prevent the lifecycle hook from timing out by
calling RecordLifecycleActionHeartbeat. The default value for
this parameter is 3600 seconds (1 hour).String defaultResult
CONTINUE
or
ABANDON
. The default value for this parameter is
ABANDON
.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String topicARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> notificationTypes
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String policyName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer scalingAdjustment
AdjustmentType
determines the interpretation of this number (e.g., as an absolute
number or as a percentage of the existing Auto Scaling group size). A
positive increment adds to the current capacity and a negative value
removes from the current capacity.String adjustmentType
ScalingAdjustment
is an absolute
number or a percentage of the current capacity. Valid values are
ChangeInCapacity
, ExactCapacity
, and
PercentChangeInCapacity
. For more information about the adjustment types supported by Auto Scaling, see Scale Based on Demand.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer cooldown
For more information, see Cooldown Period
Integer minAdjustmentStep
AdjustmentType
with the value
PercentChangeInCapacity
, the scaling policy changes the
DesiredCapacity
of the Auto Scaling group by at least the
number of instances specified in the value. You will get a
ValidationError
if you use MinAdjustmentStep
on a policy with an AdjustmentType
other than
PercentChangeInCapacity
.
String policyARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String scheduledActionName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Date time
Time
is deprecated. The time for this action to start.
Time
is an alias for StartTime
and can be
specified instead of StartTime
, or vice versa. If both
Time
and StartTime
are specified, their
values should be identical. Otherwise,
PutScheduledUpdateGroupAction
will return an error.
Date startTime
--start-time
2010-06-01T00:00:00Z
. If you try to schedule your action in the past, Auto Scaling returns an error message.
When
StartTime
and EndTime
are specified with
Recurrence
, they form the boundaries of when the
recurring action will start and stop.
Date endTime
String recurrence
When StartTime
and
EndTime
are specified with Recurrence
, they
form the boundaries of when the recurring action will start and stop.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer minSize
Integer maxSize
Integer desiredCapacity
String lifecycleHookName
Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String lifecycleActionToken
Constraints:
Length: 36 - 36
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> scalingProcesses
To suspend all process types, omit this parameter.
String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String policyName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer scalingAdjustment
String adjustmentType
ScalingAdjustment
is an absolute
number or a percentage of the current capacity. Valid values are
ChangeInCapacity
, ExactCapacity
, and
PercentChangeInCapacity
.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer cooldown
String policyARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> alarms
Integer minAdjustmentStep
DesiredCapacity
of the Auto Scaling group by
at least the specified number of instances.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String scheduledActionName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String scheduledActionARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Date time
Time
is deprecated. The time that the action is
scheduled to begin. Time
is an alias for
StartTime
.
Date startTime
When StartTime
and
EndTime
are specified with Recurrence
, they
form the boundaries of when the recurring action will start and stop.
Date endTime
String recurrence
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer minSize
Integer maxSize
Integer desiredCapacity
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer desiredCapacity
Boolean honorCooldown
SetDesiredCapacity
overrides any cooldown
period associated with the Auto Scaling group. Set to
True
if you want Auto Scaling to wait for the cooldown
period associated with the Auto Scaling group to complete before
initiating a scaling activity to set your Auto Scaling group to the
new capacity setting.String instanceId
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String healthStatus
Healthy
if you
want the instance to remain in service. Set to Unhealthy
if you want the instance to be out of service. Auto Scaling will
terminate and replace the unhealthy instance.
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean shouldRespectGracePeriod
HealthCheckGracePeriod
specified for the group, by
default, this call will respect the grace period. Set this to
False
, if you do not want the call to respect the grace
period associated with the group. For more information, see the
HealthCheckGracePeriod
parameter description in the
CreateAutoScalingGroup action.
String processName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String suspensionReason
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> scalingProcesses
To suspend all process types, omit this parameter.
String resourceId
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String resourceType
auto-scaling-group
resource type.
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String key
Constraints:
Length: 1 - 128
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String value
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean propagateAtLaunch
String resourceId
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String resourceType
auto-scaling-group
resource type.
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String key
Constraints:
Length: 1 - 128
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String value
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean propagateAtLaunch
String instanceId
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean shouldDecrementDesiredCapacity
Activity activity
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String launchConfigurationName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer minSize
Integer maxSize
Integer desiredCapacity
Integer defaultCooldown
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Constraints:
Length: 1 -
String healthCheckType
EC2
for Amazon EC2 or
ELB
for Elastic Load Balancing.
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer healthCheckGracePeriod
String placementGroup
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String vPCZoneIdentifier
When
you specify VPCZoneIdentifier
with
AvailabilityZones
, ensure that the subnets' Availability
Zones match the values you specify for AvailabilityZones
.
For more information on creating your Auto Scaling group in Amazon VPC by specifying subnets, see Launch Auto Scaling Instances into Amazon VPC in the the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> terminationPolicies
For more information on creating a termination policy for your Auto Scaling group, go to Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.
String stackName
String stackName
String templateBody
Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
Constraints:
Length: 1 -
String templateURL
Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
Parameter
structures that specify input
parameters for the stack.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
Integer timeoutInMinutes
DisableRollback
is not set or is set to
false
, the stack will be rolled back.
Constraints:
Range: 1 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> notificationARNs
Constraints:
Length: 0 - 5
com.amazonaws.internal.ListWithAutoConstructFlag<T> capabilities
String onFailure
OnFailure
or DisableRollback
, but not
both. Default: ROLLBACK
Constraints:
Allowed Values: DO_NOTHING, ROLLBACK, DELETE
String stackPolicyBody
StackPolicyBody
or the
StackPolicyURL
parameter, but not both.
Constraints:
Length: 1 - 16384
String stackPolicyURL
StackPolicyBody
or the StackPolicyURL
parameter, but not both.
Constraints:
Length: 1 - 1350
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Tags
to associate with this stack,
represented by key/value pairs. Tags defined for the stack are
propagated to EC2 resources that are created as part of the stack. A
maximum number of 10 tags can be specified.String stackId
String stackName
String stackName
Default: There is no default value.
String nextToken
Default: There is no default value.
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> stackEvents
StackEvents
structures.String nextToken
Constraints:
Length: 1 - 1024
String stackName
Default: There is no default value.
String logicalResourceId
Default: There is no default value.
StackResourceDetail stackResourceDetail
StackResourceDetail
structure containing the
description of the specified resource in the specified stack.String stackName
Default: There is no default value.
Required: Conditional. If you do not
specify StackName
, you must specify
PhysicalResourceId
.
String logicalResourceId
Default: There is no default value.
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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> stackResources
StackResource
structures.String stackName
Default: There is no default value.
String nextToken
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> stacks
String nextToken
Constraints:
Length: 1 - 1024
String templateBody
Conditional: You
must pass TemplateBody
or TemplateURL
. If
both are passed, only TemplateBody
is used.
Constraints:
Length: 1 -
String templateURL
Conditional: You
must pass TemplateURL
or TemplateBody
. If
both are passed, only TemplateBody
is used.
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
Parameter
structures that specify input
parameters.String url
String stackName
String stackPolicyBody
Constraints:
Length: 1 - 16384
String stackName
Default: There is no default value.
String templateBody
Constraints:
Length: 1 -
String stackName
Default: There is no default value.
String nextToken
Default: There is no default value.
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> stackResourceSummaries
StackResourceSummary
structures.String nextToken
Constraints:
Length: 1 - 1024
String nextToken
Default: There is no default value.
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> stackStatusFilters
StackStatus
parameter of the Stack data type.com.amazonaws.internal.ListWithAutoConstructFlag<T> stackSummaries
StackSummary
structures containing information
about the specified stacks.String nextToken
Constraints:
Length: 1 - 1024
String stackName
String stackPolicyBody
StackPolicyBody
or the
StackPolicyURL
parameter, but not both.
Constraints:
Length: 1 - 16384
String stackPolicyURL
StackPolicyBody
or the StackPolicyURL
parameter, but not both.
Constraints:
Length: 1 - 1350
String stackId
String stackName
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
Parameter
structures.Date creationTime
Date lastUpdatedTime
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
String stackStatusReason
Boolean disableRollback
true
: disable rollbackfalse
: enable rollbackcom.amazonaws.internal.ListWithAutoConstructFlag<T> notificationARNs
Constraints:
Length: 0 - 5
Integer timeoutInMinutes
Constraints:
Range: 1 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> capabilities
com.amazonaws.internal.ListWithAutoConstructFlag<T> outputs
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Tag
s that specify cost allocation information
for the stack.String stackId
String eventId
String stackName
String logicalResourceId
String physicalResourceId
String resourceType
Date timestamp
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
String resourceStatusReason
String resourceProperties
String stackName
String stackId
String logicalResourceId
String physicalResourceId
String resourceType
Date timestamp
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
String resourceStatusReason
String description
String stackName
String stackId
String logicalResourceId
String physicalResourceId
String resourceType
Date lastUpdatedTimestamp
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
String resourceStatusReason
String description
String metadata
Metadata
attribute
declared for the resource. For more information, see Metadata
Attribute in the AWS CloudFormation User Guide.String logicalResourceId
String physicalResourceId
String resourceType
Date lastUpdatedTimestamp
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
String resourceStatusReason
String stackId
String stackName
String templateDescription
Date creationTime
Date lastUpdatedTime
Date deletionTime
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
String stackStatusReason
String key
aws:
.String value
String parameterKey
String defaultValue
Boolean noEcho
String description
String stackName
String templateBody
Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
Constraints:
Length: 1 -
String templateURL
Conditional: You
must specify either the TemplateBody
or the
TemplateURL
parameter, but not both.
Constraints:
Length: 1 - 1024
Boolean usePreviousTemplate
String stackPolicyDuringUpdateBody
StackPolicyDuringUpdateBody
or the
StackPolicyDuringUpdateURL
parameter, but not both. If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
Constraints:
Length: 1 - 16384
String stackPolicyDuringUpdateURL
StackPolicyDuringUpdateBody
or the
StackPolicyDuringUpdateURL
parameter, but not both. If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
Constraints:
Length: 1 - 1350
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
Parameter
structures that specify input
parameters for the stack.com.amazonaws.internal.ListWithAutoConstructFlag<T> capabilities
String stackPolicyBody
StackPolicyBody
or the StackPolicyURL
parameter, but not both. You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
Constraints:
Length: 1 - 16384
String stackPolicyURL
StackPolicyBody
or the StackPolicyURL
parameter, but not both. You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
Constraints:
Length: 1 - 1350
com.amazonaws.internal.ListWithAutoConstructFlag<T> notificationARNs
Constraints:
Length: 0 - 5
String stackId
String templateBody
Conditional: You
must pass TemplateURL
or TemplateBody
. If
both are passed, only TemplateBody
is used.
Constraints:
Length: 1 -
String templateURL
Conditional: You
must pass TemplateURL
or TemplateBody
. If
both are passed, only TemplateBody
is used.
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
TemplateParameter
structures.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> capabilities
String capabilitiesReason
Boolean enabled
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String pathPattern
String targetOriginId
ForwardedValues forwardedValues
TrustedSigners trustedSigners
String viewerProtocolPolicy
Constraints:
Allowed Values: allow-all, https-only, redirect-to-https
Long minTTL
AllowedMethods allowedMethods
Boolean smoothStreaming
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String id
String s3CanonicalUserId
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
String callerReference
String comment
String marker
String nextMarker
Integer maxItems
Boolean isTruncated
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String id
String s3CanonicalUserId
String comment
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String forward
Constraints:
Allowed Values: none, whitelist, all
CookieNames whitelistedNames
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity
String location
String eTag
DistributionConfig distributionConfig
Distribution distribution
String location
String eTag
String distributionId
InvalidationBatch invalidationBatch
String location
Invalidation invalidation
StreamingDistributionConfig streamingDistributionConfig
StreamingDistribution streamingDistribution
String location
String eTag
Integer errorCode
String responsePagePath
String responseCode
Long errorCachingMinTTL
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String targetOriginId
ForwardedValues forwardedValues
TrustedSigners trustedSigners
String viewerProtocolPolicy
Constraints:
Allowed Values: allow-all, https-only, redirect-to-https
Long minTTL
AllowedMethods allowedMethods
Boolean smoothStreaming
String id
String status
Date lastModifiedTime
Integer inProgressInvalidationBatches
String domainName
ActiveTrustedSigners activeTrustedSigners
DistributionConfig distributionConfig
String callerReference
Aliases aliases
String defaultRootObject
Origins origins
DefaultCacheBehavior defaultCacheBehavior
CacheBehaviors cacheBehaviors
CustomErrorResponses customErrorResponses
String comment
LoggingConfig logging
String priceClass
Constraints:
Allowed Values: PriceClass_100, PriceClass_200, PriceClass_All
Boolean enabled
ViewerCertificate viewerCertificate
Restrictions restrictions
String marker
String nextMarker
Integer maxItems
Boolean isTruncated
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String id
String status
Date lastModifiedTime
String domainName
Aliases aliases
Origins origins
DefaultCacheBehavior defaultCacheBehavior
CacheBehaviors cacheBehaviors
CustomErrorResponses customErrorResponses
String comment
String priceClass
Boolean enabled
ViewerCertificate viewerCertificate
Restrictions restrictions
Boolean queryString
CookiePreference cookies
Headers headers
String restrictionType
Constraints:
Allowed Values: blacklist, whitelist, none
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String id
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
String eTag
String id
CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity
String eTag
String id
DistributionConfig distributionConfig
String eTag
String id
Distribution distribution
String eTag
Invalidation invalidation
String id
StreamingDistributionConfig streamingDistributionConfig
String eTag
String id
StreamingDistribution streamingDistribution
String eTag
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String id
String status
Date createTime
InvalidationBatch invalidationBatch
Paths paths
String callerReference
String marker
String nextMarker
Integer maxItems
Boolean isTruncated
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String marker
String maxItems
CloudFrontOriginAccessIdentityList cloudFrontOriginAccessIdentityList
String marker
String maxItems
DistributionList distributionList
String distributionId
String marker
String maxItems
InvalidationList invalidationList
String marker
String maxItems
StreamingDistributionList streamingDistributionList
Boolean enabled
Boolean includeCookies
String bucket
String prefix
String id
String domainName
S3OriginConfig s3OriginConfig
CustomOriginConfig customOriginConfig
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
Constraints:
Length: 1 -
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
GeoRestriction geoRestriction
String originAccessIdentity
String awsAccountNumber
KeyPairIds keyPairIds
String id
String status
Date lastModifiedTime
String domainName
ActiveTrustedSigners activeTrustedSigners
StreamingDistributionConfig streamingDistributionConfig
String callerReference
S3Origin s3Origin
Aliases aliases
String comment
StreamingLoggingConfig logging
TrustedSigners trustedSigners
String priceClass
Constraints:
Allowed Values: PriceClass_100, PriceClass_200, PriceClass_All
Boolean enabled
String marker
String nextMarker
Integer maxItems
Boolean isTruncated
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String id
String status
Date lastModifiedTime
String domainName
S3Origin s3Origin
Aliases aliases
TrustedSigners trustedSigners
String comment
String priceClass
Boolean enabled
Boolean enabled
String bucket
String prefix
Boolean enabled
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
String id
String ifMatch
CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity
String eTag
DistributionConfig distributionConfig
String id
String ifMatch
Distribution distribution
String eTag
StreamingDistributionConfig streamingDistributionConfig
String id
String ifMatch
StreamingDistribution streamingDistribution
String eTag
String iAMCertificateId
Boolean cloudFrontDefaultCertificate
String sSLSupportMethod
Constraints:
Allowed Values: sni-only, vip
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
Boolean options
OptionStatus status
String code
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
DomainStatus domainStatus
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
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.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
NamedRankExpression rankExpression
RankExpressionStatus rankExpression
RankExpression
and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
DomainStatus domainStatus
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String indexFieldName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
IndexFieldStatus indexField
IndexField
and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String rankName
RankExpression
to delete.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
RankExpressionStatus rankExpression
RankExpression
and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
AvailabilityOptionsStatus availabilityOptions
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.com.amazonaws.internal.ListWithAutoConstructFlag<T> domainNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainStatusList
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
DescribeIndexFields
response to the specified
fields.com.amazonaws.internal.ListWithAutoConstructFlag<T> indexFields
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> rankNames
DescribeRankExpressions
response to the
specified fields.com.amazonaws.internal.ListWithAutoConstructFlag<T> rankExpressions
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.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
StemmingOptionsStatus stems
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
StopwordOptionsStatus stopwords
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
SynonymOptionsStatus synonyms
String domainId
Constraints:
Length: 1 - 64
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
Boolean created
Boolean deleted
Long numSearchableDocs
Constraints:
Range: 0 -
ServiceEndpoint docService
ServiceEndpoint searchService
Boolean requiresIndexDocuments
Boolean processing
String searchInstanceType
Integer searchPartitionCount
Constraints:
Range: 1 -
Integer searchInstanceCount
Constraints:
Range: 1 -
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
IndexDocuments
action.String indexFieldName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
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.com.amazonaws.internal.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
String defaultValue
Constraints:
Length: 0 - 1024
Boolean searchEnabled
Boolean facetEnabled
Boolean resultEnabled
String rankName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String rankExpression
RankExpression
syntax is
based on JavaScript expressions and supports:a || b
evaluates to the value a
, if a
is true,
without evaluating b
at all+ - * /
%
abs ceil erf exp
floor lgamma ln log2 log10 max min sqrt pow
acosh acos asinh asin atanh
atan cosh cos sinh sin tanh tan
rand
time
min 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
Date creationDate
Date updateDate
Integer updateVersion
Constraints:
Range: 0 -
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
Boolean pendingDeletion
NamedRankExpression options
OptionStatus status
String arn
String endpoint
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
.String sourceName
IndexField
.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String defaultValue
Constraints:
Length: 0 - 1024
String sourceName
IndexField
.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String defaultValue
Constraints:
Length: 0 - 1024
Map<K,V> cases
String sourceName
IndexField
.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String defaultValue
Constraints:
Length: 0 - 1024
String separator
String language
Constraints:
Pattern: [a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*
String options
{ "stems": {"people": "person", "walking":
"walk"} }
OptionStatus status
String options
{ "stopwords": ["a", "an", "the", "of"] }
OptionStatus status
String options
{ "synonyms": {"cat": ["feline",
"kitten"], "puppy": "dog"} }
OptionStatus status
String defaultValue
Constraints:
Length: 0 - 1024
Boolean facetEnabled
Boolean resultEnabled
String textProcessor
cs_text_no_stemming
: turns off stemming for the
field.Default: none
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
Integer defaultValue
Constraints:
Range: 0 -
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
Boolean multiAZ
false
.AvailabilityOptionsStatus availabilityOptions
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String defaultSearchField
q
parameter, or if a match
expression specified with the bq
parameter does not
constrain the search to a particular field. The default is an empty
string, which automatically searches all text fields.DefaultSearchFieldStatus defaultSearchField
DefaultSearchField
configured for this
search domain and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
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.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String stems
{ "stems": {"people": "person", "walking":
"walk"} }
StemmingOptionsStatus stems
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String stopwords
{ "stopwords": ["a", "an", "the", "of"] }
StopwordOptionsStatus stopwords
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String synonyms
{ "synonyms": {"cat": ["feline",
"kitten"], "puppy": "dog"} }
SynonymOptionsStatus synonyms
com.amazonaws.internal.ListWithAutoConstructFlag<T> buckets
String status
String message
Long found
Long start
String cursor
com.amazonaws.internal.ListWithAutoConstructFlag<T> hit
String cursor
size
parameter to control the number of
hits to include in each response. You can specify either the
cursor
or start
parameter in a request; they
are mutually exclusive. To get the first cursor, set the cursor value
to initial
. In subsequent requests, specify the cursor
value returned in the hits section of the response. For more information, see Paginating Results in the Amazon CloudSearch Developer Guide.
String expr
For more information about defining
and using expressions, see Configuring
Expressions in the Amazon CloudSearch Developer Guide.
String facet
{"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}
.
You can specify the following faceting options:
buckets
specifies an array of the facet values or
ranges to count. Ranges are specified using the same syntax that you
use to search for a range of values. For more information, see
Searching for a Range of Values in the Amazon CloudSearch
Developer Guide. Buckets are returned in the order they are
specified in the request. The sort
and size
options are not valid if you specify buckets
.
size
specifies the maximum number of facets to include
in the results. By default, Amazon CloudSearch returns counts for the
top 10. The size
parameter is only valid when you specify
the sort
option; it cannot be used in conjunction with
buckets
.
sort
specifies how
you want to sort the facets in the results: bucket
or
count
. Specify bucket
to sort alphabetically
or numerically by facet value (in ascending order). Specify
count
to sort by the facet counts computed for each facet
value (in descending order). To retrieve facet counts for particular
values or ranges of values, use the buckets
option
instead of sort
.
If no facet options are specified, facet counts are computed for all field values, the facets are sorted by facet count, and the top 10 facets are returned in the results.
For more information, see Getting
and Using Facet Information in the Amazon CloudSearch Developer
Guide. buckets
option to calculate and return facet counts by decade.sort
option to count
to sort the facet
values by facet count, with the facet values that have the most
matching documents listed first. Setting the size
option
to 3 returns only the top three facet values.sort
option to bucket
to
sort the facet values numerically by year, with earliest year listed
first.
String filterQuery
filterQuery
in conjunction with the query
parameter to filter the documents that match the constraints specified
in the query
parameter. Specifying a filter controls only
which matching documents are included in the results, it has no effect
on how they are scored and sorted. The filterQuery
parameter supports the full structured query syntax. For more information about using filters, see Filtering Matching Documents in the Amazon CloudSearch Developer Guide.
String highlight
text
or
text-array
fields. Each specified field must be highlight
enabled in the domain configuration. The fields and options are
specified in JSON using the form
{"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}
.
You can specify the following highlight options:
format
: specifies the format of the data in the text
field: text
or html
. When data is returned
as HTML, all non-alphanumeric characters are encoded. The default is
html
. max_phrases
: specifies the
maximum number of occurrences of the search term(s) you want to
highlight. By default, the first occurrence is highlighted. pre_tag
: specifies the string to prepend to an occurrence
of a search term. The default for HTML highlights is
. The default for text highlights is *
.
post_tag
: specifies the string to append to an
occurrence of a search term. The default for HTML highlights is
. The default for text highlights is *
.
If no highlight options are specified for a field, the
returned field text is treated as HTML and the first match is
highlighted with emphasis tags: search-term
.
actors
and title
fields.
Boolean partial
String query
queryOptions
parameter. By default, the simple
query parser is used to
process requests. To use the structured
,
lucene
, or dismax
query parser, you must
also specify the queryParser
parameter. For more information about specifying search criteria, see Searching Your Data in the Amazon CloudSearch Developer Guide.
String queryOptions
queryParser
parameter. The options you can configure vary according to which parser you use:
defaultOperator
: The default operator used to combine
individual terms in the search string. For example:
defaultOperator: 'or'
. For the dismax
parser, you specify a percentage that represents the percentage of
terms in the search string (rounded down) that must match, rather than
a default operator. A value of 0%
is the equivalent to
OR, and a value of 100%
is equivalent to AND. The
percentage must be specified as a value in the range 0-100 followed by
the percent (%) symbol. For example, defaultOperator:
50%
. Valid values: and
, or
, a
percentage in the range 0%-100% (dismax
). Default:
and
(simple
, structured
,
lucene
) or 100
(dismax
). Valid
for: simple
, structured
,
lucene
, and dismax
.fields
: An array of the fields to search when no
fields are specified in a search. If no fields are specified in a
search and this option is not specified, all text and text-array
fields are searched. You can specify a weight for each field to
control the relative importance of each field when Amazon CloudSearch
calculates relevance scores. To specify a field weight, append a caret
(^
) symbol and the weight to the field name. For example,
to boost the importance of the title
field over the
description
field you could specify:
"fields":["title^5","description"]
. Valid values: The
name of any configured field and an optional numeric value greater
than zero. Default: All text
and text-array
fields. Valid for: simple
, structured
,
lucene
, and dismax
.operators
: An array of the operators or special
characters you want to disable for the simple query parser. If you
disable the and
, or
, or not
operators, the corresponding operators (+
,
|
, -
) have no special meaning and are
dropped from the search string. Similarly, disabling
prefix
disables the wildcard operator (*
)
and disabling phrase
disables the ability to search for
phrases by enclosing phrases in double quotes. Disabling precedence
disables the ability to control order of precedence using parentheses.
Disabling near
disables the ability to use the ~ operator
to perform a sloppy phrase search. Disabling the fuzzy
operator disables the ability to use the ~ operator to perform a fuzzy
search. escape
disables the ability to use a backslash
(\
) to escape special characters within the search
string. Disabling whitespace is an advanced option that prevents the
parser from tokenizing on whitespace, which can be useful for
Vietnamese. (It prevents Vietnamese words from being split
incorrectly.) For example, you could disable all operators other than
the phrase operator to support just simple term and phrase queries:
"operators":["and","not","or", "prefix"]
. Valid values:
and
, escape
, fuzzy
,
near
, not
, or
,
phrase
, precedence
, prefix
,
whitespace
. Default: All operators and special characters
are enabled. Valid for: simple
.phraseFields
: An array of the text
or
text-array
fields you want to use for phrase searches.
When the terms in the search string appear in close proximity within a
field, the field scores higher. You can specify a weight for each
field to boost that score. The phraseSlop
option controls
how much the matches can deviate from the search string and still be
boosted. To specify a field weight, append a caret (^
)
symbol and the weight to the field name. For example, to boost phrase
matches in the title
field over the abstract
field, you could specify: "phraseFields":["title^3",
"plot"]
Valid values: The name of any text
or
text-array
field and an optional numeric value greater
than zero. Default: No fields. If you don't specify any fields with
phraseFields
, proximity scoring is disabled even if
phraseSlop
is specified. Valid for:
dismax
.phraseSlop
: An integer
value that specifies how much matches can deviate from the search
phrase and still be boosted according to the weights specified in the
phraseFields
option; for example, phraseSlop:
2
. You must also specify phraseFields
to enable
proximity scoring. Valid values: positive integers. Default: 0. Valid
for: dismax
.explicitPhraseSlop
: An
integer value that specifies how much a match can deviate from the
search phrase when the phrase is enclosed in double quotes in the
search string. (Phrases that exceed this proximity distance are not
considered a match.) For example, to specify a slop of three for
dismax phrase queries, you would specify
"explicitPhraseSlop":3
. Valid values: positive integers.
Default: 0. Valid for: dismax
.tieBreaker
: When a term in the search string is found
in a document's field, a score is calculated for that field based on
how common the word is in that field compared to other documents. If
the term occurs in multiple fields within a document, by default only
the highest scoring field contributes to the document's overall score.
You can specify a tieBreaker
value to enable the matches
in lower-scoring fields to contribute to the document's score. That
way, if two documents have the same max field score for a particular
term, the score for the document that has matches in more fields will
be higher. The formula for calculating the score with a tieBreaker is
(max field score) + (tieBreaker) * (sum of the scores for the
rest of the matching fields)
. Set tieBreaker
to 0
to disregard all but the highest scoring field (pure max):
"tieBreaker":0
. Set to 1 to sum the scores from all
fields (pure sum): "tieBreaker":1
. Valid values: 0.0 to
1.0. Default: 0.0. Valid for: dismax
. title
and
plot
fields if no fields are specified in the search
criteria.String queryParser
queryParser
is not specified, Amazon CloudSearch uses the
simple
query parser. Amazon CloudSearch supports four query parsers:
simple
: perform simple searches
of text
and text-array
fields. By default,
the simple
query parser searches all text
and text-array
fields. You can specify which fields to
search by with the queryOptions
parameter. If you prefix
a search term with a plus sign (+) documents must contain the term to
be considered a match. (This is the default, unless you configure the
default operator with the queryOptions
parameter.) You
can use the -
(NOT), |
(OR), and
*
(wildcard) operators to exclude particular terms, find
results that match any of the specified terms, or search for a prefix.
To search for a phrase rather than individual terms, enclose the
phrase in double quotes. For more information, see Searching
for Text in the Amazon CloudSearch Developer Guide. structured
: perform advanced searches by combining
multiple expressions to define the search criteria. You can also
search within particular fields, search for values and ranges of
values, and use advanced options such as term boosting,
matchall
, and near
. For more information,
see Constructing
Compound Queries in the Amazon CloudSearch Developer Guide.
lucene
: search using the Apache Lucene query
parser syntax. For more information, see Apache
Lucene Query Parser Syntax. dismax
: search
using the simplified subset of the Apache Lucene query parser syntax
defined by the DisMax query parser. For more information, see DisMax
Query Parser Syntax.
Constraints:
Allowed Values: simple, structured, lucene, dismax
String returnValue
_all_fields
). To return only the document IDs for the
matching documents, specify _no_fields
. To retrieve the
relevance score calculated for each document, specify
_score
.Long size
String sort
asc
or desc
) for each field; for example,
year desc,title asc
. To use a field to sort results, the
field must be sort-enabled in the domain configuration. Array type
fields cannot be used for sorting. If no sort
parameter
is specified, results are sorted by their default relevance scores in
descending order: _score desc
. You can also sort by
document ID (_id asc
) and version (_version
desc
). For more information, see Sorting Results in the Amazon CloudSearch Developer Guide.
Long start
start
or cursor
parameter in a request, they are mutually exclusive. For more information, see Paginating Results in the Amazon CloudSearch Developer Guide.
SearchStatus status
Hits hits
Map<K,V> facets
String query
Long found
com.amazonaws.internal.ListWithAutoConstructFlag<T> suggestions
SuggestStatus status
SuggestRequest
. Contains the resource ID
(rid
) and how long it took to process the request
(timems
).SuggestModel suggest
Long contentLength
InputStream documents
String contentType
Constraints:
Allowed Values: application/json, application/xml
String status
UploadDocumentsRequest
.Long adds
Long deletes
com.amazonaws.internal.ListWithAutoConstructFlag<T> warnings
String options
OptionStatus status
String synonyms
String stopwords
["a", "an", "the", "of"]
. The stopwords
dictionary must explicitly list each word you want to ignore.
Wildcards and regular expressions are not supported.String stemmingDictionary
{"term1": "stem1",
"term2": "stem2", "term3": "stem3"}
. The stemming dictionary is
applied in addition to any algorithmic stemming. This enables you to
override the results of the algorithmic stemming to correct specific
cases of overstemming or understemming. The maximum size of a stemming
dictionary is 500 KB.String algorithmicStemming
none
,
minimal
, light
, or full
. The
available levels vary depending on the language. For more information,
see Language Specific Text Processing Settings in the
Amazon CloudSearch Developer Guide
Constraints:
Allowed Values: none, minimal, light, full
String analysisSchemeName
_id
.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String analysisSchemeLanguage
mul
for multiple languages.
Constraints:
Allowed Values: ar, bg, ca, cs, da, de, el, en, es, eu, fa, fi, fr, ga, gl, he, hi, hu, hy, id, it, ja, ko, lv, mul, nl, no, pt, ro, ru, sv, th, tr, zh-Hans, zh-Hant
AnalysisOptions analysisOptions
AnalysisScheme options
Synonyms
, Stopwords
,
StemmingDictionary
, and AlgorithmicStemming
.OptionStatus status
Boolean options
OptionStatus status
String code
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
DomainStatus domainStatus
String defaultValue
Constraints:
Length: 0 - 1024
String sourceFields
Constraints:
Pattern: \s*[a-z][a-z0-9_]*\s*(,\s*[a-z][a-z0-9_]*\s*)*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
String defaultValue
Constraints:
Length: 0 - 1024
String sourceField
_id
.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
Boolean sortEnabled
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
AnalysisScheme analysisScheme
Synonyms
, Stopwords
,
StemmingDictionary
, and AlgorithmicStemming
.AnalysisSchemeStatus analysisScheme
AnalysisScheme
.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
Expression expression
ExpressionStatus expression
Expression
and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
IndexField indexField
IndexFieldStatus indexField
IndexField
and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
Suggester suggester
FuzzyMatching
, SortExpression
.SuggesterStatus suggester
Suggester
and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String analysisSchemeName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
AnalysisSchemeStatus analysisScheme
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
DomainStatus domainStatus
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String expressionName
Expression
to delete.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
ExpressionStatus expression
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String indexFieldName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
IndexFieldStatus indexField
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String suggesterName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
SuggesterStatus suggester
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> analysisSchemeNames
Boolean deployed
true
) or
include any pending changes (false
). Defaults to
false
.com.amazonaws.internal.ListWithAutoConstructFlag<T> analysisSchemes
AvailabilityOptionsStatus availabilityOptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainStatusList
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> expressionNames
DescribeExpressions
response to the
specified expressions. If not specified, all expressions are shown.Boolean deployed
true
) or
include any pending changes (false
). Defaults to
false
.com.amazonaws.internal.ListWithAutoConstructFlag<T> expressions
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
Boolean deployed
true
) or
include any pending changes (false
). Defaults to
false
.com.amazonaws.internal.ListWithAutoConstructFlag<T> indexFields
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
ScalingParametersStatus scalingParameters
AccessPoliciesStatus accessPolicies
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> suggesterNames
Boolean deployed
true
) or
include any pending changes (false
). Defaults to
false
.com.amazonaws.internal.ListWithAutoConstructFlag<T> suggesters
String sourceField
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String fuzzyMatching
none
, low
, or high
. With none,
the specified string is treated as an exact prefix. With low,
suggestions must differ from the specified string by no more than one
character. With high, suggestions can differ by up to two characters.
The default is none.
Constraints:
Allowed Values: none, low, high
String sortExpression
_score
value. To sort suggestions using a numeric field
or existing expression, simply specify the name of the field or
expression. If no expression is configured for the suggester, the
suggestions are sorted with the closest matches listed first.String domainId
Constraints:
Length: 1 - 64
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String aRN
Boolean created
Boolean deleted
ServiceEndpoint docService
ServiceEndpoint searchService
Boolean requiresIndexDocuments
Boolean processing
String searchInstanceType
Integer searchPartitionCount
Constraints:
Range: 1 -
Integer searchInstanceCount
Constraints:
Range: 1 -
Double defaultValue
String sourceFields
Constraints:
Pattern: \s*[a-z][a-z0-9_]*\s*(,\s*[a-z][a-z0-9_]*\s*)*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
Double defaultValue
String sourceField
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
Boolean sortEnabled
String expressionName
_id
.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String expressionValue
Expression
syntax is based on JavaScript
expressions. For more information, see Configuring Expressions in the Amazon
CloudSearch Developer Guide.
Constraints:
Length: 1 - 10240
Expression options
OptionStatus status
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
String indexFieldName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String indexFieldType
Constraints:
Allowed Values: int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array
IntOptions intOptions
IndexFieldType
specifies the field is of type
int
. All options are enabled by default.DoubleOptions doubleOptions
IndexFieldType
specifies the field is of type
double
. All options are enabled by default.LiteralOptions literalOptions
IndexFieldType
specifies the field is of type literal
. All options are
enabled by default.TextOptions textOptions
IndexFieldType
specifies the field is of type text
. A text
field is always searchable. All options are enabled by default.DateOptions dateOptions
IndexFieldType
specifies
the field is of type date
. All options are enabled by
default.LatLonOptions latLonOptions
IndexFieldType
specifies the field is of type
latlon
. All options are enabled by default.IntArrayOptions intArrayOptions
IndexFieldType
specifies the field is of type
int-array
. All options are enabled by default.DoubleArrayOptions doubleArrayOptions
IndexFieldType
specifies the field is of type double-array
. All options
are enabled by default.LiteralArrayOptions literalArrayOptions
IndexFieldType
specifies the field is of type
literal-array
. All options are enabled by default.TextArrayOptions textArrayOptions
IndexFieldType
specifies the field is of type
text-array
. A text-array
field is always
searchable. All options are enabled by default.DateArrayOptions dateArrayOptions
IndexFieldType
specifies the field is of type
date-array
. All options are enabled by default.IndexField options
IndexFieldType
.OptionStatus status
Long defaultValue
String sourceFields
Constraints:
Pattern: \s*[a-z][a-z0-9_]*\s*(,\s*[a-z][a-z0-9_]*\s*)*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
Long defaultValue
String sourceField
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
Boolean sortEnabled
String defaultValue
Constraints:
Length: 0 - 1024
String sourceField
_id
.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
Boolean sortEnabled
String defaultValue
Constraints:
Length: 0 - 1024
String sourceFields
Constraints:
Pattern: \s*[a-z][a-z0-9_]*\s*(,\s*[a-z][a-z0-9_]*\s*)*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
String defaultValue
Constraints:
Length: 0 - 1024
String sourceField
_id
.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
Boolean sortEnabled
Date creationDate
Date updateDate
Integer updateVersion
Constraints:
Range: 0 -
String state
RequiresIndexDocuments
: the option's latest value
will not be deployed until IndexDocuments has been called and
indexing is complete.Processing
: the option's
latest value is in the process of being activated. Active
: the option's latest value is completely
deployed.FailedToValidate
: the option value is
not compatible with the domain's data and cannot be used to index the
data. You must either modify the option value or update or remove the
incompatible documents.
Constraints:
Allowed Values: RequiresIndexDocuments, Processing, Active, FailedToValidate
Boolean pendingDeletion
String desiredInstanceType
search.m1.small
.
Constraints:
Allowed Values: search.m1.small, search.m1.large, search.m2.xlarge, search.m2.2xlarge
Integer desiredReplicationCount
Constraints:
Range: 0 -
Integer desiredPartitionCount
m2.2xlarge
as the desired
instance type.
Constraints:
Range: 0 -
ScalingParameters options
OptionStatus status
String endpoint
search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com
or
doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com
.String suggesterName
_id
.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
DocumentSuggesterOptions documentSuggesterOptions
Suggester options
FuzzyMatching
, SortExpression
.OptionStatus status
String defaultValue
Constraints:
Length: 0 - 1024
String sourceFields
Constraints:
Pattern: \s*[a-z][a-z0-9_]*\s*(,\s*[a-z][a-z0-9_]*\s*)*
Boolean returnEnabled
Boolean highlightEnabled
String analysisScheme
text-array
field.
Constraints:
Pattern: [\S]+
String defaultValue
Constraints:
Length: 0 - 1024
String sourceField
_id
.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
Boolean returnEnabled
Boolean sortEnabled
Boolean highlightEnabled
String analysisScheme
text
field.
Constraints:
Pattern: [\S]+
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
Boolean multiAZ
false
.AvailabilityOptionsStatus availabilityOptions
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
ScalingParameters scalingParameters
ScalingParametersStatus scalingParameters
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String accessPolicies
AccessPoliciesStatus accessPolicies
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> trailNameList
com.amazonaws.internal.ListWithAutoConstructFlag<T> trailList
String name
Boolean isLogging
String latestDeliveryError
String latestNotificationError
Date latestDeliveryTime
Date latestNotificationTime
Date startLoggingTime
Date stopLoggingTime
String latestDeliveryAttemptTime
String latestNotificationAttemptTime
String latestNotificationAttemptSucceeded
String latestDeliveryAttemptSucceeded
String timeLoggingStarted
String timeLoggingStopped
String name
String s3BucketName
String s3KeyPrefix
String snsTopicName
Boolean includeGlobalServiceEvents
String alarmName
Constraints:
Length: 1 - 255
Date timestamp
String historyItemType
Constraints:
Allowed Values: ConfigurationUpdate, StateUpdate, Action
String historySummary
Constraints:
Length: 1 - 255
String historyData
Constraints:
Length: 1 - 4095
Date timestamp
Double sampleCount
Double average
Double sum
Double minimum
Double maximum
String unit
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
com.amazonaws.internal.ListWithAutoConstructFlag<T> alarmNames
Constraints:
Length: 0 - 100
String alarmName
Constraints:
Length: 1 - 255
String historyItemType
Constraints:
Allowed Values: ConfigurationUpdate, StateUpdate, Action
Date startDate
Date endDate
Integer maxRecords
Constraints:
Range: 1 - 100
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> alarmHistoryItems
String nextToken
String metricName
Constraints:
Length: 1 - 255
String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
String statistic
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
com.amazonaws.internal.ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
Integer period
Constraints:
Range: 60 -
String unit
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
com.amazonaws.internal.ListWithAutoConstructFlag<T> metricAlarms
com.amazonaws.internal.ListWithAutoConstructFlag<T> alarmNames
Constraints:
Length: 0 - 100
String alarmNamePrefix
AlarmNames
cannot be specified if
this parameter is specified.
Constraints:
Length: 1 - 255
String stateValue
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
String actionPrefix
Constraints:
Length: 1 - 1024
Integer maxRecords
Constraints:
Range: 1 - 100
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> metricAlarms
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> alarmNames
Constraints:
Length: 0 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> alarmNames
Constraints:
Length: 0 - 100
String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
String metricName
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
Date startTime
Date endTime
Integer period
Period
must be at least 60 seconds and must be a multiple
of 60. The default value is 60.
Constraints:
Range: 60 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> statistics
Constraints:
Length: 1 - 5
String unit
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
String label
com.amazonaws.internal.ListWithAutoConstructFlag<T> datapoints
String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
String metricName
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> metrics
String nextToken
String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
String metricName
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
String alarmName
Constraints:
Length: 1 - 255
String alarmArn
Constraints:
Length: 1 - 1600
String alarmDescription
Constraints:
Length: 0 - 255
Date alarmConfigurationUpdatedTimestamp
Boolean actionsEnabled
com.amazonaws.internal.ListWithAutoConstructFlag<T> oKActions
OK
state from any other state. Each action is specified
as an Amazon Resource Number (ARN). Currently the only actions
supported are publishing to an Amazon SNS topic and triggering an Auto
Scaling policy.
Constraints:
Length: 0 - 5
com.amazonaws.internal.ListWithAutoConstructFlag<T> alarmActions
ALARM
state from any other state. Each action is
specified as an Amazon Resource Number (ARN). Currently the only
actions supported are publishing to an Amazon SNS topic and triggering
an Auto Scaling policy.
Constraints:
Length: 0 - 5
com.amazonaws.internal.ListWithAutoConstructFlag<T> insufficientDataActions
INSUFFICIENT_DATA
state from any other state. Each action
is specified as an Amazon Resource Number (ARN). Currently the only
actions supported are publishing to an Amazon SNS topic or triggering
an Auto Scaling policy.
Constraints:
Length: 0 - 5
String stateValue
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
String stateReason
Constraints:
Length: 0 - 1023
String stateReasonData
Constraints:
Length: 0 - 4000
Date stateUpdatedTimestamp
String metricName
Constraints:
Length: 1 - 255
String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
String statistic
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
com.amazonaws.internal.ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
Integer period
Constraints:
Range: 60 -
String unit
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
Integer evaluationPeriods
Constraints:
Range: 1 -
Double threshold
String comparisonOperator
Statistic
and Threshold
. The specified
Statistic
value is used as the first operand.
Constraints:
Allowed Values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
String metricName
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
Date timestamp
Double value
Value
parameter accepts numbers of type Double
, Amazon
CloudWatch truncates values with very large exponents. Values with
base-10 exponents greater than 126 (1 x 10^126) are truncated.
Likewise, values with base-10 exponents less than -130 (1 x 10^-130)
are also truncated. StatisticSet statisticValues
String unit
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
String alarmName
Constraints:
Length: 1 - 255
String alarmDescription
Constraints:
Length: 0 - 255
Boolean actionsEnabled
com.amazonaws.internal.ListWithAutoConstructFlag<T> oKActions
OK
state from any other state. Each action is specified
as an Amazon Resource Number (ARN). Currently the only action
supported is publishing to an Amazon SNS topic or an Amazon Auto
Scaling policy.
Constraints:
Length: 0 - 5
com.amazonaws.internal.ListWithAutoConstructFlag<T> alarmActions
ALARM
state from any other state. Each action is
specified as an Amazon Resource Number (ARN). Currently the only
action supported is publishing to an Amazon SNS topic or an Amazon
Auto Scaling policy.
Constraints:
Length: 0 - 5
com.amazonaws.internal.ListWithAutoConstructFlag<T> insufficientDataActions
INSUFFICIENT_DATA
state from any other state. Each action
is specified as an Amazon Resource Number (ARN). Currently the only
action supported is publishing to an Amazon SNS topic or an Amazon
Auto Scaling policy.
Constraints:
Length: 0 - 5
String metricName
Constraints:
Length: 1 - 255
String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
String statistic
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
com.amazonaws.internal.ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
Integer period
Constraints:
Range: 60 -
String unit
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
Integer evaluationPeriods
Constraints:
Range: 1 -
Double threshold
String comparisonOperator
Statistic
and Threshold
. The specified
Statistic
value is used as the first operand.
Constraints:
Allowed Values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
com.amazonaws.internal.ListWithAutoConstructFlag<T> metricData
String alarmName
Constraints:
Length: 1 - 255
String stateValue
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
String stateReason
Constraints:
Length: 0 - 1023
String stateReasonData
Constraints:
Length: 0 - 4000
String identityPoolName
Constraints:
Length: 1 - 128
Pattern: [\w ]+
Boolean allowUnauthenticatedIdentities
Map<K,V> supportedLoginProviders
Constraints:
Length: 0 - 10
String developerProviderName
DeveloperProviderName
, you can use letters as well as
period (.
), underscore (_
), and dash
(-
). Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.
Constraints:
Length: 1 - 128
Pattern: [\w._-]+
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String identityPoolName
Constraints:
Length: 1 - 128
Pattern: [\w ]+
Boolean allowUnauthenticatedIdentities
Map<K,V> supportedLoginProviders
Constraints:
Length: 0 - 10
String developerProviderName
Constraints:
Length: 1 - 128
Pattern: [\w._-]+
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String identityPoolName
Constraints:
Length: 1 - 128
Pattern: [\w ]+
Boolean allowUnauthenticatedIdentities
Map<K,V> supportedLoginProviders
Constraints:
Length: 0 - 10
String developerProviderName
Constraints:
Length: 1 - 128
Pattern: [\w._-]+
String accountId
Constraints:
Length: 1 - 15
Pattern: \d+
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
Map<K,V> logins
The available provider names for Logins
are as
follows:
graph.facebook.com
accounts.google.com
www.amazon.com
Constraints:
Length: 0 - 10
String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
Map<K,V> logins
"developer_provider_name": "developer_user_identifier"
.
The developer provider is the "domain" by which Cognito will refer to
your users; you provided this domain while creating/updating the
identity pool. The developer user identifier is an identifier from
your backend that uniquely identifies a user. When you create an
identity pool, you can specify the supported logins.
Constraints:
Length: 0 - 10
Long tokenDuration
Constraints:
Range: 1 - 86400
String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> logins
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
Integer maxResults
Constraints:
Range: 1 - 60
String nextToken
Constraints:
Length: 1 -
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> identities
String nextToken
Constraints:
Length: 1 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> identityPools
String nextToken
Constraints:
Length: 1 -
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String developerUserIdentifier
Integer maxResults
Constraints:
Range: 1 - 60
String nextToken
NextToken
set to null. After that the service will return
NextToken
values as needed. For example, let's say you
make a request with MaxResults
set to 10, and there are
20 matches in the database. The service will return a pagination token
as a part of the response. This token can be used to call the API
again and get results starting from the 11th match.
Constraints:
Length: 1 -
String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> developerUserIdentifierList
String nextToken
NextToken
set to null. After that the service will return
NextToken
values as needed. For example, let's say you
make a request with MaxResults
set to 10, and there are
20 matches in the database. The service will return a pagination token
as a part of the response. This token can be used to call the API
again and get results starting from the 11th match.
Constraints:
Length: 1 -
String sourceUserIdentifier
DeveloperUserIdentifier
.String destinationUserIdentifier
DeveloperUserIdentifier
.String developerProviderName
DeveloperProviderName
, you can use letters as well as
period (.), underscore (_), and dash (-).
Constraints:
Length: 1 - 128
Pattern: [\w._-]+
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String developerProviderName
Constraints:
Length: 1 - 128
Pattern: [\w._-]+
String developerUserIdentifier
String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
Map<K,V> logins
Constraints:
Length: 0 - 10
com.amazonaws.internal.ListWithAutoConstructFlag<T> loginsToRemove
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String identityPoolName
Constraints:
Length: 1 - 128
Pattern: [\w ]+
Boolean allowUnauthenticatedIdentities
Map<K,V> supportedLoginProviders
Constraints:
Length: 0 - 10
String developerProviderName
Constraints:
Length: 1 - 128
Pattern: [\w._-]+
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String identityPoolName
Constraints:
Length: 1 - 128
Pattern: [\w ]+
Boolean allowUnauthenticatedIdentities
Map<K,V> supportedLoginProviders
Constraints:
Length: 0 - 10
String developerProviderName
Constraints:
Length: 1 - 128
Pattern: [\w._-]+
String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String datasetName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+
Date creationDate
Date lastModifiedDate
String lastModifiedBy
Long dataStorage
Long numRecords
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String datasetName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+
Dataset dataset
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String datasetName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+
Dataset dataset
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
IdentityPoolUsage identityPoolUsage
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
IdentityUsage identityUsage
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
Long syncSessionsCount
Long dataStorage
Date lastModifiedDate
String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
Date lastModifiedDate
Integer datasetCount
Long dataStorage
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String nextToken
Integer maxResults
Constraints:
Length: 0 - 19
Pattern: \d+
com.amazonaws.internal.ListWithAutoConstructFlag<T> datasets
Integer count
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> identityPoolUsages
Integer maxResults
Integer count
String nextToken
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String datasetName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+
Long lastSyncCount
Constraints:
Length: 0 - 19
Pattern: \d+
String nextToken
Integer maxResults
Constraints:
Length: 0 - 19
Pattern: \d+
String syncSessionToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> records
String nextToken
Integer count
Long datasetSyncCount
String lastModifiedBy
com.amazonaws.internal.ListWithAutoConstructFlag<T> mergedDatasetNames
Boolean datasetExists
Boolean datasetDeletedAfterRequestedSyncCount
String syncSessionToken
String key
Constraints:
Length: 1 - 1024
String value
Constraints:
Length: 0 - 1048575
Long syncCount
Date lastModifiedDate
String lastModifiedBy
Date deviceLastModifiedDate
String op
Constraints:
Allowed Values: replace, remove
String key
Constraints:
Length: 1 - 1024
String value
Constraints:
Length: 0 - 1048575
Long syncCount
Date deviceLastModifiedDate
String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
String datasetName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> recordPatches
String syncSessionToken
String clientContext
com.amazonaws.internal.ListWithAutoConstructFlag<T> records
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String name
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String uniqueId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String description
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> objectIds
Boolean evaluateExpressions
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: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineObjects
String marker
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean hasMoreResults
True
, there are more pages of results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineDescriptionList
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String objectId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String expression
Constraints:
Length: 0 - 20971520
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String evaluatedExpression
Constraints:
Length: 0 - 20971520
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String key
Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String stringValue
Constraints:
Length: 0 - 10240
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String refValue
Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
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: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineObjects
String document
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String signature
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
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: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineIdList
String marker
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean hasMoreResults
True
, there are more results that can be obtained by a
subsequent call to ListPipelines.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
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
String pipelineId
df-297EG78HU43EEXAMPLE
.
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String name
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> fields
String description
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String id
df-297EG78HU43EEXAMPLE
.
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String name
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String id
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String name
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> fields
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: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String hostname
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\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
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineObjects
com.amazonaws.internal.ListWithAutoConstructFlag<T> validationErrors
pipelineObjects
.com.amazonaws.internal.ListWithAutoConstructFlag<T> validationWarnings
pipelineObjects
.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.com.amazonaws.internal.ListWithAutoConstructFlag<T> selectors
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Query query
String sphere
COMPONENT
, INSTANCE
,
ATTEMPT
.
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
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: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer limit
com.amazonaws.internal.ListWithAutoConstructFlag<T> ids
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: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean hasMoreResults
True
, there are more results that can be obtained by a
subsequent call to QueryObjects.String taskId
Constraints:
Length: 1 - 2048
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
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.String taskrunnerId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
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: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String hostname
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean terminate
True
, the task runner that called
ReportTaskRunnerHeartbeat should terminate.String fieldName
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Operator operator
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> objectIds
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: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String taskId
Constraints:
Length: 1 - 2048
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
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
String errorId
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String errorMessage
String errorStackTrace
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String taskId
Constraints:
Length: 1 - 2048
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String attemptId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Map<K,V> objects
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineObjects
com.amazonaws.internal.ListWithAutoConstructFlag<T> validationErrors
com.amazonaws.internal.ListWithAutoConstructFlag<T> validationWarnings
Boolean errored
True
, there were validation errors.String id
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> errors
String id
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> warnings
String bandwidth
Example: 1Gbps
Default: None
String connectionName
Example: "500M Connection to AWS"
Default: None
String ownerAccount
Example: 123443215678
Default: None
String interconnectId
Example: dxcon-456abc78
Default: None
Integer vlan
Example: 101
Default: None
String ownerAccount
String connectionId
Example: dxcon-fg5678gh
Default: None
String connectionName
Example: "1G Connection to AWS"
Default: None
String connectionState
Constraints:
Allowed Values: ordering, requested, pending, available, down, deleting, deleted, rejected
String region
Example: us-east-1
Default: None
String location
Example: EqSV5
Default: None
String bandwidth
Example: 1Gbps
Default: None
Integer vlan
Example: 101
String partnerName
String connectionId
Default: None
String ownerAccount
Default: None
NewPrivateVirtualInterfaceAllocation newPrivateVirtualInterfaceAllocation
Default: None
String ownerAccount
String virtualInterfaceId
Example: dxvif-123dfg56
Default: None
String location
Example: EqSV5
Default: None
String connectionId
Example: dxcon-fg5678gh
Default: None
String virtualInterfaceType
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
String virtualInterfaceName
Example: "My VPC"
Integer vlan
Example: 101
Integer asn
Example: 65000
String authKey
Example: asdf34example
String amazonAddress
Example: 192.168.1.1/30
String customerAddress
Example: 192.168.1.2/30
String virtualInterfaceState
Constraints:
Allowed Values: confirming, verifying, pending, available, deleting, deleted, rejected
String customerRouterConfig
String virtualGatewayId
Example: vgw-123er56
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeFilterPrefixes
String connectionId
Default: None
String ownerAccount
Default: None
NewPublicVirtualInterfaceAllocation newPublicVirtualInterfaceAllocation
Default: None
String ownerAccount
String virtualInterfaceId
Example: dxvif-123dfg56
Default: None
String location
Example: EqSV5
Default: None
String connectionId
Example: dxcon-fg5678gh
Default: None
String virtualInterfaceType
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
String virtualInterfaceName
Example: "My VPC"
Integer vlan
Example: 101
Integer asn
Example: 65000
String authKey
Example: asdf34example
String amazonAddress
Example: 192.168.1.1/30
String customerAddress
Example: 192.168.1.2/30
String virtualInterfaceState
Constraints:
Allowed Values: confirming, verifying, pending, available, deleting, deleted, rejected
String customerRouterConfig
String virtualGatewayId
Example: vgw-123er56
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeFilterPrefixes
String connectionId
Example: dxcon-fg5678gh
Default: None
String connectionState
Constraints:
Allowed Values: ordering, requested, pending, available, down, deleting, deleted, rejected
String virtualInterfaceId
Example: dxvif-123dfg56
Default: None
String virtualGatewayId
A virtual private gateway can be managed via the Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.
Default: None
String virtualInterfaceState
Constraints:
Allowed Values: confirming, verifying, pending, available, deleting, deleted, rejected
String virtualInterfaceId
Example: dxvif-123dfg56
Default: None
String virtualInterfaceState
Constraints:
Allowed Values: confirming, verifying, pending, available, deleting, deleted, rejected
String ownerAccount
String connectionId
Example: dxcon-fg5678gh
Default: None
String connectionName
Example: "1G Connection to AWS"
Default: None
String connectionState
Constraints:
Allowed Values: ordering, requested, pending, available, down, deleting, deleted, rejected
String region
Example: us-east-1
Default: None
String location
Example: EqSV5
Default: None
String bandwidth
Example: 1Gbps
Default: None
Integer vlan
Example: 101
String partnerName
String ownerAccount
String connectionId
Example: dxcon-fg5678gh
Default: None
String connectionName
Example: "1G Connection to AWS"
Default: None
String connectionState
Constraints:
Allowed Values: ordering, requested, pending, available, down, deleting, deleted, rejected
String region
Example: us-east-1
Default: None
String location
Example: EqSV5
Default: None
String bandwidth
Example: 1Gbps
Default: None
Integer vlan
Example: 101
String partnerName
String interconnectName
Example: "1G Interconnect to AWS"
Default: None
String bandwidth
Example: 1Gbps
Default: None
Available values: 1Gbps,10Gbps
String location
Example: EqSV5
Default: None
String interconnectId
Example: dxcon-abc123
String interconnectName
Example: "1G Interconnect to AWS"
String interconnectState
Constraints:
Allowed Values: requested, pending, available, down, deleting, deleted
String region
Example: us-east-1
Default: None
String location
Example: EqSV5
Default: None
String bandwidth
Example: 1Gbps
Default: None
String connectionId
Example: dxcon-fg5678gh
Default: None
NewPrivateVirtualInterface newPrivateVirtualInterface
Default: None
String ownerAccount
String virtualInterfaceId
Example: dxvif-123dfg56
Default: None
String location
Example: EqSV5
Default: None
String connectionId
Example: dxcon-fg5678gh
Default: None
String virtualInterfaceType
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
String virtualInterfaceName
Example: "My VPC"
Integer vlan
Example: 101
Integer asn
Example: 65000
String authKey
Example: asdf34example
String amazonAddress
Example: 192.168.1.1/30
String customerAddress
Example: 192.168.1.2/30
String virtualInterfaceState
Constraints:
Allowed Values: confirming, verifying, pending, available, deleting, deleted, rejected
String customerRouterConfig
String virtualGatewayId
Example: vgw-123er56
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeFilterPrefixes
String connectionId
Example: dxcon-fg5678gh
Default: None
NewPublicVirtualInterface newPublicVirtualInterface
Default: None
String ownerAccount
String virtualInterfaceId
Example: dxvif-123dfg56
Default: None
String location
Example: EqSV5
Default: None
String connectionId
Example: dxcon-fg5678gh
Default: None
String virtualInterfaceType
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
String virtualInterfaceName
Example: "My VPC"
Integer vlan
Example: 101
Integer asn
Example: 65000
String authKey
Example: asdf34example
String amazonAddress
Example: 192.168.1.1/30
String customerAddress
Example: 192.168.1.2/30
String virtualInterfaceState
Constraints:
Allowed Values: confirming, verifying, pending, available, deleting, deleted, rejected
String customerRouterConfig
String virtualGatewayId
Example: vgw-123er56
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeFilterPrefixes
String connectionId
Example: dxcon-fg5678gh
Default: None
String ownerAccount
String connectionId
Example: dxcon-fg5678gh
Default: None
String connectionName
Example: "1G Connection to AWS"
Default: None
String connectionState
Constraints:
Allowed Values: ordering, requested, pending, available, down, deleting, deleted, rejected
String region
Example: us-east-1
Default: None
String location
Example: EqSV5
Default: None
String bandwidth
Example: 1Gbps
Default: None
Integer vlan
Example: 101
String partnerName
String interconnectId
Example: dxcon-abc123
String interconnectState
Constraints:
Allowed Values: requested, pending, available, down, deleting, deleted
String virtualInterfaceId
Example: dxvif-123dfg56
Default: None
String virtualInterfaceState
Constraints:
Allowed Values: confirming, verifying, pending, available, deleting, deleted, rejected
String interconnectId
Example: dxcon-abc123
Default: None
com.amazonaws.internal.ListWithAutoConstructFlag<T> connections
String connectionId
Example: dxcon-fg5678gh
Default: None
com.amazonaws.internal.ListWithAutoConstructFlag<T> connections
String interconnectId
Example: dxcon-abc123
com.amazonaws.internal.ListWithAutoConstructFlag<T> interconnects
com.amazonaws.internal.ListWithAutoConstructFlag<T> locations
com.amazonaws.internal.ListWithAutoConstructFlag<T> virtualGateways
com.amazonaws.internal.ListWithAutoConstructFlag<T> virtualInterfaces
String interconnectId
Example: dxcon-abc123
String interconnectName
Example: "1G Interconnect to AWS"
String interconnectState
Constraints:
Allowed Values: requested, pending, available, down, deleting, deleted
String region
Example: us-east-1
Default: None
String location
Example: EqSV5
Default: None
String bandwidth
Example: 1Gbps
Default: None
String virtualInterfaceName
Example: "My VPC"
Integer vlan
Example: 101
Integer asn
Example: 65000
String authKey
Example: asdf34example
String amazonAddress
Example: 192.168.1.1/30
String customerAddress
Example: 192.168.1.2/30
String virtualGatewayId
Example: vgw-123er56
String virtualInterfaceName
Example: "My VPC"
Integer vlan
Example: 101
Integer asn
Example: 65000
String authKey
Example: asdf34example
String amazonAddress
Example: 192.168.1.1/30
String customerAddress
Example: 192.168.1.2/30
String virtualInterfaceName
Example: "My VPC"
Integer vlan
Example: 101
Integer asn
Example: 65000
String authKey
Example: asdf34example
String amazonAddress
Example: 192.168.1.1/30
String customerAddress
Example: 192.168.1.2/30
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeFilterPrefixes
String virtualInterfaceName
Example: "My VPC"
Integer vlan
Example: 101
Integer asn
Example: 65000
String authKey
Example: asdf34example
String amazonAddress
Example: 192.168.1.1/30
String customerAddress
Example: 192.168.1.2/30
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeFilterPrefixes
String cidr
Example: 10.10.10.0/24,10.10.11.0/24
String virtualGatewayId
Example: vgw-123er56
String virtualGatewayState
String ownerAccount
String virtualInterfaceId
Example: dxvif-123dfg56
Default: None
String location
Example: EqSV5
Default: None
String connectionId
Example: dxcon-fg5678gh
Default: None
String virtualInterfaceType
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
String virtualInterfaceName
Example: "My VPC"
Integer vlan
Example: 101
Integer asn
Example: 65000
String authKey
Example: asdf34example
String amazonAddress
Example: 192.168.1.1/30
String customerAddress
Example: 192.168.1.2/30
String virtualInterfaceState
Constraints:
Allowed Values: confirming, verifying, pending, available, deleting, deleted, rejected
String customerRouterConfig
String virtualGatewayId
Example: vgw-123er56
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeFilterPrefixes
String s
String n
ByteBuffer b
List<E> sS
List<E> nS
List<E> bS
AttributeValue value
String
, Number
,
Binary
, StringSet
, NumberSet
,
BinarySet
.String action
Constraints:
Allowed Values: ADD, PUT, DELETE
Map<K,V> responses
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
List<E> items
Double consumedCapacityUnits
GetItem
,
BatchGetItem
, BatchWriteItem
,
Query
, and Scan
operations consume
ReadCapacityUnits
, while PutItem
,
UpdateItem
, and DeleteItem
operations
consume WriteCapacityUnits
.Map<K,V> responses
BatchWriteItem
call.
This is essentially a map of table name to
ConsumedCapacityUnits
.Map<K,V> unprocessedItems
BatchWriteItem
call is returned as
UnprocessedItems
Constraints:
Length: 1 - 25
Double consumedCapacityUnits
GetItem
,
BatchGetItem
, BatchWriteItem
,
Query
, and Scan
operations consume
ReadCapacityUnits
, while PutItem
,
UpdateItem
, and DeleteItem
operations
consume WriteCapacityUnits
.List<E> attributeValueList
BETWEEN
comparison, the
AttributeValueList contains two attribute values and the comparison
operator.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
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
String tableName
a-z
, A-Z
, 0-9
,
_
(underscore), -
(hyphen) and
.
(period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Key key
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.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
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.Double consumedCapacityUnits
GetItem
,
BatchGetItem
, BatchWriteItem
,
Query
, and Scan
operations consume
ReadCapacityUnits
, while PutItem
,
UpdateItem
, and DeleteItem
operations
consume WriteCapacityUnits
.Key key
String tableName
a-z
, A-Z
, 0-9
, _
(underscore), -
(hyphen) and .
(period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
TableDescription tableDescription
String tableName
a-z
, A-Z
, 0-9
, _
(underscore), -
(hyphen) and .
(period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
TableDescription table
AttributeValue value
Boolean exists
String tableName
a-z
, A-Z
, 0-9
,
_
(underscore), -
(hyphen) and
.
(period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Key key
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 -
Boolean consistentRead
true
, then a consistent read is issued.
Otherwise eventually-consistent is used.Map<K,V> item
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
.List<E> keys
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 -
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
.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_.-]+
Integer limit
Constraints:
Range: 1 - 100
List<E> tableNames
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_.-]+
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 -
Long writeCapacityUnits
WriteCapacityUnits
are in terms of strictly consistent
reads, assuming items of 1k. 2k items require twice the
WriteCapacityUnits
.
Constraints:
Range: 1 -
String tableName
a-z
, A-Z
, 0-9
,
_
(underscore), -
(hyphen) and
.
(period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Map<K,V> item
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.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
Map<K,V> attributes
ReturnValues
parameter is specified as
ALL_OLD
in the request.Double consumedCapacityUnits
GetItem
,
BatchGetItem
, BatchWriteItem
,
Query
, and Scan
operations consume
ReadCapacityUnits
, while PutItem
,
UpdateItem
, and DeleteItem
operations
consume WriteCapacityUnits
.String tableName
a-z
, A-Z
, 0-9
,
_
(underscore), -
(hyphen) and
.
(period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
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 -
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 -
Boolean consistentRead
true
, then a consistent read is issued.
Otherwise eventually-consistent is used.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
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.List<E> items
Integer count
Key lastEvaluatedKey
LastEvaluatedKey
is null when the entire query result set
is complete (i.e. the operation processed the "last page").Double consumedCapacityUnits
GetItem
,
BatchGetItem
, BatchWriteItem
,
Query
, and Scan
operations consume
ReadCapacityUnits
, while PutItem
,
UpdateItem
, and DeleteItem
operations
consume WriteCapacityUnits
.String tableName
a-z
, A-Z
, 0-9
,
_
(underscore), -
(hyphen) and
.
(period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
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 -
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 -
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.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.List<E> items
Integer count
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").Double consumedCapacityUnits
GetItem
,
BatchGetItem
, BatchWriteItem
,
Query
, and Scan
operations consume
ReadCapacityUnits
, while PutItem
,
UpdateItem
, and DeleteItem
operations
consume WriteCapacityUnits
.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
.String tableStatus
Date creationDateTime
ProvisionedThroughputDescription provisionedThroughput
Long tableSizeBytes
Long itemCount
String tableName
a-z
, A-Z
, 0-9
,
_
(underscore), -
(hyphen) and
.
(period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Key key
Map<K,V> attributeUpdates
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.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
Map<K,V> attributes
ReturnValues
parameter is specified as something other
than NONE
in the request.Double consumedCapacityUnits
GetItem
,
BatchGetItem
, BatchWriteItem
,
Query
, and Scan
operations consume
ReadCapacityUnits
, while PutItem
,
UpdateItem
, and DeleteItem
operations
consume WriteCapacityUnits
.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
String s
String n
ByteBuffer b
com.amazonaws.internal.ListWithAutoConstructFlag<T> sS
com.amazonaws.internal.ListWithAutoConstructFlag<T> nS
com.amazonaws.internal.ListWithAutoConstructFlag<T> bS
AttributeValue value
String action
PUT
, DELETE
, and ADD
. The
behavior depends on whether the specified primary key already exists
in the table. If an item with the specified Key is found in the table:
PUT
- Adds the specified
attribute to the item. If the attribute already exists, it is replaced
by the new value.
DELETE
- If no value is
specified, the attribute and its value are removed from the item. The
data type of the specified value must match the existing value's data
type.
If a set of values is specified, then those values are
subtracted from the old set. For example, if the attribute value was
the set [a,b,c]
and the DELETE action specified
[a,c]
, then the final attribute value would be
[b]
. Specifying an empty set is an error.
ADD
- If the attribute does not already exist, then
the attribute and its values are added to the item. If the attribute
does exist, then the behavior of ADD
depends on the data
type of the attribute:
If the existing attribute is a
number, and if Value is also a number, then the Value is
mathematically added to the existing attribute. If Value is a
negative number, then it is subtracted from the existing attribute.
If you use In addition, if you use
ADD
to increment or decrement a
number value for an item that doesn't exist before the update,
DynamoDB uses 0 as the initial value. ADD
to update an existing item, and intend to increment
or decrement an attribute value which does not yet exist, DynamoDB
uses 0
as the initial value. For example, suppose that
the item you want to update does not yet have an attribute named
itemcount, but you decide to ADD
the number
3
to this attribute anyway, even though it currently does
not exist. DynamoDB will create the itemcount attribute, set
its initial value to 0
, and finally add 3
to
it. The result will be a new itemcount attribute in the item,
with a value of 3
.
If the existing
data type is a set, and if the Value is also a set, then the
Value is added to the existing set. (This is a set
operation, not mathematical addition.) For example, if the attribute
value was the set [1,2]
, and the ADD
action
specified [3]
, then the final attribute value would be
[1,2,3]
. An error occurs if an Add action is specified
for a set attribute and the attribute type specified does not match
the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid
for an existing attribute whose data type is number or is a set. Do
not use ADD
for any other data types.
If no item with the specified Key is found:
PUT
- DynamoDB creates a new item with the specified
primary key, and then adds the attribute.
DELETE
- Nothing happens; there is no attribute to
delete.
ADD
- DynamoDB creates an item with
the supplied primary key and number (or set of numbers) for the
attribute value. The only data types allowed are number and number
set; no other data types can be specified.
Constraints:
Allowed Values: ADD, PUT, DELETE
Map<K,V> requestItems
Each element in the map consists of the following:
Keys - An array of primary key attribute values that define specific items in the table.
AttributesToGet - One or more attributes to be retrieved from the table. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
ConsistentRead - If
true
, a strongly consistent read is used; if
false
(the default), an eventually consistent read is
used.
Constraints:
Length: 1 - 100
String returnConsumedCapacity
TOTAL
, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES
, the response includes ConsumedCapacity
for indexes. If set to NONE
(the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
Map<K,V> responses
Map<K,V> unprocessedKeys
Each element consists of:
Keys - An array of primary key attribute values that define specific items in the table.
AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.
ConsistentRead - The consistency of a read
operation. If set to true
, then a strongly consistent
read is used; otherwise, an eventually consistent read is used.
If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> consumedCapacity
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
Map<K,V> requestItems
DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:
Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
Constraints:
Length: 1 - 25
String returnConsumedCapacity
TOTAL
, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES
, the response includes ConsumedCapacity
for indexes. If set to NONE
(the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
String returnItemCollectionMetrics
SIZE
, statistics about item collections, if
any, that were modified during the operation are returned in the
response. If set to NONE
(the default), no statistics are
returned.
Constraints:
Allowed Values: SIZE, NONE
Map<K,V> unprocessedItems
Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to perform (DeleteRequest or PutRequest).
DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:
Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.
Constraints:
Length: 1 - 25
Map<K,V> itemCollectionMetrics
Each entry consists of the following subelements:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
com.amazonaws.internal.ListWithAutoConstructFlag<T> consumedCapacity
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
Double capacityUnits
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeValueList
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are
based on ASCII character code values. For example, a
is
greater than A
, and aa
is greater than
B
. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
String comparisonOperator
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL |
CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ
: Equal.
AttributeValueList can contain
only one AttributeValue of type String, Number, Binary, String
Set, Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one specified in
the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2",
"1"]}
.
NE
: Not equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one specified in
the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2",
"1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
GE
: Greater than
or equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
NOT_NULL
: The
attribute exists.
NULL
: The attribute does
not exist.
CONTAINS
: checks for a
subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for a member of the set (not as a substring).
NOT_CONTAINS
: checks for absence of a
subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for the absence of a member of the set (not as a substring).
BEGINS_WITH
: checks for a
prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
IN
:
checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
BETWEEN
: Greater than or equal to the
first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a
set). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue of a different
type than the one specified in the request, the value does not match.
For example, {"S":"6"}
does not compare to
{"N":"6"}
. Also, {"N":"6"}
does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Conditional Expressions in the Amazon DynamoDB Developer Guide.
Constraints:
Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Double capacityUnits
Capacity table
Map<K,V> localSecondaryIndexes
Map<K,V> globalSecondaryIndexes
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeDefinitions
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
Each KeySchemaElement in the array is composed of:
AttributeName - The name of this key attribute.
KeyType - Determines whether the key attribute is
HASH
or RANGE
.
For a primary
key that consists of a hash attribute, you must specify exactly one
element with a KeyType of HASH
.
For a primary
key that consists of hash and range attributes, you must specify
exactly two elements, in this order: The first element must have a
KeyType of HASH
, and the second element must have
a KeyType of RANGE
.
For more information, see Specifying the Primary Key in the Amazon DynamoDB Developer Guide.
Constraints:
Length: 1 - 2
com.amazonaws.internal.ListWithAutoConstructFlag<T> localSecondaryIndexes
Each local secondary index in the array includes the following:
IndexName - The name of the local secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same hash key attribute as the table.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY
- Only the index and primary keys are
projected into the index.
INCLUDE
- Only
the specified table attributes are projected into the index. The list
of projected attributes are in NonKeyAttributes.
ALL
- All of the table attributes are projected into
the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
com.amazonaws.internal.ListWithAutoConstructFlag<T> globalSecondaryIndexes
IndexName - The name of the global secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the global secondary index.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY
- Only the index
and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are
projected into the index. The list of projected attributes are in
NonKeyAttributes.
ALL
- All of the
table attributes are projected into the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.
ProvisionedThroughput provisionedThroughput
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
TableDescription tableDescription
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Map<K,V> key
Map<K,V> expected
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are
based on ASCII character code values. For example, a
is
greater than A
, and aa
is greater than
B
. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS |
NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ
: Equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one specified in
the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2",
"1"]}
.
NE
: Not equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one specified in
the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2",
"1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
GE
: Greater than
or equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
NOT_NULL
: The
attribute exists.
NULL
: The attribute does
not exist.
CONTAINS
: checks for a
subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for a member of the set (not as a substring).
NOT_CONTAINS
: checks for absence of a
subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for the absence of a member of the set (not as a substring).
BEGINS_WITH
: checks for a
prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
IN
:
checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
BETWEEN
: Greater than or equal to the
first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a
set). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue of a different
type than the one specified in the request, the value does not match.
For example, {"S":"6"}
does not compare to
{"N":"6"}
. Also, {"N":"6"}
does not compare
to {"NS":["6", "2", "1"]}
For
usage examples of AttributeValueList and
ComparisonOperator, see Conditional
Expressions in the Amazon DynamoDB Developer Guide. For
backward compatibility with previous DynamoDB releases, the following
parameters can be used instead of AttributeValueList and
ComparisonOperator: Value - A value for
DynamoDB to compare with an attribute. Exists -
Causes DynamoDB to evaluate the value vefore attempting the
conditional operation: If Exists is
If Exists is Even though DynamoDB continues to
accept the Value and Exists parameters, they are now
deprecated. We recommend that you use AttributeValueList and
ComparisonOperator instead, since they allow you to constuct a
much wider range of conditions. The Value and Exists
parameters are incompatible with AttributeValueList and
ComparisonOperator. If you attempt to use both sets of
parameters at once, DynamoDB will throw a ValidationException.
true
, DynamoDB will check to see if that attribute???
value already exists in the table. If it is found, then the condition
evaluates to true; otherwise the condition evaluate to false.false
, DynamoDB assumes that
the attribute value does??? not exist in the table. If in fact
the value does not exist, then the??? assumption is valid and the
condition evaluates to true. If the value is found, despite the
assumption that it does not exist, the condition evaluates to
false.???
String conditionalOperator
AND
- If all of the conditions
evaluate to true, then the entire map evaluates to true.
OR
- If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is
the default.
The operation will succeed only if the entire map evaluates to true.
Constraints:
Allowed Values: AND, OR
String returnValues
NONE
- If ReturnValues is
not specified, or if its value is NONE
, then nothing is
returned. (This is the default for ReturnValues.)
ALL_OLD
- The content of the old item is returned.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
String returnConsumedCapacity
TOTAL
, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES
, the response includes ConsumedCapacity
for indexes. If set to NONE
(the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
String returnItemCollectionMetrics
SIZE
, statistics about item collections, if
any, that were modified during the operation are returned in the
response. If set to NONE
(the default), no statistics are
returned.
Constraints:
Allowed Values: SIZE, NONE
Map<K,V> attributes
ALL_OLD
in the
request.ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
Each ItemCollectionMetrics element consists of:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size, measured in gigabytes. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
TableDescription tableDescription
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
TableDescription table
AttributeValue value
Boolean exists
If Exists is true
,
DynamoDB will check to see if that attribute value already exists in
the table. If it is found, then the operation succeeds. If it is not
found, the operation fails with a
ConditionalCheckFailedException.
If Exists
is false
, DynamoDB assumes that the attribute value does
not exist in the table. If in fact the value does not exist,
then the assumption is valid and the operation succeeds. If the value
is found, despite the assumption that it does not exist, the operation
fails with a ConditionalCheckFailedException.
The default setting for Exists is true
. If you
supply a Value all by itself, DynamoDB assumes the attribute
exists: You don't have to set Exists to true
,
because it is implied.
DynamoDB returns a ValidationException if:
Exists is
true
but there is no Value to check. (You expect a
value to exist, but don't specify what that value is.)
Exists is false
but you also specify a
Value. (You cannot expect an attribute to have a value, while
also expecting it not to exist.)
String comparisonOperator
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS |
NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ
: Equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one specified in
the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2",
"1"]}
.
NE
: Not equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one specified in
the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2",
"1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
GE
: Greater than
or equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
NOT_NULL
: The
attribute exists.
NULL
: The attribute does
not exist.
CONTAINS
: checks for a
subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for a member of the set (not as a substring).
NOT_CONTAINS
: checks for absence of a
subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for the absence of a member of the set (not as a substring).
BEGINS_WITH
: checks for a
prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
IN
:
checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
BETWEEN
: Greater than or equal to the
first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a
set). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue of a different
type than the one specified in the request, the value does not match.
For example, {"S":"6"}
does not compare to
{"N":"6"}
. Also, {"N":"6"}
does not compare
to {"NS":["6", "2", "1"]}
Constraints:
Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeValueList
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are
based on ASCII character code values. For example, a
is
greater than A
, and aa
is greater than
B
. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Map<K,V> key
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributesToGet
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
Constraints:
Length: 1 -
Boolean consistentRead
true
, then the operation uses strongly
consistent reads; otherwise, eventually consistent reads are used.String returnConsumedCapacity
TOTAL
, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES
, the response includes ConsumedCapacity
for indexes. If set to NONE
(the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
Map<K,V> item
ConsumedCapacity consumedCapacity
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
HASH
or RANGE
).
Constraints:
Length: 1 - 2
Projection projection
ProvisionedThroughput provisionedThroughput
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
HASH
or RANGE
).
Constraints:
Length: 1 - 2
Projection projection
String indexStatus
CREATING - The index is being created, as the result of a CreateTable or UpdateTable operation.
UPDATING - The index is being updated, as the result of a CreateTable or UpdateTable operation.
DELETING - The index is being deleted, as the result of a DeleteTable operation.
ACTIVE - The index is ready for use.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
ProvisionedThroughputDescription provisionedThroughput
Long indexSizeBytes
Long itemCount
UpdateGlobalSecondaryIndexAction update
Map<K,V> itemCollectionKey
com.amazonaws.internal.ListWithAutoConstructFlag<T> sizeEstimateRangeGB
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
com.amazonaws.internal.ListWithAutoConstructFlag<T> keys
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributesToGet
Constraints:
Length: 1 -
Boolean consistentRead
true
, then
a strongly consistent read is used; otherwise, an eventually
consistent read is used.String exclusiveStartTableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Integer limit
Constraints:
Range: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> tableNames
If LastEvaluatedTableName also appears in the output, you can use this value as the ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the next page of results.
String lastEvaluatedTableName
If you do not receive a LastEvaluatedTableName value in the response, this means that there are no more table names to be retrieved.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
HASH
or RANGE
).
Constraints:
Length: 1 - 2
Projection projection
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
HASH
or
RANGE
).
Constraints:
Length: 1 - 2
Projection projection
Long indexSizeBytes
Long itemCount
String projectionType
KEYS_ONLY
- Only the index and primary keys are
projected into the index.
INCLUDE
- Only
the specified table attributes are projected into the index. The list
of projected attributes are in NonKeyAttributes.
ALL
- All of the table attributes are projected into
the index.
Constraints:
Allowed Values: ALL, KEYS_ONLY, INCLUDE
com.amazonaws.internal.ListWithAutoConstructFlag<T> nonKeyAttributes
For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
Constraints:
Length: 1 - 20
Long readCapacityUnits
Constraints:
Range: 1 -
Long writeCapacityUnits
Constraints:
Range: 1 -
Date lastIncreaseDateTime
Date lastDecreaseDateTime
Long numberOfDecreasesToday
Constraints:
Range: 1 -
Long readCapacityUnits
Constraints:
Range: 1 -
Long writeCapacityUnits
Constraints:
Range: 1 -
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Map<K,V> item
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item map is an AttributeValue object.
Map<K,V> expected
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are
based on ASCII character code values. For example, a
is
greater than A
, and aa
is greater than
B
. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS |
NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ
: Equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one specified in
the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2",
"1"]}
.
NE
: Not equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one specified in
the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2",
"1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
GE
: Greater than
or equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
NOT_NULL
: The
attribute exists.
NULL
: The attribute does
not exist.
CONTAINS
: checks for a
subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for a member of the set (not as a substring).
NOT_CONTAINS
: checks for absence of a
subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for the absence of a member of the set (not as a substring).
BEGINS_WITH
: checks for a
prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
IN
:
checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
BETWEEN
: Greater than or equal to the
first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a
set). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue of a different
type than the one specified in the request, the value does not match.
For example, {"S":"6"}
does not compare to
{"N":"6"}
. Also, {"N":"6"}
does not compare
to {"NS":["6", "2", "1"]}
For
usage examples of AttributeValueList and
ComparisonOperator, see Conditional
Expressions in the Amazon DynamoDB Developer Guide. For
backward compatibility with previous DynamoDB releases, the following
parameters can be used instead of AttributeValueList and
ComparisonOperator: Value - A value for
DynamoDB to compare with an attribute. Exists -
Causes DynamoDB to evaluate the value vefore attempting the
conditional operation: If Exists is
If Exists is Even though DynamoDB continues to
accept the Value and Exists parameters, they are now
deprecated. We recommend that you use AttributeValueList and
ComparisonOperator instead, since they allow you to constuct a
much wider range of conditions. The Value and Exists
parameters are incompatible with AttributeValueList and
ComparisonOperator. If you attempt to use both sets of
parameters at once, DynamoDB will throw a ValidationException.
true
, DynamoDB will check to see if that attribute???
value already exists in the table. If it is found, then the condition
evaluates to true; otherwise the condition evaluate to false.false
, DynamoDB assumes that
the attribute value does??? not exist in the table. If in fact
the value does not exist, then the??? assumption is valid and the
condition evaluates to true. If the value is found, despite the
assumption that it does not exist, the condition evaluates to
false.???
String returnValues
NONE
-
If ReturnValues is not specified, or if its value is
NONE
, then nothing is returned. (This is the default for
ReturnValues.)
ALL_OLD
- If
PutItem overwrote an attribute name-value pair, then the
content of the old item is returned.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
String returnConsumedCapacity
TOTAL
, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES
, the response includes ConsumedCapacity
for indexes. If set to NONE
(the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
String returnItemCollectionMetrics
SIZE
, statistics about item collections, if
any, that were modified during the operation are returned in the
response. If set to NONE
(the default), no statistics are
returned.
Constraints:
Allowed Values: SIZE, NONE
String conditionalOperator
AND
- If all of the conditions
evaluate to true, then the entire map evaluates to true.
OR
- If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is
the default.
The operation will succeed only if the entire map evaluates to true.
Constraints:
Allowed Values: AND, OR
Map<K,V> attributes
ALL_OLD
in the request. Each element consists of an
attribute name and an attribute value.ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
Each ItemCollectionMetrics element consists of:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size, measured in gigabytes. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
Map<K,V> item
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
String select
ALL_ATTRIBUTES
: Returns all of
the item attributes from the specified table or index. If you are
querying a local secondary index, then for each matching item in the
index DynamoDB will fetch the entire item from the parent table. If
the index is configured to project all item attributes, then all of
the data can be obtained from the local secondary index, and no
fetching is required..
ALL_PROJECTED_ATTRIBUTES
: Allowed only when querying
an index. Retrieves all attributes which have been projected into the
index. If the index is configured to project all attributes, this is
equivalent to specifying ALL_ATTRIBUTES
.
COUNT
: Returns the number of matching items, rather
than the matching items themselves.
SPECIFIC_ATTRIBUTES
: Returns only the attributes listed
in AttributesToGet. This is equivalent to specifying
AttributesToGet without specifying any value for Select.
If you are querying a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you are querying a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither
Select nor AttributesToGet are specified, DynamoDB
defaults to ALL_ATTRIBUTES
when accessing a table, and
ALL_PROJECTED_ATTRIBUTES
when accessing an index. You
cannot use both Select and AttributesToGet together in a
single request, unless the value for Select is
SPECIFIC_ATTRIBUTES
. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributesToGet
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both
AttributesToGet and Select together in a Query
request, unless the value for Select is
SPECIFIC_ATTRIBUTES
. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
If you are querying a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you are querying a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
Constraints:
Length: 1 -
Integer limit
Constraints:
Range: 1 -
Boolean consistentRead
true
, then the operation uses strongly
consistent reads; otherwise, eventually consistent reads are used.
Strongly consistent reads are not supported on global secondary
indexes. If you query a global secondary index with
ConsistentRead set to true
, you will receive an
error message.
Map<K,V> keyConditions
For a query on a table, you
can only have conditions on the table primary key attributes. You
must specify the hash key attribute name and value as an
EQ
condition. You can optionally specify a second
condition, referring to the range key attribute.
For a query on an index, you can only have conditions on the index key attributes. You must specify the index hash attribute name and value as an EQ condition. You can optionally specify a second condition, referring to the index key range attribute.
If you specify more than one condition in the KeyConditions map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each KeyConditions element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for
greater than, equals, or less than are based on ASCII character code
values. For example, a
is greater than A
,
and aa
is greater than B
. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT | GE | GT |
BEGINS_WITH | BETWEEN
The following are descriptions of these comparison operators.
EQ
: Equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not equal {"NS":["6", "2",
"1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
GE
: Greater than
or equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
BEGINS_WITH
:
checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
BETWEEN
: Greater than or equal to the first value,
and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a
set). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue of a different
type than the one specified in the request, the value does not match.
For example, {"S":"6"}
does not compare to
{"N":"6"}
. Also, {"N":"6"}
does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Conditional Expressions in the Amazon DynamoDB Developer Guide.
Map<K,V> queryFilter
If you specify more than one condition in the QueryFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each QueryFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for
greater than, equals, or less than are based on ASCII character code
values. For example, a
is greater than A
,
and aa
is greater than B
. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE |
LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH
| IN | BETWEEN
For complete descriptions of all comparison operators, see API_Condition.html.
String conditionalOperator
AND
- If all
of the conditions evaluate to true, then the entire map evaluates to
true.
OR
- If at least one of the
conditions evaluate to true, then the entire map evaluates to
true.
If you omit ConditionalOperator, then
AND
is the default.
The operation will succeed only if the entire map evaluates to true.
Constraints:
Allowed Values: AND, OR
Boolean scanIndexForward
If ScanIndexForward is not specified, the results are returned in ascending order.
Map<K,V> exclusiveStartKey
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
String returnConsumedCapacity
TOTAL
, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES
, the response includes ConsumedCapacity
for indexes. If set to NONE
(the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
Integer count
If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.
If you did not use a filter in the request, then Count and ScannedCount are the same.
Integer scannedCount
If you did not use a filter in the request, then ScannedCount is the same as Count.
Map<K,V> lastEvaluatedKey
If LastEvaluatedKey is null, then the "last page" of results has been processed and there is no more data to be retrieved.
If LastEvaluatedKey is anything other than null, this does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is null.
ConsumedCapacity consumedCapacity
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributesToGet
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
Constraints:
Length: 1 -
Integer limit
Constraints:
Range: 1 -
String select
ALL_ATTRIBUTES
: Returns all of the item
attributes.
COUNT
: Returns the number of
matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
: Returns only the attributes
listed in AttributesToGet. This is equivalent to specifying
AttributesToGet without specifying any value for Select.
If neither Select nor AttributesToGet are
specified, DynamoDB defaults to ALL_ATTRIBUTES
. You
cannot use both Select and AttributesToGet together in a
single request, unless the value for Select is
SPECIFIC_ATTRIBUTES
. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
Map<K,V> scanFilter
If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each ScanFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for
greater than, equals, or less than are based on ASCII character code
values. For example, a
is greater than A
,
and aa
is greater than B
. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE |
LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH
| IN | BETWEEN
For complete descriptions of all comparison operators, see API_Condition.html.
String conditionalOperator
AND
- If all of the conditions
evaluate to true, then the entire map evaluates to true.
OR
- If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is
the default.
The operation will succeed only if the entire map evaluates to true.
Constraints:
Allowed Values: AND, OR
Map<K,V> exclusiveStartKey
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
String returnConsumedCapacity
TOTAL
, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES
, the response includes ConsumedCapacity
for indexes. If set to NONE
(the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
Integer totalSegments
The value for TotalSegments must be greater than or equal to 1, and less than or equal to 4096. If you specify a TotalSegments value of 1, the Scan will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
Constraints:
Range: 1 - 1000000
Integer segment
Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application threads, the first thread would specify a Segment value of 0, the second thread would specify 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same Segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
If you specify Segment, you must also specify TotalSegments.
Constraints:
Range: 0 - 999999
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
Integer count
If you used a ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.
If you did not use a filter in the request, then Count is the same as ScannedCount.
Integer scannedCount
If you did not use a filter in the request, then ScannedCount is the same as Count.
Map<K,V> lastEvaluatedKey
If LastEvaluatedKey is null, then the "last page" of results has been processed and there is no more data to be retrieved.
If LastEvaluatedKey is anything other than null, this does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is null.
ConsumedCapacity consumedCapacity
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeDefinitions
Each AttributeDefinition object in this array is composed of:
AttributeName - The name of the attribute.
AttributeType - The data type for the attribute.
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
AttributeName - The name of the attribute.
KeyType - The key type for the
attribute. Can be either HASH
or RANGE
.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Constraints:
Length: 1 - 2
String tableStatus
CREATING - The table is being created, as the result of a CreateTable operation.
UPDATING - The table is being updated, as the result of an UpdateTable operation.
DELETING - The table is being deleted, as the result of a DeleteTable operation.
ACTIVE - The table is ready for use.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
Date creationDateTime
ProvisionedThroughputDescription provisionedThroughput
Long tableSizeBytes
Long itemCount
com.amazonaws.internal.ListWithAutoConstructFlag<T> localSecondaryIndexes
IndexName - The name of the local secondary index.
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY
- Only the index and primary keys are
projected into the index.
INCLUDE
- Only
the specified table attributes are projected into the index. The list
of projected attributes are in NonKeyAttributes.
ALL
- All of the table attributes are projected into
the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the
DELETING
state, no information about indexes will be
returned.
com.amazonaws.internal.ListWithAutoConstructFlag<T> globalSecondaryIndexes
IndexName - The name of the global secondary index.
IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexStatus - The current status of the global secondary index:
CREATING - The index is being created.
UPDATING - The index is being updated.
DELETING - The index is being deleted.
ACTIVE - The index is ready for use.
ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY
- Only the index
and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are
projected into the index. The list of projected attributes are in
NonKeyAttributes.
ALL
- All of the
table attributes are projected into the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the DELETING
state, no information
about indexes will be returned.
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
ProvisionedThroughput provisionedThroughput
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Map<K,V> key
Map<K,V> attributeUpdates
Attribute values cannot be null. String and binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException.
Each AttributeUpdates element consists of an attribute name to modify, along with the following:
Value - The new value, if applicable, for this attribute.
Action - Specifies how to perform the
update. Valid values for Action are PUT
,
DELETE
, and ADD
. The behavior depends on
whether the specified primary key already exists in the table.
If an item with the specified Key is found in the table:
PUT
- Adds the specified attribute to the
item. If the attribute already exists, it is replaced by the new
value.
DELETE
- If no value is specified,
the attribute and its value are removed from the item. The data type
of the specified value must match the existing value's data type.
If a set of values is specified, then those values are
subtracted from the old set. For example, if the attribute value was
the set [a,b,c]
and the DELETE action specified
[a,c]
, then the final attribute value would be
[b]
. Specifying an empty set is an error.
ADD
- If the attribute does not already exist, then
the attribute and its values are added to the item. If the attribute
does exist, then the behavior of ADD
depends on the data
type of the attribute:
If the existing attribute is a
number, and if Value is also a number, then the Value is
mathematically added to the existing attribute. If Value is a
negative number, then it is subtracted from the existing attribute.
If you use In addition, if you use
ADD
to increment or decrement a
number value for an item that doesn't exist before the update,
DynamoDB uses 0 as the initial value. ADD
to update an existing item, and intend to increment
or decrement an attribute value which does not yet exist, DynamoDB
uses 0
as the initial value. For example, suppose that
the item you want to update does not yet have an attribute named
itemcount, but you decide to ADD
the number
3
to this attribute anyway, even though it currently does
not exist. DynamoDB will create the itemcount attribute, set
its initial value to 0
, and finally add 3
to
it. The result will be a new itemcount attribute in the item,
with a value of 3
.
If the existing
data type is a set, and if the Value is also a set, then the
Value is added to the existing set. (This is a set
operation, not mathematical addition.) For example, if the attribute
value was the set [1,2]
, and the ADD
action
specified [3]
, then the final attribute value would be
[1,2,3]
. An error occurs if an Add action is specified
for a set attribute and the attribute type specified does not match
the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid
for an existing attribute whose data type is number or is a set. Do
not use ADD
for any other data types.
If no item with the specified Key is found:
PUT
- DynamoDB creates a new item with the specified
primary key, and then adds the attribute.
DELETE
- Nothing happens; there is no attribute to
delete.
ADD
- DynamoDB creates an item with
the supplied primary key and number (or set of numbers) for the
attribute value. The only data types allowed are number and number
set; no other data types can be specified.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
Map<K,V> expected
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are
based on ASCII character code values. For example, a
is
greater than A
, and aa
is greater than
B
. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS |
NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ
: Equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one specified in
the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2",
"1"]}
.
NE
: Not equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one specified in
the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2",
"1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
GE
: Greater than
or equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
NOT_NULL
: The
attribute exists.
NULL
: The attribute does
not exist.
CONTAINS
: checks for a
subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for a member of the set (not as a substring).
NOT_CONTAINS
: checks for absence of a
subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for the absence of a member of the set (not as a substring).
BEGINS_WITH
: checks for a
prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
IN
:
checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
BETWEEN
: Greater than or equal to the
first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a
set). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue of a different
type than the one specified in the request, the value does not match.
For example, {"S":"6"}
does not compare to
{"N":"6"}
. Also, {"N":"6"}
does not compare
to {"NS":["6", "2", "1"]}
For
usage examples of AttributeValueList and
ComparisonOperator, see Conditional
Expressions in the Amazon DynamoDB Developer Guide. For
backward compatibility with previous DynamoDB releases, the following
parameters can be used instead of AttributeValueList and
ComparisonOperator: Value - A value for
DynamoDB to compare with an attribute. Exists -
Causes DynamoDB to evaluate the value vefore attempting the
conditional operation: If Exists is
If Exists is Even though DynamoDB continues to
accept the Value and Exists parameters, they are now
deprecated. We recommend that you use AttributeValueList and
ComparisonOperator instead, since they allow you to constuct a
much wider range of conditions. The Value and Exists
parameters are incompatible with AttributeValueList and
ComparisonOperator. If you attempt to use both sets of
parameters at once, DynamoDB will throw a ValidationException.
true
, DynamoDB will check to see if that attribute???
value already exists in the table. If it is found, then the condition
evaluates to true; otherwise the condition evaluate to false.false
, DynamoDB assumes that
the attribute value does??? not exist in the table. If in fact
the value does not exist, then the??? assumption is valid and the
condition evaluates to true. If the value is found, despite the
assumption that it does not exist, the condition evaluates to
false.???
String conditionalOperator
AND
- If all of the conditions
evaluate to true, then the entire map evaluates to true.
OR
- If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is
the default.
The operation will succeed only if the entire map evaluates to true.
Constraints:
Allowed Values: AND, OR
String returnValues
NONE
- If ReturnValues is not specified, or if
its value is NONE
, then nothing is returned. (This is the
default for ReturnValues.)
ALL_OLD
-
If UpdateItem overwrote an attribute name-value pair, then the
content of the old item is returned.
UPDATED_OLD
- The old versions of only the updated
attributes are returned.
ALL_NEW
- All of
the attributes of the new version of the item are returned.
UPDATED_NEW
- The new versions of only the updated
attributes are returned.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
String returnConsumedCapacity
TOTAL
, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES
, the response includes ConsumedCapacity
for indexes. If set to NONE
(the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
String returnItemCollectionMetrics
SIZE
, statistics about item collections, if
any, that were modified during the operation are returned in the
response. If set to NONE
(the default), no statistics are
returned.
Constraints:
Allowed Values: SIZE, NONE
Map<K,V> attributes
NONE
in the request.
Each element represents one attribute.ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
ProvisionedThroughput provisionedThroughput
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> globalSecondaryIndexUpdates
TableDescription tableDescription
PutRequest putRequest
DeleteRequest deleteRequest
String vpcPeeringConnectionId
VpcPeeringConnection vpcPeeringConnection
String attributeName
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeValues
String attributeValue
String instanceId
String publicIp
String allocationId
String associationId
String domain
standard
) or instances in a VPC
(vpc
).
Constraints:
Allowed Values: vpc, standard
String networkInterfaceId
String networkInterfaceOwnerId
String privateIpAddress
String domain
vpc
to allocate the address for use with instances
in a VPC. Default: The address is for use with instances in EC2-Classic.
Constraints:
Allowed Values: vpc, standard
String publicIp
String domain
standard
) or instances in a VPC
(vpc
).
Constraints:
Allowed Values: vpc, standard
String allocationId
String networkInterfaceId
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
Integer secondaryPrivateIpAddressCount
Boolean allowReassignment
String instanceId
String publicIp
String allocationId
String networkInterfaceId
String privateIpAddress
Boolean allowReassociation
Default: false
String associationId
String associationId
String attachmentId
VolumeAttachment attachment
VpcAttachment vpcAttachment
String groupId
String sourceSecurityGroupName
String sourceSecurityGroupOwnerId
String ipProtocol
Integer fromPort
-1
to specify all
ICMP types.Integer toPort
-1
to specify all
ICMP codes for the ICMP type.String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
String groupName
String groupId
String sourceSecurityGroupName
String sourceSecurityGroupOwnerId
String ipProtocol
Integer fromPort
-1
to specify all
ICMP types.Integer toPort
-1
to specify all
ICMP codes for the ICMP type.String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
String zoneName
String state
Constraints:
Allowed Values: available
String regionName
com.amazonaws.internal.ListWithAutoConstructFlag<T> messages
String message
String virtualName
String deviceName
/dev/sdh
).EbsBlockDevice ebs
String noDevice
String instanceId
Storage storage
BundleTask bundleTask
String instanceId
String bundleId
String state
Constraints:
Allowed Values: pending, waiting-for-shutdown, bundling, storing, cancelling, complete, failed
Date startTime
Date updateTime
Storage storage
String progress
BundleTaskError bundleTaskError
String bundleId
BundleTask bundleTask
String exportTaskId
CreateInstanceExportTask
.String reservedInstancesListingId
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesListings
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotInstanceRequestIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> cancelledSpotInstanceRequests
String ownerId
String conversionTaskId
String expirationTime
ImportInstanceTaskDetails importInstance
ImportVolumeTaskDetails importVolume
String state
Constraints:
Allowed Values: active, cancelling, cancelled, completed
String statusMessage
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String sourceRegion
String sourceImageId
String name
String description
String clientToken
String imageId
String sourceRegion
String sourceSnapshotId
String description
String destinationRegion
PresignedUrl
.String presignedUrl
PresignedUrl
should use
the snapshot source endpoint, the CopySnapshot
action,
and include the SourceRegion
,
SourceSnapshotId
, and DestinationRegion
parameters. The PresignedUrl
must be signed using AWS
Signature Version 4. Because Amazon EBS snapshots are stored in Amazon
S3, the signing algorithm for this parameter uses the same logic that
is described in Authenticating
Requests by Using Query Parameters (AWS Signature Version 4) in
the Amazon Simple Storage Service API Reference. An invalid or
improperly signed PresignedUrl
will cause the copy
operation to fail asynchronously, and the snapshot will move to an
error
state.String snapshotId
String type
Constraints:
Allowed Values: ipsec.1
String publicIp
Integer bgpAsn
Default: 65000
CustomerGateway customerGateway
com.amazonaws.internal.ListWithAutoConstructFlag<T> dhcpConfigurations
DhcpOptions dhcpOptions
String instanceId
String name
Constraints: 3-128 alphanumeric characters, parenthesis (()), periods (.), slashes (/), dashes (-), or underscores(_)
String description
Boolean noReboot
false
, which means
Amazon EC2 attempts to shut down the instance cleanly before image
creation and then reboots the instance. When the parameter is set to
true
, Amazon EC2 doesn't shut down the instance before
creating the image. When this option is used, file system integrity on
the created image can't be guaranteed.com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
String imageId
String description
String instanceId
String targetEnvironment
Constraints:
Allowed Values: citrix, vmware, microsoft
ExportToS3TaskSpecification exportToS3Task
ExportTask exportTask
InternetGateway internetGateway
String keyName
KeyPair keyPair
String networkAclId
Integer ruleNumber
Constraints: Positive integer from 1 to 32766
String protocol
String ruleAction
Constraints:
Allowed Values: allow, deny
Boolean egress
String cidrBlock
IcmpTypeCode icmpTypeCode
PortRange portRange
String vpcId
NetworkAcl networkAcl
String subnetId
String description
String privateIpAddress
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
Integer secondaryPrivateIpAddressCount
The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide.
NetworkInterface networkInterface
String reservedInstancesId
Integer instanceCount
com.amazonaws.internal.ListWithAutoConstructFlag<T> priceSchedules
String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesListings
String routeTableId
String destinationCidrBlock
String gatewayId
String instanceId
String networkInterfaceId
String vpcPeeringConnectionId
String vpcId
RouteTable routeTable
String groupName
Constraints: Up to 255 characters in length
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
String description
String vpcId
String groupId
Snapshot snapshot
SpotDatafeedSubscription spotDatafeedSubscription
Subnet subnet
com.amazonaws.internal.ListWithAutoConstructFlag<T> resources
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
value
parameter is required, but if
you don't want the tag to have a value, specify the parameter with no
value, and we set the value to an empty string.com.amazonaws.internal.ListWithAutoConstructFlag<T> add
com.amazonaws.internal.ListWithAutoConstructFlag<T> remove
Integer size
Constraints: If the volume type is
io1
, the minimum size of the volume is 10 GiB.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
String snapshotId
String availabilityZone
String volumeType
gp2
for General Purpose
(SSD) volumes, io1
for Provisioned IOPS (SSD) volumes, or
standard
for Magnetic volumes. Default:
standard
Constraints:
Allowed Values: standard, io1, gp2
Integer iops
Boolean encrypted
Volume volume
VpcPeeringConnection vpcPeeringConnection
String cidrBlock
10.0.0.0/16
.String instanceTenancy
default
means that instances can be launched
with any tenancy; a value of dedicated
means all
instances launched into the VPC are launched as dedicated tenancy
instances regardless of the tenancy assigned to the instance at
launch. Dedicated tenancy instances runs on single-tenant hardware.
Default: default
Constraints:
Allowed Values: default, dedicated
Vpc vpc
String type
String customerGatewayId
String vpnGatewayId
VpnConnectionOptionsSpecification options
true
. Default: false
VpnConnection vpnConnection
VpnGateway vpnGateway
String customerGatewayId
String state
String type
String ipAddress
String bgpAsn
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String customerGatewayId
String dhcpOptionsId
String internetGatewayId
String keyName
String networkAclId
String networkInterfaceId
String groupName
String routeTableId
String snapshotId
String subnetId
com.amazonaws.internal.ListWithAutoConstructFlag<T> resources
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
value
parameter, we delete the tag regardless of its value. If you specify
this parameter with an empty string as the value, we delete the key
only if its value is an empty string.String volumeId
String vpcPeeringConnectionId
Boolean returnValue
true
if the request succeeds; otherwise, it
returns an error.String vpcId
String vpnConnectionId
String vpnGatewayId
String imageId
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> accountAttributes
com.amazonaws.internal.ListWithAutoConstructFlag<T> publicIps
Default: Describes all your Elastic IP addresses.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
allocation-id
-
[EC2-VPC] The allocation ID for the address.
association-id
- [EC2-VPC] The association ID for the
address.
domain
- Indicates whether the
address is for use in EC2-Classic (standard
) or in a VPC
(vpc
).
instance-id
- The ID of
the instance the address is associated with, if any.
network-interface-id
- [EC2-VPC] The ID of the network
interface that the address is associated with, if any.
network-interface-owner-id
- The AWS account ID of the
owner.
private-ip-address
- [EC2-VPC] The
private IP address associated with the Elastic IP address.
public-ip
- The Elastic IP address.
com.amazonaws.internal.ListWithAutoConstructFlag<T> allocationIds
Default: Describes all your Elastic IP addresses.
com.amazonaws.internal.ListWithAutoConstructFlag<T> addresses
com.amazonaws.internal.ListWithAutoConstructFlag<T> zoneNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
message
- Information
about the Availability Zone.
region-name
-
The name of the region for the Availability Zone (for example,
us-east-1
).
state
- The state
of the Availability Zone (available
|
impaired
| unavailable
).
zone-name
- The name of the Availability Zone (for
example, us-east-1a
).
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> bundleIds
Default: Describes all your bundle tasks.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
bundle-id
- The ID of
the bundle task.
error-code
- If the task
failed, the error code returned.
error-message
- If the task failed, the error message
returned.
instance-id
- The ID of the
instance.
progress
- The level of task
completion, as a percentage (for example, 20%).
s3-bucket
- The Amazon S3 bucket to store the AMI.
s3-prefix
- The beginning of the AMI name.
start-time
- The time the task started (for
example, 2013-09-15T17:15:20.000Z).
state
-
The state of the task (pending
|
waiting-for-shutdown
| bundling
|
storing
| cancelling
| complete
| failed
).
update-time
- The
time of the most recent update for the task.
com.amazonaws.internal.ListWithAutoConstructFlag<T> bundleTasks
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> conversionTaskIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> conversionTasks
com.amazonaws.internal.ListWithAutoConstructFlag<T> customerGatewayIds
Default: Describes all your customer gateways.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
bgp-asn
- The customer
gateway's Border Gateway Protocol (BGP) Autonomous System Number
(ASN).
customer-gateway-id
- The ID of the
customer gateway.
ip-address
- The IP
address of the customer gateway's Internet-routable external
interface.
state
- The state of the
customer gateway (pending
| available
|
deleting
| deleted
).
type
- The type of customer gateway. Currently, the
only supported type is ipsec.1
.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
com.amazonaws.internal.ListWithAutoConstructFlag<T> customerGateways
com.amazonaws.internal.ListWithAutoConstructFlag<T> dhcpOptionsIds
Default: Describes all your DHCP options sets.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
dhcp-options-id
- The
ID of a set of DHCP options.
key
- The key
for one of the options (for example, domain-name
).
value
- The value for one of the options.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
com.amazonaws.internal.ListWithAutoConstructFlag<T> dhcpOptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> exportTaskIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> exportTasks
ImageAttribute imageAttribute
com.amazonaws.internal.ListWithAutoConstructFlag<T> imageIds
Default: Describes all images available to you.
com.amazonaws.internal.ListWithAutoConstructFlag<T> owners
amazon
(owner is Amazon), aws-marketplace
(owner is AWS Marketplace), self
(owner is the sender of
the request), or all
(all owners).com.amazonaws.internal.ListWithAutoConstructFlag<T> executableUsers
self
(the sender of the request), or
all
(public AMIs).com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
architecture
- The
image architecture (i386
| x86_64
).
block-device-mapping.delete-on-termination
- A
Boolean value that indicates whether the Amazon EBS volume is deleted
on instance termination.
block-device-mapping.device-name
- The device name for
the Amazon EBS volume (for example, /dev/sdh
).
block-device-mapping.snapshot-id
- The ID of the
snapshot used for the Amazon EBS volume.
block-device-mapping.volume-size
- The volume size of
the Amazon EBS volume, in GiB.
block-device-mapping.volume-type
- The volume type of
the Amazon EBS volume (gp2
| standard
|
io1
).
description
- The
description of the image (provided during image creation).
hypervisor
- The hypervisor type (ovm
|
xen
).
image-id
- The ID of the
image.
image-type
- The image type
(machine
| kernel
| ramdisk
).
is-public
- A Boolean that indicates
whether the image is public.
kernel-id
-
The kernel ID.
manifest-location
- The
location of the image manifest.
name
- The
name of the AMI (provided during image creation).
owner-alias
- The AWS account alias (for example,
amazon
).
owner-id
- The AWS
account ID of the image owner.
platform
-
The platform. To only list Windows-based AMIs, use
windows
.
product-code
- The
product code.
product-code.type
- The type
of the product code (devpay
| marketplace
).
ramdisk-id
- The RAM disk ID.
root-device-name
- The name of the root device volume
(for example, /dev/sda1
).
root-device-type
- The type of the root device volume
(ebs
| instance-store
).
state
- The state of the image (available
| pending
| failed
).
state-reason-code
- The reason code for the state
change.
state-reason-message
- The message
for the state change.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For example, if
you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
virtualization-type
- The
virtualization type (paravirtual
| hvm
).
com.amazonaws.internal.ListWithAutoConstructFlag<T> images
String instanceId
String attribute
Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport
InstanceAttribute instanceAttribute
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
Default: Describes all your instances.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
architecture
- The
instance architecture (i386
| x86_64
).
availability-zone
- The Availability Zone of the
instance.
block-device-mapping.attach-time
- The attach time for an Amazon EBS volume mapped to the instance.
block-device-mapping.delete-on-termination
- A Boolean that indicates whether the Amazon EBS volume is deleted on
instance termination.
block-device-mapping.device-name
- The device name for
the Amazon EBS volume (for example, /dev/sdh
).
block-device-mapping.status
- The status for the
Amazon EBS volume (attaching
| attached
|
detaching
| detached
).
block-device-mapping.volume-id
- The volume ID of the
Amazon EBS volume.
client-token
- The
idempotency token you provided when you launched the instance.
dns-name
- The public DNS name of the instance.
group-id
- The ID of the security group for
the instance. If the instance is in EC2-Classic or a default VPC, you
can use group-name
instead.
group-name
- The name of the security group for the
instance. If the instance is in a nondefault VPC, you must use
group-id
instead.
hypervisor
-
The hypervisor type of the instance (ovm
|
xen
).
iam-instance-profile.arn
- The instance profile associated with the instance. Specified as an
ARN.
image-id
- The ID of the image used to
launch the instance.
instance-id
- The ID
of the instance.
instance-lifecycle
-
Indicates whether this is a Spot Instance (spot
).
instance-state-code
- The state of the instance,
as a 16-bit unsigned integer. The high byte is an opaque internal
value and should be ignored. The low byte is set based on the state
represented. The valid values are: 0 (pending), 16 (running), 32
(shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name
- The state of the
instance (pending
| running
|
shutting-down
| terminated
|
stopping
| stopped
).
instance-type
- The type of instance (for example,
m1.small
).
instance.group-id
-
The ID of the security group for the instance. If the instance is in
EC2-Classic or a default VPC, you can use
instance.group-name
instead.
instance.group-name
- The name of the security group
for the instance. If the instance is in a nondefault VPC, you must use
instance.group-id
instead.
ip-address
- The public IP address of the instance.
kernel-id
- The kernel ID.
key-name
- The name of the key pair used when the
instance was launched.
launch-index
- When
launching multiple instances, this is the index for the instance in
the launch group (for example, 0, 1, 2, and so on).
launch-time
- The time when the instance was launched.
monitoring-state
- Indicates whether
monitoring is enabled for the instance (disabled
|
enabled
).
owner-id
- The AWS
account ID of the instance owner.
placement-group-name
- The name of the placement group
for the instance.
platform
- The platform.
Use windows
if you have Windows instances; otherwise,
leave blank.
private-dns-name
- The private
DNS name of the instance.
private-ip-address
- The private IP address of the
instance.
product-code
- The product code
associated with the AMI used to launch the instance.
product-code.type
- The type of product code
(devpay
| marketplace
).
ramdisk-id
- The RAM disk ID.
reason
- The reason for the current state of the
instance (for example, shows "User Initiated [date]" when you stop or
terminate the instance). Similar to the state-reason-code filter.
requester-id
- The ID of the entity that
launched the instance on your behalf (for example, AWS Management
Console, Auto Scaling, and so on).
reservation-id
- The ID of the instance's reservation.
A reservation ID is created any time you launch an instance. A
reservation ID has a one-to-one relationship with an instance launch
request, but can be associated with more than one instance if you
launch multiple instances using the same launch request. For example,
if you launch one instance, you'll get one reservation ID. If you
launch ten instances using the same launch request, you'll also get
one reservation ID.
root-device-name
- The
name of the root device for the instance (for example,
/dev/sda1
).
root-device-type
-
The type of root device that the instance uses (ebs
|
instance-store
).
source-dest-check
- Indicates whether the instance
performs source/destination checking. A value of true
means that checking is enabled, and false
means checking
is disabled. The value must be false
for the instance to
perform network address translation (NAT) in your VPC.
spot-instance-request-id
- The ID of the Spot Instance
request.
state-reason-code
- The reason
code for the state change.
state-reason-message
- A message that describes the
state change.
subnet-id
- The ID of the
subnet for the instance.
tag
:key=value - The key/value
combination of a tag assigned to the resource, where
tag
:key is the tag's key.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
tenancy
- The tenancy of an
instance (dedicated
| default
).
virtualization-type
- The virtualization type of the
instance (paravirtual
| hvm
).
vpc-id
- The ID of the VPC that the instance is
running in.
network-interface.description
-
The description of the network interface.
network-interface.subnet-id
- The ID of the subnet for
the network interface.
network-interface.vpc-id
- The ID of the VPC for the
network interface.
network-interface.network-interface.id
- The ID of the
network interface.
network-interface.owner-id
- The ID of the owner of
the network interface.
network-interface.availability-zone
- The Availability
Zone for the network interface.
network-interface.requester-id
- The requester ID for
the network interface.
network-interface.requester-managed
- Indicates
whether the network interface is being managed by AWS.
network-interface.status
- The status of the network
interface (available
) | in-use
).
network-interface.mac-address
- The MAC address of the
network interface.
network-interface-private-dns-name
- The private DNS
name of the network interface.
network-interface.source-destination-check
- Whether
the network interface performs source/destination checking. A value of
true
means checking is enabled, and false
means checking is disabled. The value must be false
for
the network interface to perform network address translation (NAT) in
your VPC.
network-interface.group-id
- The
ID of a security group associated with the network interface.
network-interface.group-name
- The name of a
security group associated with the network interface.
network-interface.attachment.attachment-id
- The ID of
the interface attachment.
network-interface.attachment.instance-id
- The ID of
the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id
- The
owner ID of the instance to which the network interface is attached.
network-interface.addresses.private-ip-address
- The
private IP address associated with the network interface.
network-interface.attachment.device-index
- The device
index to which the network interface is attached.
network-interface.attachment.status
- The status of
the attachment (attaching
| attached
|
detaching
| detached
).
network-interface.attachment.attach-time
- The time
that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination
-
Specifies whether the attachment is deleted when an instance is
terminated.
network-interface.addresses.primary
- Specifies
whether the IP address of the network interface is the primary private
IP address.
network-interface.addresses.association.public-ip
-
The ID of the association of an Elastic IP address with a network
interface.
network-interface.addresses.association.ip-owner-id
-
The owner ID of the private IP address associated with the network
interface.
association.public-ip
- The
address of the Elastic IP address bound to the network interface.
association.ip-owner-id
- The owner of the
Elastic IP address associated with the network interface.
association.allocation-id
- The allocation ID returned
when you allocated the Elastic IP address for your network interface.
association.association-id
- The
association ID returned when the network interface was associated with
an IP address.
String nextToken
Integer maxResults
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservations
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone
- The
Availability Zone of the instance.
event.code
- The code identifying the type of event
(instance-reboot
| system-reboot
|
system-maintenance
| instance-retirement
|
instance-stop
).
event.description
- A description of the event.
event.not-after
- The latest end time for the
scheduled event.
event.not-before
- The
earliest start time for the scheduled event.
instance-state-code
- A code representing the state of
the instance, as a 16-bit unsigned integer. The high byte is an opaque
internal value and should be ignored. The low byte is set based on the
state represented. The valid values are 0 (pending), 16 (running), 32
(shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name
- The state of the
instance (pending
| running
|
shutting-down
| terminated
|
stopping
| stopped
).
instance-status.reachability
- Filters on instance
status where the name is reachability
(passed
| failed
| initializing
| insufficient-data
).
instance-status.status
- The status of the instance
(ok
| impaired
| initializing
|
insufficient-data
| not-applicable
).
system-status.reachability
- Filters on system
status where the name is reachability
(passed
| failed
| initializing
| insufficient-data
).
system-status.status
- The system status of the
instance (ok
| impaired
|
initializing
| insufficient-data
|
not-applicable
).
String nextToken
Integer maxResults
Default: 1000
Boolean includeAllInstances
true
, includes the health status for all instances.
When false
, includes the health status for running
instances only. Default: false
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceStatuses
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> internetGatewayIds
Default: Describes all your Internet gateways.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
attachment.state
- The
current state of the attachment between the gateway and the VPC.
Present only if a VPC is attached.
attachment.vpc-id
- The ID of an attached VPC.
internet-gateway-id
- The ID of the Internet
gateway.
tag
:key=value - The
key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
com.amazonaws.internal.ListWithAutoConstructFlag<T> internetGateways
com.amazonaws.internal.ListWithAutoConstructFlag<T> keyNames
Default: Describes all your key pairs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
fingerprint
- The
fingerprint of the key pair.
key-name
- The
name of the key pair.
com.amazonaws.internal.ListWithAutoConstructFlag<T> keyPairs
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkAclIds
Default: Describes all your network ACLs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
association.association-id
- The ID of an association
ID for the ACL.
association.network-acl-id
- The ID of the network ACL involved in the association.
association.subnet-id
- The ID of the subnet involved
in the association.
default
- Indicates
whether the ACL is the default network ACL for the VPC.
entry.cidr
- The CIDR range specified in the entry.
entry.egress
- Indicates whether the entry
applies to egress traffic.
entry.icmp.code
- The ICMP code specified in the entry, if any.
entry.icmp.type
- The ICMP type specified in the
entry, if any.
entry.port-range.from
- The
start of the port range specified in the entry.
entry.port-range.to
- The end of the port range
specified in the entry.
entry.protocol
-
The protocol specified in the entry (tcp
|
udp
| icmp
or a protocol number).
entry.rule-action
- Allows or denies the matching
traffic (allow
| deny
).
entry.rule-number
- The number of an entry (in other
words, rule) in the ACL's set of entries.
network-acl-id
- The ID of the network ACL.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id
- The ID of the VPC for the
network ACL.
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkAcls
String networkInterfaceId
String description
Boolean sourceDestCheck
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
NetworkInterfaceAttachment attachment
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaceIds
Default: Describes all your network interfaces.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
addresses.private-ip-address
- The private IP
addresses associated with the network interface.
addresses.primary
- Whether the private IP address is
the primary IP address associated with the network interface.
addresses.association.public-ip
- The association
ID returned when the network interface was associated with the Elastic
IP address.
addresses.association.owner-id
- The owner ID of the addresses associated with the network interface.
association.association-id
- The
association ID returned when the network interface was associated with
an IP address.
association.allocation-id
-
The allocation ID returned when you allocated the Elastic IP address
for your network interface.
association.ip-owner-id
- The owner of the Elastic IP
address associated with the network interface.
association.public-ip
- The address of the Elastic IP
address bound to the network interface.
association.public-dns-name
- The public DNS name for
the network interface.
attachment.attachment-id
- The ID of the interface
attachment.
attachment.instance-id
- The ID
of the instance to which the network interface is attached.
attachment.instance-owner-id
- The owner ID of the
instance to which the network interface is attached.
attachment.device-index
- The device index to which
the network interface is attached.
attachment.status
- The status of the attachment
(attaching
| attached
|
detaching
| detached
).
attachment.attach.time
- The time that the network
interface was attached to an instance.
attachment.delete-on-termination
- Indicates whether
the attachment is deleted when an instance is terminated.
availability-zone
- The Availability Zone of the
network interface.
description
- The
description of the network interface.
group-id
- The ID of a security group associated with
the network interface.
group-name
- The
name of a security group associated with the network interface.
mac-address
- The MAC address of the network
interface.
network-interface-id
- The ID of
the network interface.
owner-id
- The AWS
account ID of the network interface owner.
private-ip-address
- The private IP address or
addresses of the network interface.
private-dns-name
- The private DNS name of the network
interface.
requester-id
- The ID of the
entity that launched the instance on your behalf (for example, AWS
Management Console, Auto Scaling, and so on).
requester-managed
- Indicates whether the network
interface is being managed by an AWS service (for example, AWS
Management Console, Auto Scaling, and so on).
source-desk-check
- Indicates whether the network
interface performs source/destination checking. A value of
true
means checking is enabled, and false
means checking is disabled. The value must be false
for
the network interface to perform Network Address Translation (NAT) in
your VPC.
status
- The status of the
network interface. If the network interface is not attached to an
instance, the status is available
; if a network interface
is attached to an instance the status is in-use
.
subnet-id
- The ID of the subnet for the network
interface.
tag
:key=value -
The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the
resource. This filter is independent of the tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and
the filter "tag-value=X", you get any resources assigned both the tag
key Purpose (regardless of what the tag's value is), and the tag value
X (regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id
- The ID of the VPC for the
network interface.
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
Default: Describes all your placement groups, or only those otherwise specified.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
group-name
- The name
of the placement group.
state
- The state
of the placement group (pending
| available
| deleting
| deleted
).
strategy
- The strategy of the placement group
(cluster
).
com.amazonaws.internal.ListWithAutoConstructFlag<T> placementGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> regionNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
endpoint
- The endpoint
of the region (for example, ec2.us-east-1.amazonaws.com
).
region-name
- The name of the region (for
example, us-east-1
).
com.amazonaws.internal.ListWithAutoConstructFlag<T> regions
String reservedInstancesId
String reservedInstancesListingId
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
reserved-instances-id
-
The ID of the Reserved Instances.
reserved-instances-listing-id
- The ID of the Reserved
Instances listing.
status
- The status of
the Reserved Instance listing (pending
|
active
| cancelled
| closed
).
status-message
- The reason for the status.
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesListings
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesModificationIds
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
client-token
- The
idempotency token for the modification request.
create-date
- The time when the modification request
was created.
effective-date
- The time when
the modification becomes effective.
modification-result.reserved-instances-id
- The ID for
the Reserved Instances created as part of the modification request.
This ID is only available when the status of the modification is
fulfilled
.
modification-result.target-configuration.availability-zone
- The Availability Zone for the new Reserved Instances.
modification-result.target-configuration.instance-count
- The number of new Reserved Instances.
modification-result.target-configuration.instance-type
- The instance type of the new Reserved Instances.
modification-result.target-configuration.platform
-
The network platform of the new Reserved Instances
(EC2-Classic
| EC2-VPC
).
reserved-instances-id
- The ID of the Reserved
Instances modified.
reserved-instances-modification-id
- The ID of the
modification request.
status
- The status
of the Reserved Instances modification request
(processing
| fulfilled
|
failed
).
status-message
- The
reason for the status.
update-date
- The
time when the modification request was last updated.
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesModifications
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesOfferingIds
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, t2.micro, t2.small, t2.medium, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge
String availabilityZone
String productDescription
(Amazon VPC)
in the description are for use with Amazon
VPC.
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone
- The
Availability Zone where the Reserved Instance can be used.
duration
- The duration of the Reserved Instance (for
example, one year or three years), in seconds.
fixed-price
- The purchase price of the Reserved
Instance (for example, 9800.0).
instance-type
- The instance type on which the
Reserved Instance can be used.
marketplace
- Set to true
to show only Reserved Instance Marketplace
offerings. When this filter is not used, which is the default
behavior, all offerings from AWS and Reserved Instance Marketplace are
listed.
product-description
- The
description of the Reserved Instance (Linux/UNIX
|
Linux/UNIX (Amazon VPC)
| Windows
|
Windows (Amazon VPC)
).
reserved-instances-offering-id
- The Reserved
Instances offering ID.
usage-price
- The
usage price of the Reserved Instance, per hour (for example, 0.84).
String instanceTenancy
dedicated
tenancy runs on single-tenant hardware and
can only be launched within a VPC. Default: default
Constraints:
Allowed Values: default, dedicated
String offeringType
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
String nextToken
Integer maxResults
Boolean includeMarketplace
Long minDuration
Long maxDuration
Integer maxInstanceCount
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesOfferings
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesIds
Default: Describes all your Reserved Instances, or only those otherwise specified.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone
- The
Availability Zone where the Reserved Instance can be used.
duration
- The duration of the Reserved Instance (one
year or three years), in seconds (31536000
|
94608000
).
end
- The time when
the Reserved Instance expires.
fixed-price
- The purchase price of the Reserved Instance (for example, 9800.0).
instance-type
- The instance type on which
the Reserved Instance can be used.
product-description
- The product description of the
Reserved Instance (Linux/UNIX
| Linux/UNIX (Amazon
VPC)
| Windows
| Windows (Amazon
VPC)
).
reserved-instances-id
- The
ID of the Reserved Instance.
start
- The
time at which the Reserved Instance purchase request was placed.
state
- The state of the Reserved Instance
(pending-payment
| active
|
payment-failed
| retired
).
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
usage-price
- The usage price of
the Reserved Instance, per hour (for example, 0.84).
String offeringType
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstances
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeTableIds
Default: Describes all your route tables.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
association.route-table-association-id
- The ID of an
association ID for the route table.
association.route-table-id
- The ID of the route table
involved in the association.
association.subnet-id
- The ID of the subnet involved
in the association.
association.main
-
Indicates whether the route table is the main route table for the VPC.
route-table-id
- The ID of the route table.
route.destination-cidr-block
- The CIDR
range specified in a route in the table.
route.gateway-id
- The ID of a gateway specified in a
route in the table.
route.instance-id
- The
ID of an instance specified in a route in the table.
route.origin
- Describes how the route was created
(CreateRouteTable
| CreateRoute
|
EnableVgwRoutePropagation
).
route.state
- The state of a route in the route table
(active
| blackhole
). The blackhole state
indicates that the route's target isn't available (for example, the
specified gateway isn't attached to the VPC, the specified NAT
instance has been terminated, and so on).
route.vpc-peering-connection-id
- The ID of a VPC
peering connection specified in a route in the table.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id
- The ID of the VPC for the
route table.
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeTables
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
Default: Describes all your security groups.
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupIds
Default: Describes all your security groups.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
description
- The
description of the security group.
group-id
- The ID of the security group.
group-name
- The name of the security group.
ip-permission.cidr
- A CIDR range that has been
granted permission.
ip-permission.from-port
- The start of port range for the TCP and UDP protocols, or an ICMP
type number.
ip-permission.group-id
- The
ID of a security group that has been granted permission.
ip-permission.group-name
- The name of a security
group that has been granted permission.
ip-permission.protocol
- The IP protocol for the
permission (tcp
| udp
| icmp
or
a protocol number).
ip-permission.to-port
-
The end of port range for the TCP and UDP protocols, or an ICMP code.
ip-permission.user-id
- The ID of an AWS
account that has been granted permission.
owner-id
- The AWS account ID of the owner of the
security group.
tag-key
- The key of a tag
assigned to the security group.
tag-value
-
The value of a tag assigned to the security group.
vpc-id
- The ID of the VPC specified when the security
group was created.
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
String snapshotId
com.amazonaws.internal.ListWithAutoConstructFlag<T> createVolumePermissions
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotIds
Default: Describes snapshots for which you have launch permissions.
com.amazonaws.internal.ListWithAutoConstructFlag<T> ownerIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> restorableByUserIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
description
- A
description of the snapshot.
owner-alias
-
The AWS account alias (for example, amazon
) that owns the
snapshot.
owner-id
- The ID of the AWS
account that owns the snapshot.
progress
-
The progress of the snapshot, as a percentage (for example, 80%).
snapshot-id
- The snapshot ID.
start-time
- The time stamp when the snapshot was
initiated.
status
- The status of the
snapshot (pending
| completed
|
error
).
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
volume-id
- The ID of the volume
the snapshot is for.
volume-size
- The size
of the volume, in GiB.
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshots
SpotDatafeedSubscription spotDatafeedSubscription
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotInstanceRequestIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone-group
- The Availability Zone group.
create-time
- The time stamp when the Spot Instance request was created.
fault-code
- The fault code related to the
request.
fault-message
- The fault message
related to the request.
instance-id
- The
ID of the instance that fulfilled the request.
launch-group
- The Spot Instance launch group.
launch.block-device-mapping.delete-on-termination
- Indicates whether the Amazon EBS volume is deleted on instance
termination.
launch.block-device-mapping.device-name
- The device
name for the Amazon EBS volume (for example, /dev/sdh
).
launch.block-device-mapping.snapshot-id
-
The ID of the snapshot used for the Amazon EBS volume.
launch.block-device-mapping.volume-size
- The size of
the Amazon EBS volume, in GiB.
launch.block-device-mapping.volume-type
- The type of
the Amazon EBS volume (gp2
| standard
|
io1
).
launch.group-id
- The
security group for the instance.
launch.image-id
- The ID of the AMI.
launch.instance-type
- The type of instance (for
example, m1.small
).
launch.kernel-id
- The kernel ID.
launch.key-name
- The name of the key pair the
instance launched with.
launch.monitoring-enabled
- Whether monitoring is
enabled for the Spot Instance.
launch.ramdisk-id
- The RAM disk ID.
launch.network-interface.network-interface-id
- The ID
of the network interface.
launch.network-interface.device-index
- The index of
the device for the network interface attachment on the instance.
launch.network-interface.subnet-id
- The ID of
the subnet for the instance.
launch.network-interface.description
- A description
of the network interface.
launch.network-interface.private-ip-address
- The
primary private IP address of the network interface.
launch.network-interface.delete-on-termination
-
Indicates whether the network interface is deleted when the instance
is terminated.
launch.network-interface.group-id
- The ID of the
security group associated with the network interface.
launch.network-interface.group-name
- The name of the
security group associated with the network interface.
launch.network-interface.addresses.primary
- Indicates
whether the IP address is the primary private IP address.
product-description
- The product description
associated with the instance (Linux/UNIX
|
Windows
).
spot-instance-request-id
- The Spot Instance request
ID.
spot-price
- The maximum hourly price
for any Spot Instance launched to fulfill the request.
state
- The state of the Spot Instance request
(open
| active
| closed
|
cancelled
| failed
).
status-code
- The short code describing the most
recent evaluation of your Spot Instance request.
status-message
- The message explaining the status of
the Spot Instance request.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
type
- The type of Spot Instance
request (one-time
| persistent
).
launched-availability-zone
- The Availability Zone in
which the bid is launched.
valid-from
- The
start date of the request.
valid-until
-
The end date of the request.
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotInstanceRequests
Date startTime
Date endTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceTypes
com.amazonaws.internal.ListWithAutoConstructFlag<T> productDescriptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone
- The
Availability Zone for which prices should be returned.
instance-type
- The type of instance (for example,
m1.small
).
product-description
- The product description for the Spot Price (Linux/UNIX
| SUSE Linux
| Windows
| Linux/UNIX
(Amazon VPC)
| SUSE Linux (Amazon VPC)
|
Windows (Amazon VPC)
).
spot-price
- The Spot Price. The value must match
exactly (or use wildcards; greater than or less than comparison is not
supported).
timestamp
- The timestamp of
the Spot Price history (for example, 2010-08-16T05:06:11.000Z). You
can use wildcards (* and ?). Greater than or less than comparison is
not supported.
String availabilityZone
Integer maxResults
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotPriceHistory
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
Default: Describes all your subnets.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availabilityZone
- The
Availability Zone for the subnet. You can also use
availability-zone
as the filter name.
available-ip-address-count
- The number of IP
addresses in the subnet that are available.
cidrBlock
- The CIDR block of the subnet. The CIDR
block you specify must exactly match the subnet's CIDR block for
information to be returned for the subnet. You can also use
cidr
or cidr-block
as the filter names.
defaultForAz
- Indicates whether this is
the default subnet for the Availability Zone. You can also use
default-for-az
as the filter name.
state
- The state of the subnet (pending
| available
).
subnet-id
- The
ID of the subnet.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id
- The ID of the VPC for the
subnet.
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
key
- The tag key.
resource-id
- The resource ID.
resource-type
- The resource type
(customer-gateway
| dhcp-options
|
image
| instance
|
internet-gateway
| network-acl
|
network-interface
| reserved-instances
|
route-table
| security-group
|
snapshot
| spot-instances-request
|
subnet
| volume
| vpc
|
vpn-connection
| vpn-gateway
).
value
- The tag value.
Integer maxResults
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String nextToken
String volumeId
Boolean autoEnableIO
autoEnableIO
attribute.com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
attachment.attach-time
- The time stamp when the attachment initiated.
attachment.delete-on-termination
- Whether the volume
is deleted on instance termination.
attachment.device
- The device name that is exposed to
the instance (for example, /dev/sda1
).
attachment.instance-id
- The ID of the instance the
volume is attached to.
attachment.status
-
The attachment state (attaching
| attached
|
detaching
| detached
).
availability-zone
- The Availability Zone in which the
volume was created.
create-time
- The time
stamp when the volume was created.
encrypted
- The encryption status of the volume.
size
- The size of the volume, in GiB.
snapshot-id
- The snapshot from which the volume was
created.
status
- The status of the volume
(creating
| available
| in-use
| deleting
| deleted
| error
).
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
volume-id
- The volume ID.
volume-type
- The Amazon EBS volume type. This
can be gp2
for General Purpose (SSD) volumes,
io1
for Provisioned IOPS (SSD) volumes, or
standard
for Magnetic volumes.
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumes
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeIds
Default: Describes all your volumes.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
action.code
- The
action code for the event (for example,
enable-volume-io
).
action.description
- A description of the action.
action.event-id
- The event ID associated
with the action.
availability-zone
- The
Availability Zone of the instance.
event.description
- A description of the event.
event.event-id
- The event ID.
event.event-type
- The event type (for
io-enabled
: passed
| failed
;
for io-performance
: io-performance:degraded
| io-performance:severely-degraded
|
io-performance:stalled
).
event.not-after
- The latest end time for the event.
event.not-before
- The earliest start time
for the event.
volume-status.details-name
-
The cause for volume-status.status
(io-enabled
| io-performance
).
volume-status.details-status
- The status of
volume-status.details-name
(for io-enabled
:
passed
| failed
; for
io-performance
: normal
|
degraded
| severely-degraded
|
stalled
).
volume-status.status
- The status of the volume (ok
| impaired
|
warning
| insufficient-data
).
String nextToken
Integer maxResults
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeStatuses
String nextToken
String vpcId
Boolean enableDnsSupport
true
, the Amazon DNS server resolves DNS
hostnames for your instances to their corresponding IP addresses;
otherwise, it does not.Boolean enableDnsHostnames
true
, instances in the VPC get DNS
hostnames; otherwise, they do not.com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcPeeringConnectionIds
Default: Describes all your VPC peering connections.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
accepter-vpc-info.cidr-block
- The CIDR block of the
peer VPC.
accepter-vpc-info.owner-id
- The
AWS account ID of the owner of the peer VPC.
accepter-vpc-info.vpc-id
- The ID of the peer VPC.
expiration-time
- The expiration date and
time for the VPC peering connection.
requester-vpc-info.cidr-block
- The CIDR block of the
requester's VPC.
requester-vpc-info.owner-id
- The AWS account ID of
the owner of the requester VPC.
requester-vpc-info.vpc-id
- The ID of the requester
VPC.
status-code
- The status of the VPC
peering connection (pending-acceptance
|
failed
| expired
| provisioning
| active
| deleted
| rejected
).
status-message
- A message that provides
more information about the status of the VPC peering connection, if
applicable.
tag
:key=value -
The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the
resource. This filter is independent of the tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and
the filter "tag-value=X", you get any resources assigned both the tag
key Purpose (regardless of what the tag's value is), and the tag value
X (regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-peering-connection-id
- The ID
of the VPC peering connection.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcPeeringConnections
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcIds
Default: Describes all your VPCs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
cidr
- The CIDR block
of the VPC. The CIDR block you specify must exactly match the VPC's
CIDR block for information to be returned for the VPC.
dhcp-options-id
- The ID of a set of DHCP options.
isDefault
- Indicates whether the VPC is
the default VPC.
state
- The state of the
VPC (pending
| available
).
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id
- The ID of the VPC.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcs
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpnConnectionIds
Default: Describes your VPN connections.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
customer-gateway-configuration
- The configuration
information for the customer gateway.
customer-gateway-id
- The ID of a customer gateway
associated with the VPN connection.
state
-
The state of the VPN connection (pending
|
available
| deleting
|
deleted
).
option.static-routes-only
- Indicates whether the
connection has static routes only. Used for devices that do not
support Border Gateway Protocol (BGP).
route.destination-cidr-block
- The destination CIDR
block. This corresponds to the subnet used in a customer data center.
bgp-asn
- The BGP Autonomous System Number
(ASN) associated with a BGP device.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
type
- The type of VPN connection.
Currently the only supported type is ipsec.1
.
vpn-connection-id
- The ID of the VPN connection.
vpn-gateway-id
- The ID of a virtual
private gateway associated with the VPN connection.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpnConnections
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpnGatewayIds
Default: Describes all your virtual private gateways.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
attachment.state
- The
current state of the attachment between the gateway and the VPC
(attaching
| attached
|
detaching
| detached
).
attachment.vpc-id
- The ID of an attached VPC.
availability-zone
- The Availability Zone for the
virtual private gateway.
state
- The state
of the virtual private gateway (pending
|
available
| deleting
|
deleted
).
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
type
- The type of virtual private
gateway. Currently the only supported type is ipsec.1
.
vpn-gateway-id
- The ID of the virtual
private gateway.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpnGateways
String volumeId
String instanceId
String device
Boolean force
VolumeAttachment attachment
String key
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
String dhcpOptionsId
com.amazonaws.internal.ListWithAutoConstructFlag<T> dhcpConfigurations
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String associationId
DiskImageDetail image
String description
VolumeDetail volume
String format
Constraints:
Allowed Values: VMDK, RAW, VHD
Long size
String importManifestUrl
String checksum
String format
Constraints:
Allowed Values: VMDK, RAW, VHD
Long bytes
String importManifestUrl
String snapshotId
Integer volumeSize
Constraints: If the volume type is
io1
, the minimum size of the volume is 10 GiB; otherwise,
the minimum size is 1 GiB. The maximum volume size is 1024 GiB.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
Boolean deleteOnTermination
String volumeType
gp2
for General Purpose (SSD) volumes,
io1
for Provisioned IOPS (SSD) volumes, and
standard
for Magnetic volumes. Default:
standard
Constraints:
Allowed Values: standard, io1, gp2
Integer iops
Constraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes.
Condition: This parameter is required for requests to create
io1
volumes; it is not used in requests to create
standard
or gp2
volumes.
Boolean encrypted
String volumeId
String status
Constraints:
Allowed Values: attaching, attached, detaching, detached
Date attachTime
Boolean deleteOnTermination
String volumeId
String exportTaskId
String description
String state
Constraints:
Allowed Values: active, cancelling, cancelled, completed
String statusMessage
InstanceExportDetails instanceExportDetails
ExportToS3Task exportToS3Task
String diskImageFormat
Constraints:
Allowed Values: VMDK, RAW, VHD
String containerFormat
Constraints:
Allowed Values: ova
String s3Bucket
[email protected]
.String s3Key
String diskImageFormat
Constraints:
Allowed Values: VMDK, RAW, VHD
String containerFormat
Constraints:
Allowed Values: ova
String s3Bucket
String s3Prefix
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
String instanceId
String instanceId
String imageId
String imageLocation
String state
available
,
the image is successfully registered and can be used to launch an
instance.
Constraints:
Allowed Values: available, deregistered
String ownerId
Boolean publicValue
true
if this image has public launch permissions or
false
if it has only implicit and explicit launch
permissions.com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
String architecture
Constraints:
Allowed Values: i386, x86_64
String imageType
Constraints:
Allowed Values: machine, kernel, ramdisk
String kernelId
String ramdiskId
String platform
Windows
for Windows AMIs; otherwise blank.
Constraints:
Allowed Values: Windows
String sriovNetSupport
StateReason stateReason
String imageOwnerAlias
amazon
,
self
) or the AWS account ID of the AMI owner.String name
String description
String rootDeviceType
Constraints:
Allowed Values: ebs, instance-store
String rootDeviceName
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
String virtualizationType
Constraints:
Allowed Values: hvm, paravirtual
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String hypervisor
Constraints:
Allowed Values: ovm, xen
String imageId
com.amazonaws.internal.ListWithAutoConstructFlag<T> launchPermissions
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
String kernelId
String ramdiskId
String description
String sriovNetSupport
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
String architecture
Constraints:
Allowed Values: i386, x86_64
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
String additionalInfo
String userData
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, t2.micro, t2.small, t2.medium, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge
Placement placement
Boolean monitoring
String subnetId
String instanceInitiatedShutdownBehavior
Constraints:
Allowed Values: stop, terminate
String privateIpAddress
String description
ImportInstanceLaunchSpecification launchSpecification
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskImages
String platform
Constraints:
Allowed Values: Windows
ConversionTask conversionTask
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumes
String instanceId
String platform
Constraints:
Allowed Values: Windows
String description
Long bytesConverted
String availabilityZone
DiskImageDescription image
DiskImageVolumeDescription volume
String status
String statusMessage
String description
String availabilityZone
DiskImageDetail image
String description
VolumeDetail volume
ConversionTask conversionTask
Long bytesConverted
String availabilityZone
String description
DiskImageDescription image
DiskImageVolumeDescription volume
String instanceId
String imageId
InstanceState state
String privateDnsName
running
state.String publicDnsName
running
state.String stateTransitionReason
String keyName
Integer amiLaunchIndex
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, t2.micro, t2.small, t2.medium, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge
Date launchTime
Placement placement
String kernelId
String ramdiskId
String platform
Windows
for Windows instances; otherwise
blank.
Constraints:
Allowed Values: Windows
Monitoring monitoring
String subnetId
String vpcId
String privateIpAddress
String publicIpAddress
StateReason stateReason
String architecture
Constraints:
Allowed Values: i386, x86_64
String rootDeviceType
Constraints:
Allowed Values: ebs, instance-store
String rootDeviceName
/dev/sda1
).com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
String virtualizationType
Constraints:
Allowed Values: hvm, paravirtual
String instanceLifecycle
Constraints:
Allowed Values: spot
String spotInstanceRequestId
String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
Boolean sourceDestCheck
true
means checking is enabled,
and false
means checking is disabled. The value must be
false
for the instance to perform NAT. For more
information, see NAT
Instances in the Amazon Virtual Private Cloud User Guide.String hypervisor
Constraints:
Allowed Values: ovm, xen
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfile iamInstanceProfile
Boolean ebsOptimized
String sriovNetSupport
String instanceId
String instanceType
String kernelId
String ramdiskId
String userData
Boolean disableApiTermination
true
, you can't terminate the instance
through the Amazon EC2 console, CLI, or API; otherwise, you can.String instanceInitiatedShutdownBehavior
String rootDeviceName
/dev/sda1
).com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
Boolean ebsOptimized
String sriovNetSupport
Boolean sourceDestCheck
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
String deviceName
EbsInstanceBlockDevice ebs
String deviceName
EbsInstanceBlockDeviceSpecification ebs
String virtualName
String noDevice
String instanceId
Monitoring monitoring
String networkInterfaceId
String subnetId
String vpcId
String description
String ownerId
String status
Constraints:
Allowed Values: available, attaching, in-use, detaching
String privateIpAddress
String privateDnsName
Boolean sourceDestCheck
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
InstanceNetworkInterfaceAttachment attachment
InstanceNetworkInterfaceAssociation association
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
String attachmentId
Integer deviceIndex
String status
Constraints:
Allowed Values: attaching, attached, detaching, detached
Date attachTime
Boolean deleteOnTermination
String networkInterfaceId
Integer deviceIndex
String subnetId
String description
String privateIpAddress
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
Boolean deleteOnTermination
true
, the interface is deleted when the
instance is terminated. You can specify true
only if
creating a new network interface when launching an instance.com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
Integer secondaryPrivateIpAddressCount
Boolean associatePublicIpAddress
String privateIpAddress
String privateDnsName
Boolean primary
InstanceNetworkInterfaceAssociation association
Integer code
0
:
pending
16
:
running
32
:
shutting-down
48
:
terminated
64
:
stopping
80
:
stopped
String name
Constraints:
Allowed Values: pending, running, shutting-down, terminated, stopping, stopped
String instanceId
InstanceState currentState
InstanceState previousState
String instanceId
String availabilityZone
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
InstanceState instanceState
running
state.InstanceStatusSummary systemStatus
InstanceStatusSummary instanceStatus
String name
Constraints:
Allowed Values: reachability
String status
Constraints:
Allowed Values: passed, failed, insufficient-data
Date impairedSince
String code
Constraints:
Allowed Values: instance-reboot, system-reboot, system-maintenance, instance-retirement, instance-stop
String description
Date notBefore
Date notAfter
String status
Constraints:
Allowed Values: ok, impaired, insufficient-data, not-applicable
com.amazonaws.internal.ListWithAutoConstructFlag<T> details
String internetGatewayId
com.amazonaws.internal.ListWithAutoConstructFlag<T> attachments
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String ipProtocol
When you call DescribeSecurityGroups, the
protocol value returned is the number. Exception: For TCP, UDP, and
ICMP, the value returned is the name (for example, tcp
,
udp
, or icmp
). For a list of protocol
numbers, see Protocol
Numbers.
Integer fromPort
-1
indicates all ICMP types.Integer toPort
-1
indicates all ICMP codes for the specified
ICMP type.com.amazonaws.internal.ListWithAutoConstructFlag<T> userIdGroupPairs
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipRanges
String keyName
String keyFingerprint
com.amazonaws.internal.ListWithAutoConstructFlag<T> add
com.amazonaws.internal.ListWithAutoConstructFlag<T> remove
String imageId
String keyName
com.amazonaws.internal.ListWithAutoConstructFlag<T> allSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
String userData
String addressingType
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, t2.micro, t2.small, t2.medium, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge
SpotPlacement placement
String kernelId
String ramdiskId
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
Boolean monitoringEnabled
Default: Disabled
String subnetId
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfileSpecification iamInstanceProfile
Boolean ebsOptimized
Default:
false
String imageId
String attribute
String operationType
com.amazonaws.internal.ListWithAutoConstructFlag<T> userIds
launchPermission
attribute.com.amazonaws.internal.ListWithAutoConstructFlag<T> userGroups
launchPermission
attribute.com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
productCodes
attribute.String value
description
attribute.LaunchPermissionModifications launchPermission
String description
String instanceId
String attribute
Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport
String value
kernel
,
ramdisk
, userData
,
disableApiTermination
, or
intanceInitiateShutdownBehavior
attribute.com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
DeleteOnTermination
attribute for volumes
that are currently attached. The volume must be owned by the caller.
If no value is specified for DeleteOnTermination
, the
default is true
and the volume is deleted when the
instance is terminated. To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.
Boolean sourceDestCheck
true
means that checking is enabled, and
false
means checking is disabled. This value must be
false
for a NAT instance to perform NAT.Boolean disableApiTermination
String instanceType
InvalidInstanceAttributeValue
.String kernel
String ramdisk
String userData
String instanceInitiatedShutdownBehavior
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
For example, if you want the instance
to be in sg-1a1a1a1a and sg-9b9b9b9b, specify
GroupId.1=sg-1a1a1a1a
and
GroupId.2=sg-9b9b9b9b
.
Boolean ebsOptimized
String sriovNetSupport
simple
to enable enhanced networking for the
instance. There is no way to disable enhanced networking at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
String networkInterfaceId
String description
Boolean sourceDestCheck
true
means checking is enabled, and false
means checking is disabled. This value must be false
for
a NAT instance to perform NAT. For more information, see NAT
Instances in the Amazon Virtual Private Cloud User Guide.com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
NetworkInterfaceAttachmentChanges attachment
String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> targetConfigurations
String reservedInstancesModificationId
String snapshotId
String attribute
Constraints:
Allowed Values: productCodes, createVolumePermission
String operationType
com.amazonaws.internal.ListWithAutoConstructFlag<T> userIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
CreateVolumePermissionModifications createVolumePermission
String vpcId
Boolean enableDnsSupport
false
, the Amazon provided DNS service in
the VPC that resolves public DNS hostnames to IP addresses is not
enabled. If this attribute is true
, queries to the Amazon
provided DNS server at the 169.254.169.253 IP address, or the reserved
IP address at the base of the VPC network range "plus two" will
succeed.Boolean enableDnsHostnames
true
, instances in the VPC get DNS
hostnames; otherwise, they do not. You can only set
enableDnsHostnames
to true
if you also set
the EnableDnsSupport
attribute to true
.
String state
Constraints:
Allowed Values: disabled, enabled, pending
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceMonitorings
String networkAclId
String vpcId
Boolean isDefault
com.amazonaws.internal.ListWithAutoConstructFlag<T> entries
com.amazonaws.internal.ListWithAutoConstructFlag<T> associations
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Integer ruleNumber
String protocol
-1
means all protocols.String ruleAction
Constraints:
Allowed Values: allow, deny
Boolean egress
String cidrBlock
IcmpTypeCode icmpTypeCode
PortRange portRange
String networkInterfaceId
String subnetId
String vpcId
String availabilityZone
String description
String ownerId
String requesterId
Boolean requesterManaged
String status
Constraints:
Allowed Values: available, attaching, in-use, detaching
String macAddress
String privateIpAddress
String privateDnsName
Boolean sourceDestCheck
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
NetworkInterfaceAttachment attachment
NetworkInterfaceAssociation association
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagSet
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
String publicIp
String publicDnsName
String ipOwnerId
String allocationId
String associationId
String attachmentId
String instanceId
String instanceOwnerId
Integer deviceIndex
String status
Constraints:
Allowed Values: attaching, attached, detaching, detached
Date attachTime
Boolean deleteOnTermination
String privateIpAddress
String privateDnsName
Boolean primary
NetworkInterfaceAssociation association
String availabilityZone
String groupName
String tenancy
dedicated
runs on
single-tenant hardware.
Constraints:
Allowed Values: default, dedicated
Long term
Double price
String currencyCode
USD
.
Constraints:
Allowed Values: USD
Boolean active
A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.
Long term
Double price
String currencyCode
USD
.
Constraints:
Allowed Values: USD
String gatewayId
String reservedInstancesOfferingId
Integer instanceCount
ReservedInstanceLimitPrice limitPrice
String reservedInstancesId
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
String imageLocation
String name
Constraints: 3-128 alphanumeric characters, parenthesis (()), commas (,), slashes (/), dashes (-), or underscores (_)
String description
String architecture
Default: For Amazon EBS-backed AMIs,
i386
. For instance store-backed AMIs, the architecture
specified in the manifest file.
Constraints:
Allowed Values: i386, x86_64
String kernelId
String ramdiskId
String rootDeviceName
/dev/sda1
, or
xvda
).com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
String virtualizationType
Default: paravirtual
String sriovNetSupport
simple
to enable enhanced networking for the AMI
and any instances that you launch from the AMI. There is no way to disable enhanced networking at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
String imageId
String vpcPeeringConnectionId
Boolean returnValue
true
if the request succeeds; otherwise, it
returns an error.String newAssociationId
String networkAclId
Integer ruleNumber
String protocol
all
or -1
to mean all protocols.String ruleAction
Constraints:
Allowed Values: allow, deny
Boolean egress
Default: If no value is specified, we replace the ingress rule.
String cidrBlock
IcmpTypeCode icmpTypeCode
PortRange portRange
String routeTableId
String destinationCidrBlock
String gatewayId
String instanceId
String networkInterfaceId
String vpcPeeringConnectionId
String newAssociationId
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
String status
Constraints:
Allowed Values: ok, impaired
Date startTime
Date endTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> reasonCodes
instance-stuck-in-state
: My
instance is stuck in a state.
unresponsive
:
My instance is unresponsive.
not-accepting-credentials
: My instance is not
accepting my credentials.
password-not-available
: A password is not
available for my instance.
performance-network
: My instance is experiencing
performance problems which I believe are network related.
performance-instance-store
: My instance is
experiencing performance problems which I believe are related to the
instance stores.
performance-ebs-volume
: My
instance is experiencing performance problems which I believe are
related to an EBS volume.
performance-other
:
My instance is experiencing performance problems.
other
: [explain using the description
parameter]
String description
String spotPrice
Integer instanceCount
Default: 1
String type
Default: one-time
Constraints:
Allowed Values: one-time, persistent
Date validFrom
Default: The request is effective indefinitely.
Date validUntil
Default: The request is effective indefinitely.
String launchGroup
Default: Instances are launched and terminated individually
String availabilityZoneGroup
When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
Default: Instances are launched in any available Availability Zone.
LaunchSpecification launchSpecification
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotInstanceRequests
String reservationId
String ownerId
String requesterId
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
Double amount
String currencyCode
limitPrice
amount is specified.
At this time, the only supported currency is USD
.
Constraints:
Allowed Values: USD
String reservedInstancesId
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, t2.micro, t2.small, t2.medium, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge
String availabilityZone
Date start
Date end
Long duration
Float usagePrice
Float fixedPrice
Integer instanceCount
String productDescription
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
String state
Constraints:
Allowed Values: payment-pending, active, payment-failed, retired
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String instanceTenancy
Constraints:
Allowed Values: default, dedicated
String currencyCode
USD
.
Constraints:
Allowed Values: USD
String offeringType
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String availabilityZone
String platform
Integer instanceCount
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, t2.micro, t2.small, t2.medium, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge
String reservedInstancesId
String reservedInstancesListingId
String reservedInstancesId
Date createDate
Date updateDate
String status
Constraints:
Allowed Values: active, pending, cancelled, closed
String statusMessage
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceCounts
com.amazonaws.internal.ListWithAutoConstructFlag<T> priceSchedules
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String clientToken
String reservedInstancesModificationId
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> modificationResults
Date createDate
Date updateDate
Date effectiveDate
String status
String statusMessage
String clientToken
String reservedInstancesId
ReservedInstancesConfiguration targetConfiguration
String reservedInstancesOfferingId
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, t2.micro, t2.small, t2.medium, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge
String availabilityZone
Long duration
Float usagePrice
Float fixedPrice
String productDescription
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
String instanceTenancy
Constraints:
Allowed Values: default, dedicated
String currencyCode
USD
.
Constraints:
Allowed Values: USD
String offeringType
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
Boolean marketplace
true
.com.amazonaws.internal.ListWithAutoConstructFlag<T> pricingDetails
String instanceId
String attribute
Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport
String networkInterfaceId
String sourceDestCheck
true
means checking is enabled, and false
means checking is disabled. This value must be false
for
a NAT instance to perform NAT.String groupId
String sourceSecurityGroupName
String sourceSecurityGroupOwnerId
String ipProtocol
Integer fromPort
-1
to specify all
ICMP types.Integer toPort
-1
to specify all
ICMP codes for the ICMP type.String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
String groupName
String groupId
String sourceSecurityGroupName
String sourceSecurityGroupOwnerId
String ipProtocol
Integer fromPort
-1
to specify all
ICMP types.Integer toPort
-1
to specify all
ICMP codes for the ICMP type.String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
String destinationCidrBlock
String gatewayId
String instanceId
String instanceOwnerId
String networkInterfaceId
String vpcPeeringConnectionId
String state
blackhole
state indicates
that the route's target isn't available (for example, the specified
gateway isn't attached to the VPC, or the specified NAT instance has
been terminated).
Constraints:
Allowed Values: active, blackhole
String origin
CreateRouteTable
indicates that route was
automatically created when the route table was created.CreateRoute
indicates that the route was manually
added to the route table.EnableVgwRoutePropagation
indicates that the route
was propagated by route propagation.
Constraints:
Allowed Values: CreateRouteTable, CreateRoute, EnableVgwRoutePropagation
String routeTableId
String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> routes
com.amazonaws.internal.ListWithAutoConstructFlag<T> associations
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> propagatingVgws
String imageId
Integer minCount
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
Integer maxCount
MinCount
. Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
String keyName
If you launch an instance without specifying a key pair, you can't connect to the instance.
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
Default: Amazon EC2 uses the default security group.
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
Default: Amazon EC2 uses the default security group.
String userData
String instanceType
Default: m1.small
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, t2.micro, t2.small, t2.medium, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge
Placement placement
String kernelId
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB: A New Amazon Kernel Image in the Amazon Elastic Compute Cloud User Guide.
String ramdiskId
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
Boolean monitoring
String subnetId
Boolean disableApiTermination
true
, you can't terminate
the instance using the Amazon EC2 console, CLI, or API; otherwise, you
can. If you set this parameter to true
and then later
want to be able to terminate the instance, you must first change the
value of the disableApiTermination
attribute to
false
using ModifyInstanceAttribute.
Alternatively, if you set
InstanceInitiatedShutdownBehavior
to
terminate
, you can terminate the instance by running the
shutdown command from the instance. Default: false
String instanceInitiatedShutdownBehavior
Default: stop
Constraints:
Allowed Values: stop, terminate
String privateIpAddress
Only one private IP address can be
designated as primary. Therefore, you can't specify this parameter if
PrivateIpAddresses.n.Primary
is set to true
and PrivateIpAddresses.n.PrivateIpAddress
is set to an IP
address.
Default: We select an IP address from the IP address range of the subnet.
String clientToken
Constraints: Maximum 64 ASCII characters
String additionalInfo
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfileSpecification iamInstanceProfile
Boolean ebsOptimized
Default: false
Reservation reservation
String bucket
String prefix
String aWSAccessKeyId
String uploadPolicy
String uploadPolicySignature
String ownerId
String groupName
String groupId
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissionsEgress
String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String snapshotId
String volumeId
String state
Constraints:
Allowed Values: pending, completed, error
Date startTime
String progress
String ownerId
String description
Integer volumeSize
String ownerAlias
amazon
,
self
) or AWS account ID that owns the snapshot.com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Boolean encrypted
String ownerId
String bucket
String prefix
String state
Constraints:
Allowed Values: Active, Inactive
SpotInstanceStateFault fault
String spotInstanceRequestId
String spotPrice
String type
Constraints:
Allowed Values: one-time, persistent
String state
Constraints:
Allowed Values: open, active, closed, cancelled, failed
SpotInstanceStateFault fault
SpotInstanceStatus status
Date validFrom
Date validUntil
String launchGroup
String availabilityZoneGroup
LaunchSpecification launchSpecification
String instanceId
Date createTime
String productDescription
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String launchedAvailabilityZone
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, t2.micro, t2.small, t2.medium, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge
String productDescription
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
String spotPrice
Date timestamp
String availabilityZone
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
String additionalInfo
com.amazonaws.internal.ListWithAutoConstructFlag<T> startingInstances
String code
String message
Server.SpotInstanceTermination
: A Spot Instance
was terminated due to an increase in the market price.
Server.InternalError
: An internal error occurred
during instance launch, resulting in termination.
Server.InsufficientInstanceCapacity
: There was
insufficient instance capacity to satisfy the launch request.
Client.InternalError
: A client error caused the
instance to terminate on launch.
Client.InstanceInitiatedShutdown
: The instance was
shut down using the shutdown -h
command from the
instance.
Client.UserInitiatedShutdown
: The
instance was shut down using the Amazon EC2 API.
Client.VolumeLimitExceeded
: The volume limit was
exceeded.
Client.InvalidSnapshot.NotFound
:
The specified snapshot was not found.
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
Boolean force
Default:
false
com.amazonaws.internal.ListWithAutoConstructFlag<T> stoppingInstances
S3Storage s3
String subnetId
String state
Constraints:
Allowed Values: pending, available
String vpcId
String cidrBlock
Integer availableIpAddressCount
String availabilityZone
Boolean defaultForAz
Boolean mapPublicIpOnLaunch
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String resourceId
ami-1a2b3c4d
.String resourceType
Constraints:
Allowed Values: customer-gateway, dhcp-options, image, instance, internet-gateway, network-acl, network-interface, reserved-instances, route-table, snapshot, spot-instances-request, subnet, security-group, volume, vpc, vpn-connection, vpn-gateway
String key
String value
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> terminatingInstances
String networkInterfaceId
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceMonitorings
String outsideIpAddress
String status
Constraints:
Allowed Values: UP, DOWN
Date lastStatusChange
String statusMessage
Integer acceptedRouteCount
String volumeId
Integer size
String snapshotId
String availabilityZone
String state
Constraints:
Allowed Values: creating, available, in-use, deleting, deleted, error
Date createTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> attachments
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String volumeType
gp2
for General Purpose
(SSD) volumes, io1
for Provisioned IOPS (SSD) volumes, or
standard
for Magnetic volumes.
Constraints:
Allowed Values: standard, io1, gp2
Integer iops
Constraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes.
Condition: This parameter is required for requests to create
io1
volumes; it is not used in requests to create
standard
or gp2
volumes.
Boolean encrypted
String volumeId
String instanceId
String device
String state
Constraints:
Allowed Values: attaching, attached, detaching, detached
Date attachTime
Boolean deleteOnTermination
Long size
String status
Constraints:
Allowed Values: ok, impaired, insufficient-data
com.amazonaws.internal.ListWithAutoConstructFlag<T> details
String volumeId
String availabilityZone
VolumeStatusInfo volumeStatus
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
com.amazonaws.internal.ListWithAutoConstructFlag<T> actions
String vpcId
String state
Constraints:
Allowed Values: pending, available
String cidrBlock
String dhcpOptionsId
default
if the default options are associated with the
VPC).com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String instanceTenancy
Constraints:
Allowed Values: default, dedicated
Boolean isDefault
VpcPeeringConnectionVpcInfo accepterVpcInfo
Date expirationTime
VpcPeeringConnectionVpcInfo requesterVpcInfo
VpcPeeringConnectionStateReason status
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String vpcPeeringConnectionId
String vpnConnectionId
String state
Constraints:
Allowed Values: pending, available, deleting, deleted
String customerGatewayConfiguration
pending
or available
state.String type
Constraints:
Allowed Values: ipsec.1
String customerGatewayId
String vpnGatewayId
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> vgwTelemetry
VpnConnectionOptions options
com.amazonaws.internal.ListWithAutoConstructFlag<T> routes
Boolean staticRoutesOnly
Boolean staticRoutesOnly
String vpnGatewayId
String state
Constraints:
Allowed Values: pending, available, deleting, deleted
String type
Constraints:
Allowed Values: ipsec.1
String availabilityZone
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcAttachments
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String destinationCidrBlock
String source
Constraints:
Allowed Values: Static
String state
Constraints:
Allowed Values: pending, available, deleting, deleted
String cacheSecurityGroupName
String eC2SecurityGroupName
String eC2SecurityGroupOwnerId
String name
String cacheClusterId
Endpoint configurationEndpoint
String clientDownloadLandingPage
String cacheNodeType
String engine
String engineVersion
String cacheClusterStatus
Integer numCacheNodes
String preferredAvailabilityZone
Date cacheClusterCreateTime
String preferredMaintenanceWindow
PendingModifiedValues pendingModifiedValues
NotificationConfiguration notificationConfiguration
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroups
CacheParameterGroupStatus cacheParameterGroup
String cacheSubnetGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodes
Boolean autoMinorVersionUpgrade
true
, then minor version patches are applied
automatically; if false
, then automatic minor version
patches are disabled.com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
String replicationGroupId
Integer snapshotRetentionLimit
Important
If the value of SnapshotRetentionLimit is set
to zero (0), backups are turned off.
String snapshotWindow
Example:
05:00-09:00
String engine
String engineVersion
String cacheParameterGroupFamily
String cacheEngineDescription
String cacheEngineVersionDescription
String cacheNodeId
String cacheNodeStatus
Date cacheNodeCreateTime
Endpoint endpoint
String parameterGroupStatus
String sourceCacheNodeId
String customerAvailabilityZone
String parameterName
String description
String source
String dataType
String allowedValues
Boolean isModifiable
true
) or not (false
) the
parameter can be modified. Some parameters have security or
operational implications that prevent them from being changed.String minimumEngineVersion
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeTypeSpecificValues
String cacheParameterGroupName
String cacheParameterGroupFamily
String description
String cacheParameterGroupName
String parameterApplyStatus
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeIdsToReboot
String ownerId
String cacheSecurityGroupName
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> eC2SecurityGroups
String cacheSubnetGroupName
String cacheSubnetGroupDescription
String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
String cacheClusterId
Constraints:
String replicationGroupId
Integer numCacheNodes
For a Memcached cluster, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at .
For Redis, only single-node cache clusters are supported at this time, so the value for this parameter must be 1.
String cacheNodeType
Valid cache types
cache.t1.micro |
cache.m1.small
cache.m3.medium | cache.m3.large | cache.m3.xlarge
| cache.m3.2xlarge
cache.m1.medium | cache.m1.large |
cache.m1.xlarge
cache.c1.xlarge
cache.r3.large | cache.r3.xlarge |
cache.r3.2xlarge | cache.r3.4xlarge | cache.r3.8xlarge
cache.m2.xlarge | cache.m2.2xlarge |
cache.m2.4xlarge
For a complete listing of cache node types and specifications, see Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis and Amazon ElastiCache Product Features and Details.
String engine
Valid values for this parameter are:
memcached
|
redis
String engineVersion
String cacheParameterGroupName
String cacheSubnetGroupName
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroupNames
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotArns
Here is an example of an Amazon S3 ARN:
arn:aws:s3:::my_bucket/snapshot1.rdb
Note: This
parameter is only valid if the Engine
parameter is
redis
.
String snapshotName
restoring
while
the new cache cluster is being created.String aZMode
This option is only supported for Memcached
cache clusters. AZMode
and
PreferredAvailabilityZones
are not specified, ElastiCache
assumes single-az
mode.
Valid values:
single-az
| cross-az
.
String preferredAvailabilityZone
All cache nodes belonging to this Memcached cache cluster are
placed in the preferred Availability Zone. If you want to create your
cache nodes across multiple Availability Zones, use
PreferredAvailabilityZones
.
Default: System chosen Availability Zone.
com.amazonaws.internal.ListWithAutoConstructFlag<T> preferredAvailabilityZones
This option is
only supported on Memcached clusters. If you are creating
your cache cluster in an Amazon VPC (recommended) you can only locate
nodes in Availability Zones that are associated with the subnets in
the selected subnet group. The number of Availability Zones listed
must equal the value of NumCacheNodes
.
If you
want all your cache nodes in the same Availability Zone, use
PreferredAvailabilityZone
instead or repeat the
Availability Zone multiple times in the list.
Default: System chosen Availability Zones.
Example: One Memcached node in each of
three Availability Zones:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1b&PreferredAvailabilityZones.member.3=us-east-1d
Example: All three Memcached nodes in one Availability Zone:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1a&PreferredAvailabilityZones.member.3=us-east-1a
String preferredMaintenanceWindow
Example: sun:05:00-sun:09:00
Integer port
String notificationTopicArn
Boolean autoMinorVersionUpgrade
true
allows these upgrades to occur; false
disables automatic upgrades. Default: true
Integer snapshotRetentionLimit
SnapshotRetentionLimit
to 5, then a snapshot that was
taken today will be retained for 5 days before being deleted. If
you do not specify this parameter, then
SnapshotRetentionLimit
will be set to 0 (i.e., automatic
backups will be disabled for this cache cluster).
String snapshotWindow
Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
String cacheParameterGroupName
String cacheParameterGroupFamily
Valid values are: memcached1.4
|
redis2.6
| redis2.8
String description
String cacheSecurityGroupName
Constraints: Must contain no more than 255 alphanumeric characters. Must not be the word "Default".
Example:
mysecuritygroup
String description
String cacheSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example: mysubnetgroup
String cacheSubnetGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
String replicationGroupId
Constraints:
String primaryClusterId
String replicationGroupDescription
String cacheClusterId
String finalSnapshotIdentifier
String cacheParameterGroupName
String cacheSecurityGroupName
String cacheSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
String replicationGroupId
Boolean retainPrimaryCluster
String finalSnapshotIdentifier
String snapshotName
String cacheClusterId
Integer maxRecords
MaxRecords
value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
Boolean showCacheNodeInfo
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheClusters
String engine
memcached
|
redis
String engineVersion
Example: 1.4.14
String cacheParameterGroupFamily
Constraints:
Integer maxRecords
MaxRecords
value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
Boolean defaultOnly
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheEngineVersions
String cacheParameterGroupName
Integer maxRecords
MaxRecords
value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheParameterGroups
String cacheParameterGroupName
String source
Valid values: user
|
system
| engine-default
Integer maxRecords
MaxRecords
value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeTypeSpecificParameters
String cacheSecurityGroupName
Integer maxRecords
MaxRecords
value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroups
String cacheSubnetGroupName
Integer maxRecords
MaxRecords
value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSubnetGroups
String cacheParameterGroupFamily
memcached1.4
| redis2.6
|
redis2.8
Integer maxRecords
MaxRecords
value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String sourceIdentifier
String sourceType
Valid values are: cache-cluster
|
cache-parameter-group
| cache-security-group
| cache-subnet-group
Constraints:
Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
Date startTime
Date endTime
Integer duration
Integer maxRecords
MaxRecords
value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String replicationGroupId
If you do not specify this parameter, information about all replication groups is returned.
Integer maxRecords
MaxRecords
value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> replicationGroups
String reservedCacheNodesOfferingId
Example:
438012d3-4052-4cc7-b2e3-8d3372e0e706
String cacheNodeType
String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
String productDescription
String offeringType
Valid
Values: "Light Utilization" | "Medium Utilization" | "Heavy
Utilization"
Integer maxRecords
MaxRecords
value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedCacheNodesOfferings
String reservedCacheNodeId
String reservedCacheNodesOfferingId
String cacheNodeType
String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
String productDescription
String offeringType
Valid
values: "Light Utilization" | "Medium Utilization" | "Heavy
Utilization"
Integer maxRecords
MaxRecords
value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedCacheNodes
String cacheClusterId
String snapshotName
String snapshotSource
system
, the output shows snapshots that were
automatically created by ElastiCache. If set to user
the
output shows snapshots that were manually created. If omitted, the
output shows both automatically and manually created snapshots.String marker
Integer maxRecords
MaxRecords
value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 50
Constraints: minimum 20; maximum 50.
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshots
String cacheParameterGroupFamily
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeTypeSpecificParameters
String sourceIdentifier
String sourceType
Constraints:
Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
String message
Date date
String cacheClusterId
Integer numCacheNodes
NumCacheNodes
is greater than the sum of the
number of current cache nodes and the number of cache nodes pending
creation (which may be zero), then more nodes will be added. If the
value is less than the number of existing cache nodes, then nodes will
be removed. If the value is equal to the number of current cache
nodes, then any pending add or remove requests are canceled. If you
are removing cache nodes, you must use the
CacheNodeIdsToRemove
parameter to provide the IDs of the
specific cache nodes to remove.
For cache clusters running Redis,
the value of NumCacheNodes
must be 1.
Note:
Adding or removing Memcached cache nodes can be
applied immediately or as a pending action. See
ApplyImmediately
.
A pending action to modify the
number of cache nodes in a cluster during its maintenance window,
whether by adding or removing nodes in accordance with the scale out
architecture, is not queued. The customer's latest request to add or
remove nodes to the cluster overrides any previous pending actions to
modify the number of cache nodes in the cluster. For example, a
request to remove 2 nodes would override a previous pending action to
remove 3 nodes. Similarly, a request to add 2 nodes would override a
previous pending action to remove 3 nodes and vice versa. As Memcached
cache nodes may now be provisioned in different Availability Zones
with flexible cache node placement, a request to add nodes does not
automatically override a previous pending action to add nodes. The
customer can modify the previous pending action to add more nodes or
explicitly cancel the pending request and retry the new request. To
cancel pending actions to modify the number of cache nodes in a
cluster, use the ModifyCacheCluster
request and set
NumCacheNodes
equal to the number of cache nodes
currently in the cache cluster.
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeIdsToRemove
For example: If you have 3
active cache nodes, 7 pending cache nodes, and the number of cache
nodes in this ModifyCacheCluser
call is 5, you must list
2 (7 - 5) cache node IDs to remove.
com.amazonaws.internal.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".
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).
String preferredMaintenanceWindow
String notificationTopicArn
String cacheParameterGroupName
String notificationTopicStatus
Valid values:
active
| inactive
Boolean applyImmediately
true
, this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the cache cluster. If
false
, then changes to the cache cluster are applied on
the next maintenance reboot, or the next failure reboot, whichever
occurs first. ModifyCacheCluster
before a pending modification is
applied, the pending modification is replaced by the newer
modification.
Valid values: true
|
false
Default: false
String engineVersion
Boolean autoMinorVersionUpgrade
true
, then minor engine upgrades will be applied
automatically to the cache cluster during the maintenance window.
Valid values: true
| false
Default:
true
Integer snapshotRetentionLimit
Important
If the value of SnapshotRetentionLimit is set
to zero (0), backups are turned off.
String snapshotWindow
String aZMode
Valid values: single-az
|
cross-az
.
This option is only supported for Memcached
cache clusters. You cannot specify Only
newly created nodes will be located in different Availability Zones.
For instructions on how to move existing Memcached nodes to different
Availability Zones, see the Availability Zone Considerations
section of Cache
Node Considerations for Memcached. single-az
if
the Memcached cache cluster already has cache nodes in different
Availability Zones. If cross-az
is specified, existing
Memcached nodes remain in their current Availability Zone.
com.amazonaws.internal.ListWithAutoConstructFlag<T> newAvailabilityZones
This parameter is only valid when
NumCacheNodes
in the request is greater than the sum of
the number of active cache nodes and the number of cache nodes pending
creation (which may be zero). The number of Availability Zones
supplied in this list must match the cache nodes being added in this
request.
This option is only supported on Memcached clusters.
Scenarios:
NumCacheNodes=5
(3 + 2)
and opitonally specify two Availability Zones for the two new
nodes.NumCacheNodes=6
((3 + 2) + 1)NumCacheNodes=3
(the original number of nodes). The Availability Zone placement
of nodes pending creation cannot be modified. If you wish to cancel
any nodes pending creation, add 0 nodes by setting
NumCacheNodes
to the number of current nodes.
If
cross-az
is specified, existing Memcached nodes remain in
their current Availability Zone. Only newly created nodes can be
located in different Availability Zones. For guidance on how to move
existing Memcached nodes to different Availability Zones, see the
Availability Zone Considerations section of Cache
Node Considerations for Memcached.
Example:
NewAvailabilityZones.member.1=us-east-1a&NewAvailabilityZones.member.2=us-east-1b&NewAvailabilityZones.member.3=us-east-1d
String cacheParameterGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterNameValues
String cacheParameterGroupName
String cacheSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example:
mysubnetgroup
String cacheSubnetGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
String replicationGroupId
String replicationGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroupNames
This parameter can be used only with replication groups containing cache clusters running outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
This parameter can be used only with replication groups containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
String preferredMaintenanceWindow
String notificationTopicArn
String cacheParameterGroupName
String notificationTopicStatus
Valid values: active
| inactive
Boolean applyImmediately
true
, this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the replication group.
If false
, then changes to the nodes in the replication
group are applied on the next maintenance reboot, or the next failure
reboot, whichever occurs first.
Valid values: true
|
false
Default: false
String engineVersion
Boolean autoMinorVersionUpgrade
true
allows these upgrades
to occur; false
disables automatic upgrades.String primaryClusterId
Integer snapshotRetentionLimit
Important
If the value of SnapshotRetentionLimit is set
to zero (0), backups are turned off.
String snapshotWindow
Example: 05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
String snapshottingClusterId
String nodeGroupId
String status
Endpoint primaryEndpoint
com.amazonaws.internal.ListWithAutoConstructFlag<T> nodeGroupMembers
String cacheClusterId
String cacheNodeId
Endpoint readEndpoint
String preferredAvailabilityZone
String currentRole
String cacheNodeId
String cacheSize
Date cacheNodeCreateTime
Date snapshotCreateTime
String parameterName
String parameterValue
String description
String source
String dataType
String allowedValues
Boolean isModifiable
true
) or not (false
) the
parameter can be modified. Some parameters have security or
operational implications that prevent them from being changed.String minimumEngineVersion
Integer numCacheNodes
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeIdsToRemove
String engineVersion
String reservedCacheNodesOfferingId
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
String reservedCacheNodeId
Example: myreservationID
Integer cacheNodeCount
Default:
1
String cacheClusterId
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeIdsToReboot
String replicationGroupId
String description
String status
ReplicationGroupPendingModifiedValues pendingModifiedValues
com.amazonaws.internal.ListWithAutoConstructFlag<T> memberClusters
com.amazonaws.internal.ListWithAutoConstructFlag<T> nodeGroups
String snapshottingClusterId
String primaryClusterId
--apply-immediately
was specified), or during the next
maintenance window.String reservedCacheNodeId
String reservedCacheNodesOfferingId
String cacheNodeType
Date startTime
Integer duration
Double fixedPrice
Double usagePrice
Integer cacheNodeCount
String productDescription
String offeringType
String state
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String reservedCacheNodesOfferingId
String cacheNodeType
Integer duration
Double fixedPrice
Double usagePrice
String productDescription
String offeringType
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String cacheParameterGroupName
Boolean resetAllParameters
Valid values: true
| false
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterNameValues
String cacheParameterGroupName
String cacheSecurityGroupName
String eC2SecurityGroupName
String eC2SecurityGroupOwnerId
String snapshotName
String cacheClusterId
String snapshotStatus
creating
|
available
| restoring
| copying
| deleting
.String snapshotSource
automated
) or was created manually
(manual
).String cacheNodeType
String engine
String engineVersion
Integer numCacheNodes
String preferredAvailabilityZone
Date cacheClusterCreateTime
String preferredMaintenanceWindow
String topicArn
Integer port
String cacheParameterGroupName
String cacheSubnetGroupName
String vpcId
Boolean autoMinorVersionUpgrade
true
) or not
(false
).Integer snapshotRetentionLimit
For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot action.
Important
If the value
of SnapshotRetentionLimit is set to zero (0), backups are turned off.
String snapshotWindow
com.amazonaws.internal.ListWithAutoConstructFlag<T> nodeSnapshots
String subnetIdentifier
AvailabilityZone subnetAvailabilityZone
String applicationName
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
Date dateCreated
Date dateUpdated
com.amazonaws.internal.ListWithAutoConstructFlag<T> versions
com.amazonaws.internal.ListWithAutoConstructFlag<T> configurationTemplates
String applicationName
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
String versionLabel
Constraints:
Length: 1 - 100
S3Location sourceBundle
Date dateCreated
Date dateUpdated
String name
AutoScalingGroup
.String cNAMEPrefix
Constraints:
Length: 4 - 63
Boolean available
true
: The CNAME is available.
true
: The CNAME is not
available.
true
:
The CNAME is available. false
: The CNAME is
not available. String fullyQualifiedCNAME
Constraints:
Length: 1 - 255
String namespace
String name
String defaultValue
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.
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
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> valueOptions
Integer minValue
Integer maxValue
Integer maxLength
OptionRestrictionRegex regex
String solutionStackName
Constraints:
Length: 0 - 100
String applicationName
Constraints:
Length: 1 - 100
String templateName
null
, the name of the configuration template for
this configuration set.
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
String environmentName
null
, the name of the environment for this
configuration set.
Constraints:
Length: 4 - 23
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
Date dateCreated
Date dateUpdated
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
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
String description
Constraints:
Length: 0 - 200
ApplicationDescription application
String applicationName
AutoCreateApplication
is false
,
returns an InvalidParameterValue
error.
Constraints:
Length: 1 - 100
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
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. The maximum size
allowed is 512 MB.
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.
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
String applicationName
InvalidParameterValue
error.
Constraints:
Length: 1 - 100
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
String solutionStackName
Use ListAvailableSolutionStacks to obtain a list of available solution stacks.
A solution stack name or a source
configuration parameter must be specified, otherwise AWS Elastic
Beanstalk returns an InvalidParameterValue
error.
If a solution stack name is 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.
String environmentId
String description
Constraints:
Length: 0 - 200
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
String solutionStackName
Constraints:
Length: 0 - 100
String applicationName
Constraints:
Length: 1 - 100
String templateName
null
, the name of the configuration template for
this configuration set.
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
String environmentName
null
, the name of the environment for this
configuration set.
Constraints:
Length: 4 - 23
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
Date dateCreated
Date dateUpdated
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
String applicationName
If no application is found with this name,
CreateEnvironment
returns an
InvalidParameterValue
error.
Constraints:
Length: 1 - 100
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
String description
Constraints:
Length: 0 - 200
String cNAMEPrefix
Constraints:
Length: 4 - 63
EnvironmentTier tier
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
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 sample application in the container.
Constraints:
Length: 1 - 100
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
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsToRemove
String environmentName
Constraints:
Length: 4 - 23
String environmentId
String applicationName
Constraints:
Length: 1 - 100
String versionLabel
Constraints:
Length: 1 - 100
String solutionStackName
SolutionStack
deployed with this
environment.
Constraints:
Length: 0 - 100
String templateName
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
String endpointURL
String cNAME
Constraints:
Length: 1 - 255
Date dateCreated
Date dateUpdated
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
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
EnvironmentTier tier
String s3Bucket
Constraints:
Length: 0 - 255
String applicationName
Constraints:
Length: 1 - 100
String versionLabel
Constraints:
Length: 1 - 100
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> applicationNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> applications
String applicationName
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> versionLabels
com.amazonaws.internal.ListWithAutoConstructFlag<T> applicationVersions
String applicationName
Constraints:
Length: 1 - 100
String templateName
Constraints:
Length: 1 - 100
String environmentName
Constraints:
Length: 4 - 23
String solutionStackName
Constraints:
Length: 0 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> options
String solutionStackName
Constraints:
Length: 0 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> options
String applicationName
Constraints:
Length: 1 - 100
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
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> configurationSettings
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.
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
String applicationName
Constraints:
Length: 1 - 100
String versionLabel
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> environmentIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> environmentNames
Boolean includeDeleted
true
: Environments that have been deleted after
IncludedDeletedBackTo
are displayed.
false
: Do not include deleted environments.
Date includedDeletedBackTo
IncludeDeleted
is set to
true
, then environments deleted after this date are
displayed.com.amazonaws.internal.ListWithAutoConstructFlag<T> environments
String applicationName
Constraints:
Length: 1 - 100
String versionLabel
Constraints:
Length: 1 - 100
String templateName
Constraints:
Length: 1 - 100
String environmentId
String environmentName
Constraints:
Length: 4 - 23
String requestId
String severity
Constraints:
Allowed Values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL
Date startTime
Date endTime
EndTime
.Integer maxRecords
Constraints:
Range: 1 - 1000
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String nextToken
String environmentName
Constraints:
Length: 4 - 23
String environmentId
String applicationName
Constraints:
Length: 1 - 100
String versionLabel
Constraints:
Length: 1 - 100
String solutionStackName
SolutionStack
deployed with this
environment.
Constraints:
Length: 0 - 100
String templateName
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
String endpointURL
String cNAME
Constraints:
Length: 1 - 255
Date dateCreated
Date dateUpdated
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
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
EnvironmentTier tier
String infoType
Constraints:
Allowed Values: tail
String ec2InstanceId
Date sampleTimestamp
String message
String environmentName
Constraints:
Length: 4 - 23
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingGroups
AutoScalingGroups
used by this environment.com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
com.amazonaws.internal.ListWithAutoConstructFlag<T> launchConfigurations
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancers
com.amazonaws.internal.ListWithAutoConstructFlag<T> triggers
AutoScaling
triggers in use by this environment.com.amazonaws.internal.ListWithAutoConstructFlag<T> queues
LoadBalancerDescription loadBalancer
Date eventDate
String message
String applicationName
Constraints:
Length: 1 - 100
String versionLabel
Constraints:
Length: 1 - 100
String templateName
Constraints:
Length: 1 - 100
String environmentName
Constraints:
Length: 4 - 23
String requestId
String severity
Constraints:
Allowed Values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL
String id
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> solutionStacks
com.amazonaws.internal.ListWithAutoConstructFlag<T> solutionStackDetails
String name
String loadBalancerName
String domain
com.amazonaws.internal.ListWithAutoConstructFlag<T> listeners
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.
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
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.
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
String infoType
Constraints:
Allowed Values: tail
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.
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
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.
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
String infoType
Constraints:
Allowed Values: tail
com.amazonaws.internal.ListWithAutoConstructFlag<T> environmentInfo
String solutionStackName
Constraints:
Length: 0 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> permittedFileTypes
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
.
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
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
.
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
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.
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
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
String environmentName
Constraints:
Length: 4 - 23
String environmentId
String applicationName
Constraints:
Length: 1 - 100
String versionLabel
Constraints:
Length: 1 - 100
String solutionStackName
SolutionStack
deployed with this
environment.
Constraints:
Length: 0 - 100
String templateName
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
String endpointURL
String cNAME
Constraints:
Length: 1 - 255
Date dateCreated
Date dateUpdated
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
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
EnvironmentTier tier
String name
String applicationName
UpdateApplication
returns an
InvalidParameterValue
error.
Constraints:
Length: 1 - 100
String description
Default: If not specified, AWS Elastic Beanstalk does not update the description.
Constraints:
Length: 0 - 200
ApplicationDescription application
String applicationName
If no
application is found with this name, UpdateApplication
returns an InvalidParameterValue
error.
Constraints:
Length: 1 - 100
String versionLabel
If no application version is
found with this label, UpdateApplication
returns an
InvalidParameterValue
error.
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
ApplicationVersionDescription applicationVersion
String applicationName
If no application is found with this name,
UpdateConfigurationTemplate
returns an
InvalidParameterValue
error.
Constraints:
Length: 1 - 100
String templateName
If no
configuration template is found with this name,
UpdateConfigurationTemplate
returns an
InvalidParameterValue
error.
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsToRemove
Constraint: You can remove only UserDefined
configuration options.
String solutionStackName
Constraints:
Length: 0 - 100
String applicationName
Constraints:
Length: 1 - 100
String templateName
null
, the name of the configuration template for
this configuration set.
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
String environmentName
null
, the name of the environment for this
configuration set.
Constraints:
Length: 4 - 23
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
Date dateCreated
Date dateUpdated
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
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.
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
String description
Constraints:
Length: 0 - 200
EnvironmentTier tier
Condition: You can only update the tier version for an environment. If
you change the name of the type, AWS Elastic Beanstalk returns
InvalidParameterValue
error.
String versionLabel
InvalidParameterValue
error.
Constraints:
Length: 1 - 100
String templateName
InvalidParameterValue
error.
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsToRemove
String environmentName
Constraints:
Length: 4 - 23
String environmentId
String applicationName
Constraints:
Length: 1 - 100
String versionLabel
Constraints:
Length: 1 - 100
String solutionStackName
SolutionStack
deployed with this
environment.
Constraints:
Length: 0 - 100
String templateName
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
String endpointURL
String cNAME
Constraints:
Length: 1 - 255
Date dateCreated
Date dateUpdated
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
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
EnvironmentTier tier
String applicationName
Constraints:
Length: 1 - 100
String templateName
Condition: You cannot specify both this and an environment name.
Constraints:
Length: 1 - 100
String environmentName
Condition: You cannot specify both this and a configuration template name.
Constraints:
Length: 4 - 23
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
com.amazonaws.internal.ListWithAutoConstructFlag<T> messages
String message
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
String namespace
String optionName
Boolean enabled
String s3BucketName
Integer emitInterval
Default: 60 minutes
String s3BucketPrefix
my-bucket-prefix/prod
. If the prefix is not
provided, the log is placed at the root level of the bucket.com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Constraints:
Length: 1 -
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
Integer instancePort
Constraints:
Range: 1 - 65535
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
String loadBalancerName
HealthCheck healthCheck
HealthCheck healthCheck
Integer idleTimeout
Constraints:
Range: 1 - 3600
String loadBalancerName
String policyName
Long cookieExpirationPeriod
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> listeners
LoadBalancerPort
, InstancePort
,
Protocol
, InstanceProtocol
, and
SSLCertificateId
items.String loadBalancerName
String policyName
String policyTypeName
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyAttributes
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> listeners
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
At least one Availability Zone must be specified. Specified Availability Zones must be in the same EC2 Region as the load balancer. Traffic will be equally distributed across all zones.
You can later add more Availability Zones after the creation of the load balancer by calling EnableAvailabilityZonesForLoadBalancer action.
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
String scheme
By default, Elastic Load Balancing creates an Internet-facing load balancer with a publicly resolvable DNS name, which resolves to public IP addresses. For more information about Internet-facing and Internal load balancers, see Internet-facing and Internal Load Balancers.
Specify the value
This option is only available for load balancers created within
EC2-VPC. internal
for this option to create an internal load
balancer with a DNS name that resolves to private IP addresses.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
For more information about setting tags for your load balancer, see Tagging.
Constraints:
Length: 1 -
String dNSName
Boolean enabled
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerPorts
String loadBalancerName
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceStates
String loadBalancerName
LoadBalancerAttributes loadBalancerAttributes
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyDescriptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyTypeNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyTypeDescriptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
String marker
Integer pageSize
Constraints:
Range: 1 - 400
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerDescriptions
String nextMarker
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
Constraints:
Length: 1 - 20
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagDescriptions
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
String target
TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case a healthcheck simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP or HTTPS protocol, the situation is different. You have to include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target needs to be 1024 16-bit Unicode characters or less.
Integer interval
Constraints:
Range: 1 - 300
Integer timeout
Constraints:
Range: 1 - 300
Integer unhealthyThreshold
Constraints:
Range: 2 - 10
Integer healthyThreshold
Constraints:
Range: 2 - 10
String instanceId
String instanceId
String state
Valid value:
InService
|OutOfService
|Unknown
String reasonCode
Valid value:
ELB
|Instance
|N/A
String description
String policyName
Long cookieExpirationPeriod
String protocol
Integer loadBalancerPort
String instanceProtocol
InstanceProtocol
has to be at the same
protocol layer, i.e., HTTP or HTTPS. Likewise, if the front-end
protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL. InstancePort
whose InstanceProtocol
is
secure, i.e., HTTPS or SSL, the listener's
InstanceProtocol
has to be secure, i.e., HTTPS or SSL. If
there is another listener with the same InstancePort
whose InstanceProtocol
is HTTP or TCP, the listener's
InstanceProtocol
must be either HTTP or TCP. Integer instancePort
Constraints:
Range: 1 - 65535
String sSLCertificateId
Listener listener
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
CrossZoneLoadBalancing crossZoneLoadBalancing
For more information, see Enable Cross-Zone Load Balancing.
AccessLog accessLog
For more information, see Enable Access Logs.
ConnectionDraining connectionDraining
For more information, see Enable Connection Draining.
ConnectionSettings connectionSettings
By default, Elastic Load
Balancing maintains a 60-second idle connection timeout for both
front-end and back-end connections of your load balancer. If the
ConnectionSettings
attribute is set, Elastic Load
Balancing will allow the connections to remain idle (no data is sent
over the connection) for the specified duration.
For more information, see Configure Idle Connection Timeout.
String loadBalancerName
String dNSName
String canonicalHostedZoneName
String canonicalHostedZoneNameID
com.amazonaws.internal.ListWithAutoConstructFlag<T> listenerDescriptions
Policies policies
com.amazonaws.internal.ListWithAutoConstructFlag<T> backendServerDescriptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
String vPCId
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
HealthCheck healthCheck
SourceSecurityGroup sourceSecurityGroup
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
Date createdTime
String scheme
If the Scheme
is
internet-facing
, the load balancer has a publicly
resolvable DNS name that resolves to public IP addresses.
If the
Scheme
is internal
, the load balancer has a
publicly resolvable DNS name that resolves to private IP addresses.
This option is only available for load balancers attached to an Amazon VPC.
String loadBalancerName
LoadBalancerAttributes loadBalancerAttributes
String loadBalancerName
LoadBalancerAttributes loadBalancerAttributes
LoadBalancerAttributes
data type.com.amazonaws.internal.ListWithAutoConstructFlag<T> appCookieStickinessPolicies
com.amazonaws.internal.ListWithAutoConstructFlag<T> lBCookieStickinessPolicies
com.amazonaws.internal.ListWithAutoConstructFlag<T> otherPolicies
String attributeName
String attributeType
String description
String defaultValue
String cardinality
String policyName
String policyTypeName
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyAttributeDescriptions
String policyTypeName
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyAttributeTypeDescriptions
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Constraints:
Length: 1 -
String loadBalancerName
Integer loadBalancerPort
String sSLCertificateId
String loadBalancerName
Integer instancePort
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
String loadBalancerName
Integer loadBalancerPort
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
String ownerAlias
--source-group-user
parameter of the
ec2-authorize
command in the Amazon EC2 command line
tool.String groupName
--source-group
parameter of the
ec2-authorize
command in the Amazon EC2 command line
tool.String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Constraints:
Length: 1 -
String key
Constraints:
Length: 1 - 128
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceGroups
String jobFlowId
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String jobFlowId
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceGroupIds
String jobFlowId
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> steps
com.amazonaws.internal.ListWithAutoConstructFlag<T> stepIds
String resourceId
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String name
String version
com.amazonaws.internal.ListWithAutoConstructFlag<T> args
Map<K,V> additionalInfo
String name
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
ScriptBootstrapActionConfig scriptBootstrapAction
BootstrapActionConfig bootstrapActionConfig
String id
String name
ClusterStatus status
Ec2InstanceAttributes ec2InstanceAttributes
String logUri
String requestedAmiVersion
String runningAmiVersion
Boolean autoTerminate
Boolean terminationProtected
Boolean visibleToAllUsers
true
, all IAM users of that AWS account can view and
manage the job flow if they have the proper policy permissions set. If
this value is false
, only the IAM user that created the
cluster can view and manage it. This value can be changed using the
SetVisibleToAllUsers action.com.amazonaws.internal.ListWithAutoConstructFlag<T> applications
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String serviceRole
String state
Constraints:
Allowed Values: STARTING, BOOTSTRAPPING, RUNNING, WAITING, TERMINATING, TERMINATED, TERMINATED_WITH_ERRORS
ClusterStateChangeReason stateChangeReason
ClusterTimeline timeline
String id
String name
ClusterStatus status
String name
String scriptPath
com.amazonaws.internal.ListWithAutoConstructFlag<T> args
String clusterId
Cluster cluster
Date createdAfter
Date createdBefore
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobFlowIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobFlowStates
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobFlows
Step step
String ec2KeyName
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 VPC.
String ec2AvailabilityZone
String iamInstanceProfile
com.amazonaws.internal.ListWithAutoConstructFlag<T> properties
String jar
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String mainClass
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> args
String jar
Map<K,V> properties
String mainClass
com.amazonaws.internal.ListWithAutoConstructFlag<T> args
String id
String ec2InstanceId
String publicDnsName
String publicIpAddress
String privateDnsName
String privateIpAddress
InstanceStatus status
String id
String name
String market
Constraints:
Allowed Values: ON_DEMAND, SPOT
String instanceGroupType
Constraints:
Allowed Values: MASTER, CORE, TASK
String bidPrice
String instanceType
Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer requestedInstanceCount
Integer runningInstanceCount
InstanceGroupStatus status
String name
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String market
Constraints:
Allowed Values: ON_DEMAND, SPOT
String instanceRole
Constraints:
Allowed Values: MASTER, CORE, TASK
String bidPrice
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String instanceType
Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer instanceCount
String instanceGroupId
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String name
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String market
Constraints:
Allowed Values: ON_DEMAND, SPOT
String instanceRole
Constraints:
Allowed Values: MASTER, CORE, TASK
String bidPrice
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String instanceType
Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer instanceRequestCount
Integer instanceRunningCount
String state
Constraints:
Allowed Values: PROVISIONING, BOOTSTRAPPING, RUNNING, RESIZING, SUSPENDED, TERMINATING, TERMINATED, ARRESTED, SHUTTING_DOWN, ENDED
String lastStateChangeReason
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Date creationDateTime
Date startDateTime
Date readyDateTime
Date endDateTime
String instanceGroupId
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer instanceCount
com.amazonaws.internal.ListWithAutoConstructFlag<T> eC2InstanceIdsToTerminate
String state
Constraints:
Allowed Values: PROVISIONING, BOOTSTRAPPING, RUNNING, RESIZING, SUSPENDED, TERMINATING, TERMINATED, ARRESTED, SHUTTING_DOWN, ENDED
InstanceGroupStateChangeReason stateChangeReason
InstanceGroupTimeline timeline
String state
Constraints:
Allowed Values: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING, TERMINATED
InstanceStateChangeReason stateChangeReason
InstanceTimeline timeline
String errorCode
String jobFlowId
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String name
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String logUri
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String amiVersion
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
JobFlowExecutionStatusDetail executionStatusDetail
JobFlowInstancesDetail instances
com.amazonaws.internal.ListWithAutoConstructFlag<T> steps
com.amazonaws.internal.ListWithAutoConstructFlag<T> bootstrapActions
com.amazonaws.internal.ListWithAutoConstructFlag<T> supportedProducts
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.String jobFlowRole
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String serviceRole
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String state
Constraints:
Allowed Values: STARTING, BOOTSTRAPPING, RUNNING, WAITING, SHUTTING_DOWN, TERMINATED, COMPLETED, FAILED
Date creationDateTime
Date startDateTime
Date readyDateTime
Date endDateTime
String lastStateChangeReason
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String masterInstanceType
Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String slaveInstanceType
Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer instanceCount
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceGroups
String ec2KeyName
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
PlacementType placement
Boolean keepJobFlowAliveWhenNoSteps
Boolean terminationProtected
String hadoopVersion
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
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: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String masterInstanceType
Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String masterPublicDnsName
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String masterInstanceId
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String slaveInstanceType
Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer instanceCount
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceGroups
Integer normalizedInstanceHours
String ec2KeyName
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String ec2SubnetId
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
PlacementType placement
Boolean keepJobFlowAliveWhenNoSteps
Boolean terminationProtected
String hadoopVersion
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String key
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String value
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> bootstrapActions
String marker
Date createdAfter
Date createdBefore
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterStates
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusters
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceGroups
String marker
String clusterId
String instanceGroupId
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceGroupTypes
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
String marker
String clusterId
com.amazonaws.internal.ListWithAutoConstructFlag<T> stepStates
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> steps
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceGroups
String availabilityZone
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String resourceId
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
String name
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String logUri
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String additionalInfo
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String amiVersion
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 Elastic MapReduce, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer's Guide.
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
JobFlowInstancesConfig instances
com.amazonaws.internal.ListWithAutoConstructFlag<T> steps
com.amazonaws.internal.ListWithAutoConstructFlag<T> bootstrapActions
com.amazonaws.internal.ListWithAutoConstructFlag<T> supportedProducts
com.amazonaws.internal.ListWithAutoConstructFlag<T> newSupportedProducts
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.String jobFlowRole
EMRJobflowDefault
. In
order to use the default role, you must have already created it using
the CLI.
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String serviceRole
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String jobFlowId
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String path
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> args
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobFlowIds
Boolean terminationProtected
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobFlowIds
Boolean visibleToAllUsers
String id
String name
HadoopStepConfig config
String actionOnFailure
Constraints:
Allowed Values: TERMINATE_JOB_FLOW, TERMINATE_CLUSTER, CANCEL_AND_WAIT, CONTINUE
StepStatus status
String name
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String actionOnFailure
Constraints:
Allowed Values: TERMINATE_JOB_FLOW, TERMINATE_CLUSTER, CANCEL_AND_WAIT, CONTINUE
HadoopJarStepConfig hadoopJarStep
StepConfig stepConfig
StepExecutionStatusDetail executionStatusDetail
String state
Constraints:
Allowed Values: PENDING, RUNNING, CONTINUE, COMPLETED, CANCELLED, FAILED, INTERRUPTED
Date creationDateTime
Date startDateTime
Date endDateTime
String lastStateChangeReason
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String state
Constraints:
Allowed Values: PENDING, RUNNING, COMPLETED, CANCELLED, FAILED, INTERRUPTED
StepStateChangeReason stateChangeReason
StepTimeline timeline
String id
String name
StepStatus status
String name
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> args
String key
String value
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobFlowIds
String inputKey
PipelineId
; the
InputBucket
object in that pipeline identifies the
bucket. If the file name includes a prefix, for example,
cooking/pie.jpg
, 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$)
String maxWidth
auto
, Elastic Transcoder uses 600 as the default value.
If you specify a numeric value, enter an even integer between 32 and
4096, inclusive.
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
String maxHeight
auto
, Elastic Transcoder uses 600 as the default value.
If you specify a numeric value, enter an even integer between 32 and
3072, inclusive.
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
String sizingPolicy
Fit:
Elastic Transcoder scales
the output art so it matches the value that you specified in either
MaxWidth
or MaxHeight
without exceeding the
other value.Fill:
Elastic Transcoder scales the
output art 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 art and then
crops it in the dimension (if any) that exceeds the maximum value.
Stretch:
Elastic Transcoder stretches the
output art to match the values that you specified for
MaxWidth
and MaxHeight
. If the relative
proportions of the input art and the output art are different, the
output art will be distorted.Keep:
Elastic
Transcoder does not scale the output art. If either dimension of the
input art exceeds the values that you specified for
MaxWidth
and MaxHeight
, Elastic Transcoder
crops the output art.ShrinkToFit:
Elastic
Transcoder scales the output art 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 art
up.ShrinkToFill
Elastic Transcoder scales the
output art 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 art
up.
Constraints:
Pattern: (^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)
String paddingPolicy
PaddingPolicy
to Pad
, Elastic
Transcoder may add white bars to the top and bottom and/or left and
right sides of the output album art to make the total size of the
output art match the values that you specified for
MaxWidth
and MaxHeight
.
Constraints:
Pattern: (^Pad$)|(^NoPad$)
String albumArtFormat
.jpg
and .png
.
Constraints:
Pattern: (^jpg$)|(^png$)
String profile
Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles:
auto
: If you specify auto
, Elastic
Transcoder will select the profile based on the bit rate selected for
the output file.AAC-LC
: The most common AAC
profile. Use for bitrates larger than 64 kbps.HE-AAC
: Not supported on some older players and
devices. Use for bitrates between 40 and 80 kbps.HE-AACv2
: Not supported on some players and devices.
Use for bitrates less than 48 kbps.If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated your presets to use AAC-LC. You can change the value as required.
Constraints:
Pattern: (^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)
String codec
aac
, mp3
, and vorbis
.
Constraints:
Pattern: (^AAC$)|(^vorbis$)|(^mp3$)
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$)
String bitRate
Constraints:
Pattern: ^\d{1,3}$
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$)
AudioCodecOptions codecOptions
AAC
for Audio:Codec
, this
is the AAC
compression profile to use. Valid values
include: auto
, AAC-LC
,
HE-AAC
, HE-AACv2
If you specify
auto
, Elastic Transcoder chooses a profile based on the
bit rate of the output file.
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}$
String format
Valid Embedded Caption Formats:
For MP3: None
For MP4: mov-text
For MPEG-TS: None
For ogg: None
For webm: None
Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. There are no container restrictions on sidecar captions. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
Constraints:
Pattern: (^mov-text$)|(^srt$)|(^scc$)|(^webvtt$)|(^dfxp$)
String pattern
{language}
, where: {language}
is a literal value that Elastic Transcoder
replaces with the two- or three-letter code for the language of the
caption in the output file names.If you don't include
{language}
in the file name pattern, Elastic Transcoder
automatically appends "{language}
" to the value that you
specify for the description. In addition, Elastic Transcoder
automatically appends the count to the end of the segment files.
For example, suppose you're transcoding into srt format. When you enter "Sydney-{language}-sunrise", and the language of the captions is English (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.
Constraints:
Pattern: (^$)|(^.*\{language\}.*$)
String mergePolicy
MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.
MergeRetain: Elastic Transcoder transcodes both embedded
and sidecar captions into outputs. If captions for a language are
embedded in the input file and also appear in a sidecar file, Elastic
Transcoder uses the embedded captions and ignores the sidecar captions
for that language. If
Override: Elastic Transcoder transcodes only
the sidecar captions that you specify in
CaptionSources
.
MergePolicy
cannot be null.
Constraints:
Pattern: (^MergeOverride$)|(^MergeRetain$)|(^Override$)
com.amazonaws.internal.ListWithAutoConstructFlag<T> captionSources
CaptionSources
blank.
Constraints:
Length: 0 - 20
com.amazonaws.internal.ListWithAutoConstructFlag<T> captionFormats
Constraints:
Length: 0 - 4
String key
Constraints:
Length: 1 - 255
String language
2-character ISO 639-1 code
3-character ISO 639-2 code
For more information on ISO language codes and language names, see the List of ISO 639-1 codes.
Constraints:
Length: 1 - 255
String timeOffset
TimeOffset
tells Elastic
Transcoder how much of the video to encode before including captions.
Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
Constraints:
Pattern: (^[+-]?\d{1,5}(\.\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\.\d{0,3})?$)
String label
Constraints:
Length: 1 - 40
TimeSpan timeSpan
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
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\}.*$)
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$)
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}$
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})?$
com.amazonaws.internal.ListWithAutoConstructFlag<T> watermarks
JobAlbumArt albumArt
com.amazonaws.internal.ListWithAutoConstructFlag<T> composition
Captions captions
Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.
Valid input values include: CEA-608
(EIA-608
, first non-empty channel only), CEA-708
(EIA-708
, first non-empty channel only), and
mov-text
Valid outputs include: mov-text
Elastic Transcoder supports a maximum of one embedded format per output.
Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.
Valid input values include:
dfxp
(first div element only), ebu-tt
,
scc
, smpt
, srt
,
ttml
(first div element only), and webvtt
Valid outputs include: dfxp
(first div element only),
scc
, srt
, and webvtt
.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.
To remove captions or
leave the captions empty, set Captions
to null. To pass
through existing captions unchanged, set the MergePolicy
to MergeRetain
, and pass in a null
CaptionSources
array.
For more information on embedded files, see the Subtitles Wikipedia page.
For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.
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
String format
Constraints:
Pattern: (^HLSv3$)
com.amazonaws.internal.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
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.com.amazonaws.internal.ListWithAutoConstructFlag<T> outputs
Outputs
syntax instead of the Output
syntax.
Constraints:
Length: 0 - 30
String outputKeyPrefix
Constraints:
Length: 1 - 255
com.amazonaws.internal.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
String name
Constraints: Maximum 40 characters.
Constraints:
Length: 1 - 40
String inputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
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}$
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
String name
Constraints:
Length: 1 - 40
String description
Constraints:
Length: 0 - 255
String container
mp3
, mp4
, ogg
, ts
,
and webm
.
Constraints:
Pattern: (^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^ogg$)
VideoParameters video
AudioParameters audio
Thumbnails thumbnails
Preset preset
String warning
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
String arn
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
com.amazonaws.internal.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.
String outputKeyPrefix
OutputKeyPrefix
.
Constraints:
Length: 1 - 255
com.amazonaws.internal.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.
String status
Submitted
,
Progressing
, Complete
,
Canceled
, or Error
.
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
String mergePolicy
Replace:
The specified album art will replace any
existing album art.Prepend:
The specified album
art will be placed in front of any existing album art.Append:
The specified album art will be placed after
any existing album art.Fallback:
If the
original input file contains artwork, Elastic Transcoder will use that
artwork for the output. If the original input does not contain
artwork, Elastic Transcoder will use the specified album art
file.
Constraints:
Pattern: (^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)
com.amazonaws.internal.ListWithAutoConstructFlag<T> artwork
.jpg
and .png
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
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$)|(^50$)|(^60$)
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}$)
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$)
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$)
String container
auto
. If you want to specify the container type for the
input file, enter one of the following values: 3gp
,
aac
, asf
, avi
,
divx
, flv
, m4a
,
mkv
, mov
, mp3
,
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$)|(^mp3$)|(^m4a$)|(^aac$)
String id
String key
OutputBucket
object in the pipeline that is specified by
the pipeline ID.
Constraints:
Length: 1 - 255
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\}.*$)
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$)
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}$
String segmentDuration
PresetId
for which the value of
Container
is 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})?$
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$)
String statusDetail
Status
.
Constraints:
Length: 0 - 255
Long duration
Integer width
Integer height
com.amazonaws.internal.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.
JobAlbumArt albumArt
com.amazonaws.internal.ListWithAutoConstructFlag<T> composition
Captions captions
Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.
Valid input values include: CEA-608
(EIA-608
, first non-empty channel only), CEA-708
(EIA-708
, first non-empty channel only), and
mov-text
Valid outputs include: mov-text
Elastic Transcoder supports a maximum of one embedded format per output.
Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.
Valid input values include:
dfxp
(first div element only), ebu-tt
,
scc
, smpt
, srt
,
ttml
(first div element only), and webvtt
Valid outputs include: dfxp
(first div element only),
scc
, srt
, and webvtt
.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.
To remove captions or
leave the captions empty, set Captions
to null. To pass
through existing captions unchanged, set the MergePolicy
to MergeRetain
, and pass in a null
CaptionSources
array.
For more information on embedded files, see the Subtitles Wikipedia page.
For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.
String presetWatermarkId
Constraints:
Length: 1 - 40
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$)
String pipelineId
Constraints:
Pattern: ^\d{13}-\w{6}$
String ascending
true
. To list jobs in reverse
chronological order, enter false
.
Constraints:
Pattern: (^true$)|(^false$)
String pageToken
pageToken
in subsequent GET
requests to get
each successive page of results.
Constraints:
Pattern: ^\d{13}-\w{6}$
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobs
Job
objects that are in the specified
pipeline.String nextPageToken
NextPageToken
is null
.
Constraints:
Pattern: ^\d{13}-\w{6}$
String status
Submitted
, Progressing
,
Complete
, Canceled
, or Error
.
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
String ascending
true
. To list jobs in reverse
chronological order, enter false
.
Constraints:
Pattern: (^true$)|(^false$)
String pageToken
pageToken
in subsequent GET
requests to get
each successive page of results.
Constraints:
Pattern: ^\d{13}-\w{6}$
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobs
Job
objects that have the specified status.String nextPageToken
NextPageToken
is null
.
Constraints:
Pattern: ^\d{13}-\w{6}$
String ascending
true
. To list pipelines in
reverse chronological order, enter false
.
Constraints:
Pattern: (^true$)|(^false$)
String pageToken
pageToken
in subsequent GET
requests to get
each successive page of results.
Constraints:
Pattern: ^\d{13}-\w{6}$
com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelines
Pipeline
objects.String nextPageToken
NextPageToken
is null
.
Constraints:
Pattern: ^\d{13}-\w{6}$
String ascending
true
. To list presets in reverse
chronological order, enter false
.
Constraints:
Pattern: (^true$)|(^false$)
String pageToken
pageToken
in subsequent GET
requests to get
each successive page of results.
Constraints:
Pattern: ^\d{13}-\w{6}$
com.amazonaws.internal.ListWithAutoConstructFlag<T> presets
Preset
objects.String nextPageToken
NextPageToken
is null
.
Constraints:
Pattern: ^\d{13}-\w{6}$
String progressing
Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)
String completed
Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)
String warning
Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)
String error
Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)
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$)
String grantee
Constraints:
Length: 1 - 255
com.amazonaws.internal.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
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
String arn
String name
Constraints: Maximum 40 characters
Constraints:
Length: 1 - 40
String status
Active
: The
pipeline is processing jobs.Paused
: The
pipeline is not currently processing jobs.
Constraints:
Pattern: (^Active$)|(^Paused$)
String inputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
String outputBucket
ContentConfig
and
ThumbnailConfig
.
Constraints:
Pattern: ^(\w|\.|-){1,255}$
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.String bucket
ContentConfig
and ThumbnailConfig
instead.
Constraints:
Pattern: ^(\w|\.|-){1,255}$
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$)
com.amazonaws.internal.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
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
String format
HLSv3
.
Constraints:
Pattern: (^HLSv3$)
com.amazonaws.internal.ListWithAutoConstructFlag<T> outputKeys
SegmentDuration
for all of the outputs must be the same.
Constraints:
Length: 0 - 30
String status
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
String statusDetail
Constraints:
Length: 0 - 255
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
String arn
String name
Constraints:
Length: 1 - 40
String description
Constraints:
Length: 0 - 255
String container
mp3
, mp4
, ogg
, ts
,
and webm
.
Constraints:
Pattern: (^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^ogg$)
AudioParameters audio
VideoParameters video
Thumbnails thumbnails
String type
System
) or a preset that you have defined
(Custom
).
Constraints:
Pattern: (^System$)|(^Custom$)
String id
Id
can be up to 40 characters long.
Constraints:
Length: 1 - 40
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{1,4}?px$)
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{1,4}?px$)
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$)
String horizontalAlign
HorizontalOffset
:
Constraints:
Pattern: (^Left$)|(^Right$)|(^Center$)
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{1,4}?px$)
String verticalAlign
VerticalOffset
:
Constraints:
Pattern: (^Top$)|(^Bottom$)|(^Center$)
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{1,4}?px$)
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})?$
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$)
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
Job job
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
Pipeline pipeline
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
Preset preset
String role
Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$
String inputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
String outputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
com.amazonaws.internal.ListWithAutoConstructFlag<T> topics
Constraints:
Length: 0 - 30
String success
true
;
otherwise, the value is false
.
Constraints:
Pattern: (^true$)|(^false$)
com.amazonaws.internal.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.String format
jpg
and png
. You specify whether you want Elastic Transcoder to create thumbnails when you create a job.
Constraints:
Pattern: (^jpg$)|(^png$)
String interval
Constraints:
Pattern: ^\d{1,5}$
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}$
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$)
String maxWidth
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
String maxHeight
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
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$)
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$)
String startTime
Constraints:
Pattern: (^\d{1,5}(\.\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\.\d{0,3})?$)
String duration
If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes the file and returns a warning message.
Constraints:
Pattern: (^\d{1,5}(\.\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\.\d{0,3})?$)
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
Notifications notifications
Pipeline pipeline
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
String name
Constraints: Maximum 40 characters
Constraints:
Length: 1 - 40
String inputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
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
Pipeline pipeline
String codec
H.264
and vp8
. You can only specify
vp8
when the container type is webm
.
Constraints:
Pattern: (^H\.264$)|(^vp8$)
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
String keyframesMaxDist
Constraints:
Pattern: ^\d{1,6}$
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$)
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$)
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$)|(^50$)|(^60$)
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$)|(^50$)|(^60$)
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}$)
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$)
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}$)
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}$)
String displayAspectRatio
Constraints:
Pattern: (^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)
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$)
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$)
com.amazonaws.internal.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.
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.String vaultName
String uploadId
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.String vaultName
String uploadId
String archiveSize
String checksum
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.String vaultName
String location
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.String vaultName
String archiveId
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.String vaultName
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.String vaultName
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.String vaultName
String jobId
String jobId
String jobDescription
String action
Constraints:
Allowed Values: ArchiveRetrieval, InventoryRetrieval
String archiveId
String vaultARN
String creationDate
Boolean completed
String statusCode
Constraints:
Allowed Values: InProgress, Succeeded, Failed
String statusMessage
Long archiveSizeInBytes
Long inventorySizeInBytes
String sNSTopic
String completionDate
String sHA256TreeHash
The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.
For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.
This field is null in the following situations:
Archive retrieval jobs that specify a range that is not tree-hash aligned.
Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.
Inventory jobs.
String archiveSHA256TreeHash
String retrievalByteRange
InventoryRetrievalJobDescription inventoryRetrievalParameters
String vaultARN
String vaultName
String creationDate
String lastInventoryDate
Long numberOfArchives
null
if an inventory has not yet
run on the vault, for example, if you just created the vault.Long sizeInBytes
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.String vaultName
String vaultARN
String vaultName
String creationDate
String lastInventoryDate
Long numberOfArchives
null
if an inventory has not yet
run on the vault, for example, if you just created the vault.Long sizeInBytes
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.String vaultName
String jobId
String range
InputStream body
String checksum
Integer status
String contentRange
String acceptRanges
String contentType
String archiveDescription
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.String vaultName
VaultNotificationConfig vaultNotificationConfig
String jobId
String jobDescription
String action
Constraints:
Allowed Values: ArchiveRetrieval, InventoryRetrieval
String archiveId
String vaultARN
String creationDate
Boolean completed
String statusCode
Constraints:
Allowed Values: InProgress, Succeeded, Failed
String statusMessage
Long archiveSizeInBytes
Long inventorySizeInBytes
String sNSTopic
String completionDate
String sHA256TreeHash
The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.
For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.
This field is null in the following situations:
Archive retrieval jobs that specify a range that is not tree-hash aligned.
Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.
Inventory jobs.
String archiveSHA256TreeHash
String retrievalByteRange
InventoryRetrievalJobDescription inventoryRetrievalParameters
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.String vaultName
JobParameters jobParameters
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.String vaultName
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).
String partSize
String format
String startDate
String endDate
String limit
String marker
null
.
For more information, see
Range Inventory Retrieval.String startDate
String endDate
String limit
String marker
null
.String format
String type
String archiveId
Type
is set to archive-retrieval. An
error occurs if you specify this request parameter for an inventory
retrieval job request.String description
String sNSTopic
String retrievalByteRange
An error occurs if you specify this field for an inventory retrieval job request.
InventoryRetrievalJobInput inventoryRetrievalParameters
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.String vaultName
String limit
String marker
String statuscode
String completed
true
or false
.com.amazonaws.internal.ListWithAutoConstructFlag<T> jobList
String marker
null
.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.String vaultName
String uploadIdMarker
String limit
com.amazonaws.internal.ListWithAutoConstructFlag<T> uploadsList
String marker
null
.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.String vaultName
String uploadId
String marker
String limit
String multipartUploadId
String vaultARN
String archiveDescription
Long partSizeInBytes
String creationDate
com.amazonaws.internal.ListWithAutoConstructFlag<T> parts
String marker
null
.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.String marker
String limit
com.amazonaws.internal.ListWithAutoConstructFlag<T> vaultList
String marker
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.String vaultName
VaultNotificationConfig vaultNotificationConfig
Long contentLength
String vaultName
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.String archiveDescription
String checksum
InputStream body
String multipartUploadId
String vaultARN
String archiveDescription
Long partSizeInBytes
String creationDate
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.String vaultName
String uploadId
String checksum
String range
InputStream body
String checksum
String sNSTopic
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String accessKeyId
Constraints:
Length: 16 - 32
Pattern: [\w]*
String status
Active
means the key is
valid for API calls, while Inactive
means it is not.
Constraints:
Allowed Values: Active, Inactive
String secretAccessKey
Date createDate
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String accessKeyId
Constraints:
Length: 16 - 32
Pattern: [\w]*
String status
Active
means the key is
valid for API calls, while Inactive
means it is not.
Constraints:
Allowed Values: Active, Inactive
Date createDate
String oldPassword
Constraints:
Length: 1 - 128
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
String newPassword
Constraints:
Length: 1 - 128
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
AccessKey accessKey
String accountAlias
Constraints:
Length: 3 - 63
Pattern: ^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$
String path
This parameter is optional. If it is not included, it defaults to a slash (/).
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
Group group
String instanceProfileName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String path
This parameter is optional. If it is not included, it defaults to a slash (/).
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
InstanceProfile instanceProfile
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String password
Constraints:
Length: 1 - 128
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
Boolean passwordResetRequired
LoginProfile loginProfile
String path
This parameter is optional. If it is not included, it defaults to a slash (/).
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String assumeRolePolicyDocument
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
Role role
String sAMLMetadataDocument
For more information, see Creating Temporary Security Credentials for SAML Federation in the Using Temporary Security Credentials guide.
Constraints:
Length: 1000 - 10000000
String name
Constraints:
Length: 1 - 128
Pattern: [\w._-]*
String sAMLProviderArn
Constraints:
Length: 20 - 2048
String path
This parameter is optional. If it is not included, it defaults to a slash (/).
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
User user
String path
This parameter is optional. If it is not included, it defaults to a slash (/).
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
String virtualMFADeviceName
Constraints:
Length: 1 -
Pattern: [\w+=,.@-]*
VirtualMFADevice virtualMFADevice
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String serialNumber
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
String accountAlias
Constraints:
Length: 3 - 63
Pattern: ^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$
String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String instanceProfileName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String sAMLProviderArn
Constraints:
Length: 20 - 2048
String serverCertificateName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String serialNumber
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String serialNumber
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
String authenticationCode1
Constraints:
Length: 6 - 6
Pattern: [\d]*
String authenticationCode2
Constraints:
Length: 6 - 6
Pattern: [\d]*
PasswordPolicy passwordPolicy
This data type is used as a response element in the action GetAccountPasswordPolicy.
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
ByteBuffer content
String reportFormat
Constraints:
Allowed Values: text/csv
Date generatedTime
String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String marker
Marker
element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
Integer maxItems
IsTruncated
response element is true
. This parameter is optional. If
you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
Group group
com.amazonaws.internal.ListWithAutoConstructFlag<T> users
Boolean isTruncated
Marker
request parameter to retrieve
more user names in the list.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: [\u0020-\u00FF]*
String instanceProfileName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
InstanceProfile instanceProfile
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
LoginProfile loginProfile
String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
Role role
String sAMLProviderArn
Constraints:
Length: 20 - 2048
String sAMLMetadataDocument
Constraints:
Length: 1000 - 10000000
Date createDate
Date validUntil
String serverCertificateName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
ServerCertificate serverCertificate
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
String userName
This parameter is optional. If it is not included, it defaults to the user making the request.
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
User user
String path
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String groupId
Constraints:
Length: 16 - 32
Pattern: [\w]*
String arn
Constraints:
Length: 20 - 2048
Date createDate
String path
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
String instanceProfileName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String instanceProfileId
Constraints:
Length: 16 - 32
Pattern: [\w]*
String arn
Constraints:
Length: 20 - 2048
Date createDate
com.amazonaws.internal.ListWithAutoConstructFlag<T> roles
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String marker
Marker
element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
Integer maxItems
IsTruncated
response element is true
. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> accessKeyMetadata
Boolean isTruncated
Marker
request parameter to retrieve more keys
in the list.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: [\u0020-\u00FF]*
String marker
Marker
element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
Integer maxItems
IsTruncated
response element is true
. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> accountAliases
Boolean isTruncated
Marker
request parameter to retrieve
more account aliases in the list.String marker
Marker
element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String marker
Marker
element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
Integer maxItems
IsTruncated
response element is true
. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
Boolean isTruncated
Marker
request parameter to retrieve
more policy names in the list.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: [\u0020-\u00FF]*
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String marker
Marker
element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
Integer maxItems
IsTruncated
response
element is true
. This parameter is optional. If you do
not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
Boolean isTruncated
Marker
request parameter to retrieve more
groups in the list.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: [\u0020-\u00FF]*
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: \u002F[\u0021-\u007F]*
String marker
Marker
element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
Integer maxItems
IsTruncated
response
element is true
. This parameter is optional. If you do
not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
Boolean isTruncated
Marker
request parameter to retrieve more
groups in the list.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: [\u0020-\u00FF]*
String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String marker
Marker
element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
Integer maxItems
IsTruncated
response element is true
. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceProfiles
Boolean isTruncated
Marker
request parameter to
retrieve more instance profiles in the list.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: [\u0020-\u00FF]*
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: \u002F[\u0021-\u007F]*
String marker
Marker
element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
Integer maxItems
IsTruncated
response element is true
. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceProfiles
Boolean isTruncated
Marker
request parameter to
retrieve more instance profiles in the list.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: [\u0020-\u00FF]*
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String marker
Marker
element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
Integer maxItems
IsTruncated
response element is true
. This parameter is optional. If
you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> mFADevices
Boolean isTruncated
Marker
request parameter to retrieve
more MFA devices in the list.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: [\u0020-\u00FF]*
String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String marker
Marker
element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
Integer maxItems
IsTruncated
response element is true
. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
Boolean isTruncated
Marker
request parameter to retrieve
more policy names in the list.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: [\u0020-\u00FF]*
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: \u002F[\u0021-\u007F]*
String marker
Marker
element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
Integer maxItems
IsTruncated
response element is true
. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> roles
Boolean isTruncated
Marker
request parameter to retrieve more roles
in the list.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: [\u0020-\u00FF]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> sAMLProviderList
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: \u002F[\u0021-\u007F]*
String marker
Marker
element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
Integer maxItems
IsTruncated
response element will be set to
true
. This parameter is optional. If you do not include
it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> serverCertificateMetadataList
Boolean isTruncated
Marker
request parameter to
retrieve more server certificates in the list.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: [\u0020-\u00FF]*
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String marker
Marker
element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
Integer maxItems
IsTruncated
response element is true
. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> certificates
Boolean isTruncated
Marker
request parameter to retrieve
more certificates in the list.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: [\u0020-\u00FF]*
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String marker
Marker
element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
Integer maxItems
IsTruncated
response element is true
. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
Boolean isTruncated
Marker
request parameter to retrieve
more policy names in the list.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: [\u0020-\u00FF]*
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: \u002F[\u0021-\u007F]*
String marker
Marker
element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
Integer maxItems
IsTruncated
response element is true
. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> users
Boolean isTruncated
Marker
request parameter to retrieve
more users in the list.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: [\u0020-\u00FF]*
String assignmentStatus
AssignmentStatus
, the action defaults to
Any
which lists both assigned and unassigned virtual MFA
devices.
Constraints:
Allowed Values: Assigned, Unassigned, Any
String marker
Marker
element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
Integer maxItems
IsTruncated
response element is true
. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> virtualMFADevices
Boolean isTruncated
Marker
request parameter to retrieve more items
the list.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: [\u0020-\u00FF]*
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
Date createDate
Boolean passwordResetRequired
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String serialNumber
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
Date enableDate
Integer minimumPasswordLength
Constraints:
Range: 6 - 128
Boolean requireSymbols
Boolean requireNumbers
Boolean requireUppercaseCharacters
Boolean requireLowercaseCharacters
Boolean allowUsersToChangePassword
Boolean expirePasswords
Integer maxPasswordAge
Constraints:
Range: 1 - 1095
Integer passwordReusePrevention
Constraints:
Range: 1 - 24
Boolean hardExpiry
String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String serialNumber
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
String authenticationCode1
Constraints:
Length: 6 - 6
Pattern: [\d]*
String authenticationCode2
Constraints:
Length: 6 - 6
Pattern: [\d]*
String path
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String roleId
Constraints:
Length: 16 - 32
Pattern: [\w]*
String arn
Constraints:
Length: 20 - 2048
Date createDate
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: [\u0009\u000A\u000D\u0020-\u00FF]+
ServerCertificateMetadata serverCertificateMetadata
String certificateBody
Constraints:
Length: 1 - 16384
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
String certificateChain
Constraints:
Length: 1 - 2097152
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]*
String path
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
String serverCertificateName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String serverCertificateId
Constraints:
Length: 16 - 32
Pattern: [\w]*
String arn
Constraints:
Length: 20 - 2048
Date uploadDate
Date expiration
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String certificateId
Constraints:
Length: 24 - 128
Pattern: [\w]*
String certificateBody
Constraints:
Length: 1 - 16384
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
String status
Active
means the
key is valid for API calls, while Inactive
means it is
not.
Constraints:
Allowed Values: Active, Inactive
Date uploadDate
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String accessKeyId
Constraints:
Length: 16 - 32
Pattern: [\w]*
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
Integer minimumPasswordLength
Default value: 6
Constraints:
Range: 6 - 128
Boolean requireSymbols
Boolean requireNumbers
Default value: false
Boolean requireUppercaseCharacters
Default value: false
Boolean requireLowercaseCharacters
Default value: false
Boolean allowUsersToChangePassword
Default value: false
Integer maxPasswordAge
Default value: 0
Constraints:
Range: 1 - 1095
Integer passwordReusePrevention
Default value: 0
Constraints:
Range: 1 - 24
Boolean hardExpiry
Default value: false
String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String newPath
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
String newGroupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String password
Constraints:
Length: 1 - 128
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
Boolean passwordResetRequired
String sAMLMetadataDocument
Constraints:
Length: 1000 - 10000000
String sAMLProviderArn
Constraints:
Length: 20 - 2048
String sAMLProviderArn
Constraints:
Length: 20 - 2048
String serverCertificateName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String newPath
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
String newServerCertificateName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String certificateId
Constraints:
Length: 24 - 128
Pattern: [\w]*
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
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String newPath
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
String newUserName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String path
This parameter
is optional. If it is not included, it defaults to a slash (/).
--path
option. The path must begin with
/cloudfront
and must include a trailing slash (for
example, /cloudfront/test/
).
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
String serverCertificateName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String certificateBody
Constraints:
Length: 1 - 16384
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
String privateKey
Constraints:
Length: 1 - 16384
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]*
String certificateChain
Constraints:
Length: 1 - 2097152
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]*
ServerCertificateMetadata serverCertificateMetadata
SigningCertificate certificate
String path
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String userId
Constraints:
Length: 16 - 32
Pattern: [\w]*
String arn
Constraints:
Length: 20 - 2048
Date createDate
String serialNumber
VirtualMFADevice
.
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
ByteBuffer base32StringSeed
Base32StringSeed
is Base64-encoded.ByteBuffer qRCodePNG
Base32String
is Base64-encoded.User user
This data type is used as a response element in the following actions:
Date enableDate
String jobId
Boolean success
String jobType
Constraints:
Allowed Values: Import, Export
String manifest
String manifestAddendum
Boolean validateOnly
String jobId
String jobType
Constraints:
Allowed Values: Import, Export
String awsShippingAddress
String signature
String signatureFileContents
String warningMessage
String jobId
String jobId
String jobType
Constraints:
Allowed Values: Import, Export
String awsShippingAddress
String locationCode
String locationMessage
String progressCode
String progressMessage
String carrier
String trackingNumber
String logBucket
String logKey
Integer errorCount
String signature
String signatureFileContents
String currentManifest
Date creationDate
String jobId
Date creationDate
Boolean isCanceled
String jobType
Constraints:
Allowed Values: Import, Export
Integer maxJobs
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobs
Boolean isTruncated
String jobId
String manifest
String jobType
Constraints:
Allowed Values: Import, Export
Boolean validateOnly
String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
Integer shardCount
Note: The default limit for an AWS account is 10 shards per stream. If you need to create a stream with more than 10 shards, contact AWS Support to increase the limit on your account.
Constraints:
Range: 1 -
String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
Integer limit
Constraints:
Range: 1 - 10000
String exclusiveStartShardId
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
StreamDescription streamDescription
String shardIterator
Constraints:
Length: 1 - 512
Integer limit
GetRecords
throws InvalidArgumentException
.
Constraints:
Range: 1 - 10000
com.amazonaws.internal.ListWithAutoConstructFlag<T> records
The data records retrieved from the shard.
String nextShardIterator
null
, the shard has been
closed and the requested iterator will not return any more data.
Constraints:
Length: 1 - 512
String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String shardId
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String shardIteratorType
The following are the valid shard iterator types:
Constraints:
Allowed Values: AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST
String startingSequenceNumber
Constraints:
Pattern: 0|([1-9]\d{0,128})
String shardIterator
Constraints:
Length: 1 - 512
com.amazonaws.internal.ListWithAutoConstructFlag<T> streamNames
ListStreams
request.Boolean hasMoreStreams
true
, there are more streams available to list.String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String exclusiveStartTagKey
ListTagsForStream
gets all tags that
occur after ExclusiveStartTagKey
.
Constraints:
Length: 1 - 128
Integer limit
HasMoreTags
is
set to true
. To list additional tags, set
ExclusiveStartTagKey
to the last key in the response.
Constraints:
Range: 1 - 10
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
StreamName
, starting with
the first tag after ExclusiveStartTagKey
and up to the
specified Limit
.
Constraints:
Length: 0 -
Boolean hasMoreTags
true
, more tags are available. To request
additional tags, set ExclusiveStartTagKey
to the key of
the last tag returned.String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String shardToMerge
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String adjacentShardToMerge
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
ByteBuffer data
Constraints:
Length: 0 - 51200
String partitionKey
Constraints:
Length: 1 - 256
String explicitHashKey
Constraints:
Pattern: 0|([1-9]\d{0,38})
String sequenceNumberForOrdering
SequenceNumberForOrdering
of record n to the
sequence number of record n-1 (as returned in the
PutRecordResult when putting record n-1). If this
parameter is not set, records will be coarsely ordered based on
arrival time.
Constraints:
Pattern: 0|([1-9]\d{0,128})
String shardId
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String sequenceNumber
Constraints:
Pattern: 0|([1-9]\d{0,128})
String sequenceNumber
Constraints:
Pattern: 0|([1-9]\d{0,128})
ByteBuffer data
Constraints:
Length: 0 - 51200
String partitionKey
Constraints:
Length: 1 - 256
String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
Constraints:
Length: 1 - 10
String startingSequenceNumber
Constraints:
Pattern: 0|([1-9]\d{0,128})
String endingSequenceNumber
null
.
Constraints:
Pattern: 0|([1-9]\d{0,128})
String shardId
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String parentShardId
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String adjacentParentShardId
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
HashKeyRange hashKeyRange
SequenceNumberRange sequenceNumberRange
String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String shardToSplit
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String newStartingHashKey
NewStartingHashKey
must be in the range of hash keys
being mapped into the shard. The NewStartingHashKey
hash
key value and all higher hash key values in hash key range are
distributed to one of the child shards. All the lower hash key values
in the range are distributed to the other child shard.
Constraints:
Pattern: 0|([1-9]\d{0,38})
String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String streamARN
String streamStatus
The stream status is one of the following states:
CREATING
- The
stream is being created. Amazon Kinesis immediately returns and sets
StreamStatus
to CREATING
.DELETING
- The stream is being deleted. The specified
stream is in the DELETING
state until Amazon Kinesis
completes the deletion.ACTIVE
- The stream
exists and is ready for read and write operations or deletion. You
should perform read and write operations only on an
ACTIVE
stream.UPDATING
- Shards in
the stream are being merged or split. Read and write operations
continue to work while the stream is in the UPDATING
state.
Constraints:
Allowed Values: CREATING, DELETING, ACTIVE, UPDATING
com.amazonaws.internal.ListWithAutoConstructFlag<T> shards
Boolean hasMoreShards
true
, more shards in the stream are available
to describe.String key
Constraints:
Length: 1 - 128
String value
Constraints:
Length: 0 - 256
String logGroupName
String expectedSequenceToken
String logGroupName
String logGroupName
String logGroupNamePrefix
String nextToken
DescribeLogGroups
request.Integer limit
Constraints:
Range: 1 - 50
com.amazonaws.internal.ListWithAutoConstructFlag<T> logGroups
String nextToken
String logGroupName
String logStreamNamePrefix
String nextToken
DescribeLogStreams
request.Integer limit
Constraints:
Range: 1 - 50
com.amazonaws.internal.ListWithAutoConstructFlag<T> logStreams
String nextToken
String logGroupName
String filterNamePrefix
Constraints:
Length: 1 - 512
Pattern: [^:*]*
String nextToken
DescribeMetricFilters
request.Integer limit
Constraints:
Range: 1 - 50
com.amazonaws.internal.ListWithAutoConstructFlag<T> metricFilters
String nextToken
String logGroupName
String logStreamName
Long startTime
Constraints:
Range: 0 -
Long endTime
Constraints:
Range: 0 -
String nextToken
nextForwardToken
or nextBackwardToken
fields in the response of the
previous GetLogEvents
request.Integer limit
Constraints:
Range: 1 - 10000
Boolean startFromHead
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String nextForwardToken
String nextBackwardToken
String expectedSequenceToken
String logGroupName
Long creationTime
Constraints:
Range: 0 -
Integer retentionInDays
Integer metricFilterCount
String arn
Long storedBytes
String logStreamName
Long creationTime
Constraints:
Range: 0 -
Long firstEventTimestamp
Constraints:
Range: 0 -
Long lastEventTimestamp
Constraints:
Range: 0 -
Long lastIngestionTime
Constraints:
Range: 0 -
String uploadSequenceToken
sequenceToken
can only be used once, and
PutLogEvents requests must include the sequenceToken
obtained from the response of the
previous request.
Constraints:
Length: 1 -
String arn
Long storedBytes
String filterName
Constraints:
Length: 1 - 512
Pattern: [^:*]*
String filterPattern
Constraints:
Length: 0 - 512
com.amazonaws.internal.ListWithAutoConstructFlag<T> metricTransformations
Long creationTime
Constraints:
Range: 0 -
String metricName
Constraints:
Length: 0 - 255
Pattern: [^:*$]*
String metricNamespace
Constraints:
Length: 0 - 255
Pattern: [^:*$]*
String metricValue
Constraints:
Length: 0 - 100
String logGroupName
String logStreamName
com.amazonaws.internal.ListWithAutoConstructFlag<T> logEvents
Constraints:
Length: 1 - 1000
String sequenceToken
PutLogEvents
request.
Constraints:
Length: 1 -
String nextSequenceToken
sequenceToken
can only be used once, and
PutLogEvents requests must include the sequenceToken
obtained from the response of the
previous request.
Constraints:
Length: 1 -
String logGroupName
String filterName
Constraints:
Length: 1 - 512
Pattern: [^:*]*
String filterPattern
Constraints:
Length: 0 - 512
com.amazonaws.internal.ListWithAutoConstructFlag<T> metricTransformations
String filterPattern
Constraints:
Length: 0 - 512
com.amazonaws.internal.ListWithAutoConstructFlag<T> logEventMessages
com.amazonaws.internal.ListWithAutoConstructFlag<T> matches
String appId
String stackId
String shortname
String name
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> dataSources
String type
Constraints:
Allowed Values: java, rails, php, nodejs, static, other
Source appSource
Source
object that describes the app repository.com.amazonaws.internal.ListWithAutoConstructFlag<T> domains
'www.example.com, example.com'
Boolean enableSsl
SslConfiguration sslConfiguration
SslConfiguration
object with the SSL configuration.Map<K,V> attributes
String createdAt
com.amazonaws.internal.ListWithAutoConstructFlag<T> environment
EnvironmentVariable
objects that specify
environment variables to be associated with the app. You can specify
up to ten environment variables. After you deploy the app, these
variables are defined on the associated app server instances.Integer instanceCount
Integer thresholdsWaitTime
Constraints:
Range: 1 - 100
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
Double cpuThreshold
Double memoryThreshold
Double loadThreshold
String sourceStackId
String name
String region
String vpcId
If the VPC ID corresponds
to a default VPC and you have specified either the
DefaultAvailabilityZone
or the
DefaultSubnetId
parameter only, AWS OpsWorks infers the
value of the other parameter. If you specify neither parameter, AWS
OpsWorks sets these parameters to the first valid Availability Zone
for the specified region and the corresponding default VPC subnet ID,
respectively.
If you specify a nondefault VPC ID, note the following:
DefaultSubnetId
.For more information on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2 Classic, see Supported Platforms.
Map<K,V> attributes
String serviceRoleArn
You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.
String defaultInstanceProfileArn
String defaultOs
Amazon Linux
, Ubuntu 12.04 LTS
, or
Ubuntu 14.04 LTS
. The default option is Amazon
Linux
.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: Baked_Goods
Clouds
European_Cities
Fruits
Greek_Deities
Legendary_Creatures_from_Japan
Planets_and_Moons
Roman_Deities
Scottish_Islands
US_Cities
Wild_Cats
To obtain a generated host
name, call GetHostNameSuggestion
, which returns a host
name based on the current theme.
String defaultAvailabilityZone
DefaultSubnetId
, the subnet must be in the same zone. For
more information, see the VpcId
parameter description.String defaultSubnetId
VpcId
parameter. All instances
are launched into this subnet unless you specify otherwise when you
create the instance. If you also specify a value for
DefaultAvailabilityZone
, the subnet must be in that zone.
For information on default values and when this parameter is required,
see the VpcId
parameter description.String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON
StackConfigurationManager configurationManager
ChefConfiguration chefConfiguration
ChefConfiguration
object that specifies whether to
enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For
more information, see Create
a New Stack.Boolean useCustomCookbooks
Boolean useOpsworksSecurityGroups
AWS OpsWorks provides a standard set of
built-in security groups, one for each layer, which are associated
with layers by default. With UseOpsworksSecurityGroups
you can instead provide your own custom security groups.
UseOpsworksSecurityGroups
has the following settings:
For more information, see Create a New Stack.
Source customCookbooksSource
String defaultSshKeyName
Boolean clonePermissions
com.amazonaws.internal.ListWithAutoConstructFlag<T> cloneAppIds
String defaultRootDeviceType
Constraints:
Allowed Values: ebs, instance-store
String stackId
String commandId
String instanceId
String deploymentId
String createdAt
String acknowledgedAt
String completedAt
String status
Integer exitCode
String logUrl
String type
deploy
rollback
start
stop
restart
undeploy
update_dependencies
install_dependencies
update_custom_cookbooks
execute_recipes
String stackId
String shortname
String name
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> dataSources
String type
Constraints:
Allowed Values: java, rails, php, nodejs, static, other
Source appSource
Source
object that specifies the app repository.com.amazonaws.internal.ListWithAutoConstructFlag<T> domains
'www.example.com, example.com'
Boolean enableSsl
SslConfiguration sslConfiguration
SslConfiguration
object with the SSL configuration.Map<K,V> attributes
com.amazonaws.internal.ListWithAutoConstructFlag<T> environment
EnvironmentVariable
objects that specify
environment variables to be associated with the app. You can specify
up to ten environment variables. After you deploy the app, these
variables are defined on the associated app server instance.
String appId
String stackId
String appId
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
DeploymentCommand command
DeploymentCommand
object that specifies the deployment
command and any associated arguments.String comment
String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
String deploymentId
String stackId
com.amazonaws.internal.ListWithAutoConstructFlag<T> layerIds
String instanceType
String autoScalingType
Constraints:
Allowed Values: load, timer
String hostname
String os
Amazon
Linux
, Ubuntu 12.04 LTS
, or Ubuntu 14.04
LTS
.Custom
The 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.
String amiId
String sshKeyName
String availabilityZone
String virtualizationType
paravirtual
or
hvm
.String subnetId
String architecture
x86_64
.
Instance types do not necessarily support both architectures. For a
list of the architectures that are supported by the different instance
types, see Instance
Families and Types.
Constraints:
Allowed Values: x86_64, i386
String rootDeviceType
Constraints:
Allowed Values: ebs, instance-store
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. We strongly
recommend using the default value of true
to ensure that
your instances have the latest security updates.
Boolean ebsOptimized
String instanceId
String stackId
String type
Constraints:
Allowed Values: java-app, lb, web, php-app, rails-app, nodejs-app, memcached, db-master, monitoring-master, custom
String name
String shortname
Map<K,V> attributes
String customInstanceProfileArn
com.amazonaws.internal.ListWithAutoConstructFlag<T> customSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> packages
Package
objects that describe the layer
packages.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeConfigurations
VolumeConfigurations
object that describes the layer's
Amazon EBS volumes.Boolean enableAutoHealing
Boolean autoAssignElasticIps
Boolean autoAssignPublicIps
Recipes customRecipes
LayerCustomRecipes
object that specifies the layer
custom recipes.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. We strongly
recommend using the default value of true
, to ensure that
your instances have the latest security updates.
Boolean useEbsOptimizedInstances
String layerId
String name
String region
String vpcId
If the VPC ID corresponds to a default
VPC and you have specified either the
DefaultAvailabilityZone
or the
DefaultSubnetId
parameter only, AWS OpsWorks infers the
value of the other parameter. If you specify neither parameter, AWS
OpsWorks sets these parameters to the first valid Availability Zone
for the specified region and the corresponding default VPC subnet ID,
respectively.
If you specify a nondefault VPC ID, note the following:
DefaultSubnetId
.For more information on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2 Classic, see Supported Platforms.
Map<K,V> attributes
String serviceRoleArn
String defaultInstanceProfileArn
String defaultOs
Amazon Linux
, Ubuntu 12.04 LTS
, or
Ubuntu 14.04 LTS
. The default option is Amazon
Linux
.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: Baked_Goods
Clouds
European_Cities
Fruits
Greek_Deities
Legendary_Creatures_from_Japan
Planets_and_Moons
Roman_Deities
Scottish_Islands
US_Cities
Wild_Cats
To obtain a generated host
name, call GetHostNameSuggestion
, which returns a host
name based on the current theme.
String defaultAvailabilityZone
DefaultSubnetId
, the subnet must be in the same zone. For
more information, see the VpcId
parameter description.String defaultSubnetId
VpcId
parameter. All instances
are launched into this subnet unless you specify otherwise when you
create the instance. If you also specify a value for
DefaultAvailabilityZone
, the subnet must be in that zone.
For information on default values and when this parameter is required,
see the VpcId
parameter description.String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
StackConfigurationManager configurationManager
ChefConfiguration chefConfiguration
ChefConfiguration
object that specifies whether to
enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For
more information, see Create
a New Stack.Boolean useCustomCookbooks
Boolean useOpsworksSecurityGroups
AWS OpsWorks provides a standard set of
built-in security groups, one for each layer, which are associated
with layers by default. With UseOpsworksSecurityGroups
you can instead provide your own custom security groups.
UseOpsworksSecurityGroups
has the following settings:
For more information, see Create a New Stack.
Source customCookbooksSource
String defaultSshKeyName
String defaultRootDeviceType
instance-store
. For more
information, see Storage
for the Root Device.
Constraints:
Allowed Values: ebs, instance-store
String stackId
DescribeStacks
.String iamUserArn
String sshUsername
my.name
will be changed to myname
. If you do not specify an SSH
user name, AWS OpsWorks generates one from the IAM user name.String sshPublicKey
Boolean allowSelfManagement
String iamUserArn
String appId
String layerId
String stackId
String iamUserArn
String deploymentId
String stackId
String appId
String createdAt
String completedAt
Integer duration
String iamUserArn
String comment
DeploymentCommand command
String status
String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
String name
For stacks, the following commands are available:
execute_recipes
: Execute one or more recipes. To
specify the recipes, set an Args
parameter named
recipes
to the list of recipes to be executed. For
example, to execute phpapp::appsetup
, set
Args
to
{"recipes":["phpapp::appsetup"]}
.install_dependencies
: Install the stack's
dependencies.update_custom_cookbooks
: Update
the stack's custom cookbooks.update_dependencies
: Update the stack's
dependencies.For apps, the following commands are available:
deploy
: Deploy an app. Rails apps
have an optional Args
parameter named
migrate
. Set Args
to {"migrate":["true"]} to
migrate the database. The default setting is
{"migrate":["false"]}.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
Map<K,V> args
{"arg_name":["value1", "value2", ...]}
String elasticIp
String rdsDbInstanceArn
String volumeId
String stackId
DescribeApps
returns a description of the apps in the specified stack.com.amazonaws.internal.ListWithAutoConstructFlag<T> appIds
DescribeApps
returns a description of the
specified apps. Otherwise, it returns a description of every app.com.amazonaws.internal.ListWithAutoConstructFlag<T> apps
App
objects that describe the specified apps.String deploymentId
DescribeCommands
returns a description of the commands
associated with the specified deployment.String instanceId
DescribeCommands
returns a description of the commands
associated with the specified instance.com.amazonaws.internal.ListWithAutoConstructFlag<T> commandIds
DescribeCommands
returns a description of the specified
commands. Otherwise, it returns a description of every command.com.amazonaws.internal.ListWithAutoConstructFlag<T> commands
Command
objects that describe each of the
specified commands.String stackId
DescribeDeployments
returns a description of the commands
associated with the specified stack.String appId
DescribeDeployments
returns a description of the commands
associated with the specified app.com.amazonaws.internal.ListWithAutoConstructFlag<T> deploymentIds
DescribeDeployments
returns a description of
the specified deployments. Otherwise, it returns a description of
every deployment.com.amazonaws.internal.ListWithAutoConstructFlag<T> deployments
Deployment
objects that describe the
deployments.String instanceId
DescribeElasticIps
returns a description of the Elastic
IP addresses associated with the specified instance.String stackId
DescribeElasticIps
returns a description of the Elastic
IP addresses that are registered with the specified stack.com.amazonaws.internal.ListWithAutoConstructFlag<T> ips
DescribeElasticIps
returns a description of
the specified Elastic IP addresses. Otherwise, it returns a
description of every Elastic IP address.com.amazonaws.internal.ListWithAutoConstructFlag<T> elasticIps
ElasticIps
object that describes the specified Elastic
IP addresses.String stackId
com.amazonaws.internal.ListWithAutoConstructFlag<T> layerIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> elasticLoadBalancers
ElasticLoadBalancer
objects that describe the
specified Elastic Load Balancing instances.String stackId
DescribeInstances
returns descriptions of the instances associated with the specified
stack.String layerId
DescribeInstances
returns descriptions of the instances associated with the specified
layer.com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
DescribeInstances
returns a description of the specified
instances. Otherwise, it returns a description of every instance.com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
Instance
objects that describe the instances.String stackId
com.amazonaws.internal.ListWithAutoConstructFlag<T> layerIds
DescribeLayers
returns a description
of every layer in the specified stack.com.amazonaws.internal.ListWithAutoConstructFlag<T> layers
Layer
objects that describe the layers.com.amazonaws.internal.ListWithAutoConstructFlag<T> layerIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBasedAutoScalingConfigurations
LoadBasedAutoScalingConfiguration
objects
that describe each layer's configuration.SelfUserProfile userProfile
UserProfile
object that describes the user's SSH
information.String iamUserArn
String stackId
com.amazonaws.internal.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.String instanceId
DescribeRaidArrays
returns descriptions of the RAID
arrays associated with the specified instance.String stackId
com.amazonaws.internal.ListWithAutoConstructFlag<T> raidArrayIds
DescribeRaidArrays
returns descriptions of the specified
arrays. Otherwise, it returns a description of every array.com.amazonaws.internal.ListWithAutoConstructFlag<T> raidArrays
RaidArrays
object that describes the specified RAID
arrays.String stackId
com.amazonaws.internal.ListWithAutoConstructFlag<T> rdsDbInstanceArns
com.amazonaws.internal.ListWithAutoConstructFlag<T> rdsDbInstances
RdsDbInstance
objects that describe the
instances.String stackId
DescribeServiceErrors
returns descriptions of the errors
associated with the specified stack.String instanceId
DescribeServiceErrors
returns descriptions of the errors
associated with the specified instance.com.amazonaws.internal.ListWithAutoConstructFlag<T> serviceErrorIds
DescribeServiceErrors
returns descriptions of the
specified errors. Otherwise, it returns a description of every error.com.amazonaws.internal.ListWithAutoConstructFlag<T> serviceErrors
ServiceError
objects that describe the
specified service errors.com.amazonaws.internal.ListWithAutoConstructFlag<T> stackIds
DescribeStacks
returns a description
of every stack.com.amazonaws.internal.ListWithAutoConstructFlag<T> stacks
Stack
objects that describe the stacks.String stackId
StackSummary stackSummary
StackSummary
object that contains the results.com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> timeBasedAutoScalingConfigurations
TimeBasedAutoScalingConfiguration
objects
that describe the configuration for the specified instances.com.amazonaws.internal.ListWithAutoConstructFlag<T> iamUserArns
com.amazonaws.internal.ListWithAutoConstructFlag<T> userProfiles
Users
object that describes the specified users.String instanceId
DescribeVolumes
returns descriptions of the volumes
associated with the specified instance.String stackId
String raidArrayId
DescribeVolumes
returns descriptions of the volumes
associated with the specified RAID array.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeIds
DescribeVolumes
returns descriptions of the specified
volumes. Otherwise, it returns a description of every volume.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumes
String elasticIp
String elasticLoadBalancerName
String region
String dnsName
String stackId
String layerId
String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> ec2InstanceIds
String key
String value
Boolean secure
Secure
to true
.
DescribeApps
then returns **Filtered**
instead of the actual value. The default value for Secure
is false
.String layerId
String instanceId
String ec2InstanceId
String virtualizationType
paravirtual
or
hvm
.
Constraints:
Allowed Values: paravirtual, hvm
String hostname
String stackId
com.amazonaws.internal.ListWithAutoConstructFlag<T> layerIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
String instanceType
String instanceProfileArn
String status
booting
connection_lost
online
rebooting
requested
running_setup
setup_failed
start_failed
stopped
terminated
terminating
String os
String amiId
String availabilityZone
String subnetId
String publicDns
String privateDns
String publicIp
String privateIp
String elasticIp
String autoScalingType
Constraints:
Allowed Values: load, timer
String sshKeyName
String sshHostRsaKeyFingerprint
String sshHostDsaKeyFingerprint
String createdAt
String lastServiceErrorId
String architecture
Constraints:
Allowed Values: x86_64, i386
String rootDeviceType
Constraints:
Allowed Values: ebs, instance-store
String rootDeviceVolumeId
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. We strongly recommend using the default value
of true
, to ensure that your instances have the latest
security updates.
Boolean ebsOptimized
Integer booting
booting
status.Integer connectionLost
connection_lost
status.Integer online
online
status.Integer pending
pending
status.Integer rebooting
rebooting
status.Integer requested
requested
status.Integer runningSetup
running_setup
status.Integer setupFailed
setup_failed
status.Integer shuttingDown
shutting_down
status.Integer startFailed
start_failed
status.Integer stopped
stopped
status.Integer stopping
stopping
status.Integer terminated
terminated
status.Integer terminating
terminating
status.String stackId
String layerId
String type
Constraints:
Allowed Values: java-app, lb, web, php-app, rails-app, nodejs-app, memcached, db-master, monitoring-master, custom
String name
String shortname
Map<K,V> attributes
String customInstanceProfileArn
com.amazonaws.internal.ListWithAutoConstructFlag<T> customSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> defaultSecurityGroupNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> packages
Package
objects that describe the layer's
packages.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeConfigurations
VolumeConfigurations
object that describes the layer's
Amazon EBS volumes.Boolean enableAutoHealing
Boolean autoAssignElasticIps
Boolean autoAssignPublicIps
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.String createdAt
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. We strongly recommend using the default value
of true
, to ensure that your instances have the latest
security updates.
Boolean useEbsOptimizedInstances
String layerId
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.String stackId
String iamUserArn
Boolean allowSsh
Boolean allowSudo
String level
deny
show
deploy
manage
iam_only
For more information on the permissions associated with these levels, see Managing User Permissions
String raidArrayId
String instanceId
String name
Integer raidLevel
Integer numberOfDisks
Integer size
String device
String mountPoint
String availabilityZone
String createdAt
String stackId
String volumeType
Integer iops
String rdsDbInstanceArn
String dbInstanceIdentifier
String dbUser
String dbPassword
String region
String address
String engine
String stackId
Boolean missingOnRds
true
if AWS OpsWorks was unable to discover the
Amazon RDS instance. AWS OpsWorks attempts to discover the instance
only once. If this value is set to true
, you must
deregister the instance and then register it again.String instanceId
com.amazonaws.internal.ListWithAutoConstructFlag<T> setup
setup
event.com.amazonaws.internal.ListWithAutoConstructFlag<T> configure
configure
event.com.amazonaws.internal.ListWithAutoConstructFlag<T> deploy
deploy
event.com.amazonaws.internal.ListWithAutoConstructFlag<T> undeploy
undeploy
event.com.amazonaws.internal.ListWithAutoConstructFlag<T> shutdown
shutdown
event.String elasticIp
String volumeId
String layerId
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.String stackId
String iamUserArn
Boolean allowSsh
Boolean allowSudo
String level
deny
show
deploy
manage
iam_only
For more information on the permissions associated with these levels, see Managing User Permissions
String instanceId
WeeklyAutoScalingSchedule autoScalingSchedule
AutoScalingSchedule
with the instance schedule.String type
Constraints:
Allowed Values: git, svn, archive, s3
String url
String username
Username
to the appropriate IAM access key
ID.Username
to the user name.String password
String sshKey
String revision
String stackId
String name
String arn
String region
String vpcId
Map<K,V> attributes
String serviceRoleArn
String defaultInstanceProfileArn
String defaultOs
Amazon Linux
, Ubuntu 12.04 LTS
, or
Ubuntu 14.04 LTS
. The default option is Amazon
Linux
.String hostnameTheme
String defaultAvailabilityZone
String defaultSubnetId
String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
StackConfigurationManager configurationManager
ChefConfiguration chefConfiguration
ChefConfiguration
object that specifies whether to
enable Berkshelf and the Berkshelf version. For more information, see
Create
a New Stack.Boolean useCustomCookbooks
Boolean useOpsworksSecurityGroups
Source customCookbooksSource
String defaultSshKeyName
String createdAt
String defaultRootDeviceType
Constraints:
Allowed Values: ebs, instance-store
String stackId
String name
String arn
Integer layersCount
Integer appsCount
InstancesCount instancesCount
InstancesCount
object with the number of instances in
each status.String instanceId
String stackId
String instanceId
String stackId
String instanceId
WeeklyAutoScalingSchedule autoScalingSchedule
WeeklyAutoScalingSchedule
object with the instance
schedule.String volumeId
String appId
String name
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> dataSources
String type
Constraints:
Allowed Values: java, rails, php, nodejs, static, other
Source appSource
Source
object that specifies the app repository.com.amazonaws.internal.ListWithAutoConstructFlag<T> domains
'www.example.com, example.com'
Boolean enableSsl
SslConfiguration sslConfiguration
SslConfiguration
object with the SSL configuration.Map<K,V> attributes
com.amazonaws.internal.ListWithAutoConstructFlag<T> environment
EnvironmentVariable
objects that specify
environment variables to be associated with the app. You can specify
up to ten environment variables. After you deploy the app, these
variables are defined on the associated app server instances.
String instanceId
com.amazonaws.internal.ListWithAutoConstructFlag<T> layerIds
String instanceType
String autoScalingType
Constraints:
Allowed Values: load, timer
String hostname
String os
Amazon
Linux
, Ubuntu 12.04 LTS
, or Ubuntu 14.04
LTS
.Custom
The 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.
String amiId
String sshKeyName
String architecture
Constraints:
Allowed Values: x86_64, i386
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. We strongly
recommend using the default value of true
, to ensure that
your instances have the latest security updates.
Boolean ebsOptimized
String layerId
String name
String shortname
Map<K,V> attributes
String customInstanceProfileArn
com.amazonaws.internal.ListWithAutoConstructFlag<T> customSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> packages
Package
objects that describe the layer's
packages.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeConfigurations
VolumeConfigurations
object that describes the layer's
Amazon EBS volumes.Boolean enableAutoHealing
Boolean autoAssignElasticIps
Boolean autoAssignPublicIps
Recipes customRecipes
LayerCustomRecipes
object that specifies the layer's
custom recipes.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. We strongly
recommend using the default value of true
, to ensure that
your instances have the latest security updates.
Boolean useEbsOptimizedInstances
String sshPublicKey
String stackId
String name
Map<K,V> attributes
String serviceRoleArn
You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the stack's current service role ARN, if you prefer, but you must do so explicitly.
String defaultInstanceProfileArn
String defaultOs
Amazon Linux
, Ubuntu 12.04 LTS
, or
Ubuntu 14.04 LTS
. The default option is Amazon
Linux
.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: Baked_Goods
Clouds
European_Cities
Fruits
Greek_Deities
Legendary_Creatures_from_Japan
Planets_and_Moons
Roman_Deities
Scottish_Islands
US_Cities
Wild_Cats
To obtain a generated host
name, call GetHostNameSuggestion
, which returns a host
name based on the current theme.
String defaultAvailabilityZone
DefaultSubnetId
, the subnet must be in the same zone. For
more information, see CreateStack.String defaultSubnetId
VpcId
parameter. All instances
are launched into this subnet unless you specify otherwise when you
create the instance. If you also specify a value for
DefaultAvailabilityZone
, the subnet must be in that zone.
For information on default values and when this parameter is required,
see the VpcId
parameter description.String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
StackConfigurationManager configurationManager
ChefConfiguration chefConfiguration
ChefConfiguration
object that specifies whether to
enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For
more information, see Create
a New Stack.Boolean useCustomCookbooks
Source customCookbooksSource
String defaultSshKeyName
String defaultRootDeviceType
Constraints:
Allowed Values: ebs, instance-store
Boolean useOpsworksSecurityGroups
AWS OpsWorks provides a standard set of
built-in security groups, one for each layer, which are associated
with layers by default. UseOpsworksSecurityGroups
allows
you to instead provide your own custom security groups.
UseOpsworksSecurityGroups
has the following settings:
For more information, see Create a New Stack.
String iamUserArn
String sshUsername
my.name
will be changed to myname
. If you do not specify an SSH
user name, AWS OpsWorks generates one from the IAM user name.String sshPublicKey
Boolean allowSelfManagement
String iamUserArn
String name
String sshUsername
String sshPublicKey
Boolean allowSelfManagement
String volumeId
String ec2VolumeId
String name
String raidArrayId
String instanceId
String status
Integer size
String device
String mountPoint
String region
String availabilityZone
String volumeType
Integer iops
String mountPoint
Integer raidLevel
Integer numberOfDisks
Integer size
String volumeType
Integer iops
Map<K,V> monday
Map<K,V> tuesday
Map<K,V> wednesday
Map<K,V> thursday
Map<K,V> friday
Map<K,V> saturday
Map<K,V> sunday
String subscriptionName
String sourceIdentifier
Constraints:
DBInstanceIdentifier
must be supplied.DBSecurityGroupName
must be supplied.DBParameterGroupName
must be supplied.DBSnapshotIdentifier
must
be supplied.String resourceName
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBSecurityGroupName
String cIDRIP
String eC2SecurityGroupName
EC2SecurityGroupId
must be provided. Otherwise,
EC2SecurityGroupOwnerId and either EC2SecurityGroupName
or EC2SecurityGroupId
must be provided.String eC2SecurityGroupId
EC2SecurityGroupId
must be provided. Otherwise,
EC2SecurityGroupOwnerId and either EC2SecurityGroupName
or EC2SecurityGroupId
must be provided.String eC2SecurityGroupOwnerId
EC2SecurityGroupId
must be provided. Otherwise,
EC2SecurityGroupOwnerId and either EC2SecurityGroupName
or EC2SecurityGroupId
must be provided.String sourceDBSnapshotIdentifier
Constraints:
Example:
rds:mydb-2012-04-02-00-01
Example:
arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805
String targetDBSnapshotIdentifier
Constraints:
Example: my-db-snapshot
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBInstanceIdentifier
String sourceDBInstanceIdentifier
Constraints:
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.
String availabilityZone
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
Integer port
Default: Inherits from the source DB instance
Valid Values:
1150-65535
Boolean autoMinorVersionUpgrade
Default: Inherits from the source DB instance
Integer iops
String optionGroupName
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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBSubnetGroupName
If there is no DB Subnet Group, then it is a non-VPC DB instance.
Constraints: All the cross region read replicas that share the source instance should lie within the same VPC.
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.
String dBInstanceIdentifier
Constraints:
Example:
mydbinstance
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)
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
String engine
Valid Values: MySQL
| oracle-se1
|
oracle-se
| oracle-ee
|
sqlserver-ee
| sqlserver-se
|
sqlserver-ex
| sqlserver-web
String masterUsername
MySQL
Constraints:
Type: String
Oracle
Constraints:
SQL Server
Constraints:
String masterUserPassword
Type: String
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
SQL Server
Constraints: Must contain from 8 to 128 characters.
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
Default: The default DB security group for the database engine.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Default: The default EC2 VPC security group for the DB subnet group's VPC.
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.
String dBSubnetGroupName
If there is no DB subnet group, then it is a non-VPC DB instance.
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.
String dBParameterGroupName
Constraints:
Integer backupRetentionPeriod
Default: 1
Constraints:
String preferredBackupWindow
BackupRetentionPeriod
parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for 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.
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
.
Boolean multiAZ
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
Boolean autoMinorVersionUpgrade
Default:
true
String licenseModel
Valid values:
license-included
| bring-your-own-license
|
general-public-license
Integer iops
Constraints: Must be an integer greater than 1000.
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
String characterSetName
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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBParameterGroupName
Constraints:
String dBParameterGroupFamily
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBSecurityGroupName
Constraints:
Example: mysecuritygroup
String dBSecurityGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBSnapshotIdentifier
Constraints:
Example: my-snapshot-id
String dBInstanceIdentifier
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".
Example:
mySubnetgroup
String dBSubnetGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String subscriptionName
Constraints: The name must be less than 255 characters.
String snsTopicArn
String sourceType
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceIds
Constraints:
DBInstanceIdentifier
must
be supplied.DBSecurityGroupName
must be supplied.DBParameterGroupName
must be supplied.DBSnapshotIdentifier
must
be supplied.Boolean enabled
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String optionGroupName
Constraints:
Example:
myoptiongroup
String engineName
String majorEngineVersion
String optionGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String engine
String engineVersion
String dBParameterGroupFamily
String dBEngineDescription
String dBEngineVersionDescription
CharacterSet defaultCharacterSet
CharacterSetName
parameter of the CreateDBInstance
API is not specified.com.amazonaws.internal.ListWithAutoConstructFlag<T> supportedCharacterSets
CharacterSetName
parameter of the CreateDBInstance API.String dBInstanceIdentifier
String dBInstanceClass
String engine
String dBInstanceStatus
String masterUsername
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. Not shown when the returned parameters do not apply to an Oracle DB instance.
Endpoint endpoint
Integer allocatedStorage
Date instanceCreateTime
String preferredBackupWindow
BackupRetentionPeriod
.Integer backupRetentionPeriod
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBParameterGroups
String availabilityZone
DBSubnetGroup dBSubnetGroup
String preferredMaintenanceWindow
PendingModifiedValues pendingModifiedValues
Date latestRestorableTime
Boolean multiAZ
String engineVersion
Boolean autoMinorVersionUpgrade
String readReplicaSourceDBInstanceIdentifier
com.amazonaws.internal.ListWithAutoConstructFlag<T> readReplicaDBInstanceIdentifiers
String licenseModel
Integer iops
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupMemberships
String characterSetName
String secondaryAvailabilityZone
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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> statusInfos
String statusType
Boolean normal
String status
String message
String dBParameterGroupName
String dBParameterGroupFamily
String description
String ownerId
String dBSecurityGroupName
String dBSecurityGroupDescription
String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> eC2SecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> iPRanges
String dBSnapshotIdentifier
String dBInstanceIdentifier
Date snapshotCreateTime
String engine
Integer allocatedStorage
String status
Integer port
String availabilityZone
String vpcId
Date instanceCreateTime
String masterUsername
String engineVersion
String licenseModel
String snapshotType
Integer iops
String optionGroupName
Integer percentProgress
String sourceRegion
String dBSubnetGroupName
String dBSubnetGroupDescription
String vpcId
String subnetGroupStatus
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
String dBInstanceIdentifier
Constraints:
Boolean skipFinalSnapshot
true
is specified, no DBSnapshot
is created. If false
is specified, a DB snapshot is
created before the DB instance is deleted. Specify
true
when deleting a read replica. false
.
Default:
false
String finalDBSnapshotIdentifier
false
. Constraints:
String dBParameterGroupName
Constraints:
String dBSecurityGroupName
Constraints:
String dBSnapshotIdentifier
Constraints: Must be the name of an
existing DB snapshot in the available
state.
String dBSubnetGroupName
Constraints:
String subscriptionName
String optionGroupName
String engine
String engineVersion
Example: 5.1.49
String dBParameterGroupFamily
Constraints:
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
String marker
MaxRecords
.Boolean defaultOnly
Boolean listSupportedCharacterSets
String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBEngineVersions
DBEngineVersion
elements.String dBInstanceIdentifier
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
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
String marker
MaxRecords
.String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBInstances
String dBInstanceIdentifier
Constraints:
String filenameContains
Long fileLastWritten
Long fileSize
Integer maxRecords
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> describeDBLogFiles
String marker
String dBParameterGroupName
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
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
String marker
DescribeDBParameterGroups
request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords
.String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBParameterGroups
String dBParameterGroupName
Constraints:
String source
Default: All parameter types returned
Valid Values: user | system | engine-default
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
String marker
DescribeDBParameters
request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
String marker
MaxRecords
.String dBSecurityGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
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
String marker
MaxRecords
.String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
String dBInstanceIdentifier
DBSnapshotIdentifier
.
This parameter is not case sensitive. Constraints:
String dBSnapshotIdentifier
DBInstanceIdentifier
. This value is
stored as a lowercase string. Constraints:
SnapshotType
parameter must also be specified.String snapshotType
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
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
String marker
DescribeDBSnapshots
request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords
.String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSnapshots
String dBSubnetGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
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
String marker
MaxRecords
.String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSubnetGroups
String dBParameterGroupFamily
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
String marker
DescribeEngineDefaultParameters
request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.String sourceType
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategoriesMapList
String sourceIdentifier
Constraints:
DBInstance
, then a DBInstanceIdentifier
must
be supplied.DBSecurityGroup
, a DBSecurityGroupName
must
be supplied.DBParameterGroup
, a DBParameterGroupName
must be supplied.DBSnapshot
, a DBSnapshotIdentifier
must be
supplied.String sourceType
Constraints:
Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot
Date startTime
Example: 2009-07-08T18:00Z
Date endTime
Example: 2009-07-08T18:00Z
Integer duration
Default: 60
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
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
String marker
MaxRecords
.String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String subscriptionName
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
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
String marker
MaxRecords
.String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> eventSubscriptionsList
String engineName
String majorEngineVersion
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
String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupOptions
String marker
MaxRecords
.String optionGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
String marker
MaxRecords
.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
String engineName
String majorEngineVersion
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupsList
String marker
MaxRecords
.String engine
String engineVersion
String dBInstanceClass
String licenseModel
Boolean vpc
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
String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> orderableDBInstanceOptions
String marker
MaxRecords
.String reservedDBInstancesOfferingId
Example:
438012d3-4052-4cc7-b2e3-8d3372e0e706
String dBInstanceClass
String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
String productDescription
String offeringType
Valid
Values: "Light Utilization" | "Medium Utilization" | "Heavy
Utilization"
Boolean multiAZ
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
String marker
MaxRecords
.String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedDBInstancesOfferings
String reservedDBInstanceId
String reservedDBInstancesOfferingId
String dBInstanceClass
String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
String productDescription
String offeringType
Valid
Values: "Light Utilization" | "Medium Utilization" | "Heavy
Utilization"
Boolean multiAZ
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
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
String marker
MaxRecords
.String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedDBInstances
String dBInstanceIdentifier
Constraints:
String logFileName
String marker
Integer numberOfLines
String logFileData
String marker
Boolean additionalDataPending
String status
String eC2SecurityGroupName
String eC2SecurityGroupId
String eC2SecurityGroupOwnerId
EC2SecurityGroupName
field.String dBParameterGroupFamily
String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
String sourceIdentifier
String sourceType
Constraints:
Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot
String message
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
Date date
String sourceType
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
String customerAwsId
String custSubscriptionId
String snsTopicArn
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.
String subscriptionCreationTime
String sourceType
com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceIdsList
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategoriesList
Boolean enabled
String filterName
com.amazonaws.internal.ListWithAutoConstructFlag<T> filterValue
String resourceName
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
String dBInstanceIdentifier
Constraints:
Integer allocatedStorage
ApplyImmediately
parameter
is set to true
for this request. MySQL
Default: Uses existing setting
Valid Values: 5-1024
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
Oracle
Default: Uses existing setting
Valid Values: 10-1024
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
SQL Server
Cannot be modified.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
String dBInstanceClass
Passing
a value for this parameter causes an outage during the change and is
applied during the next maintenance window, unless the
ApplyImmediately
parameter is specified as
true
for this request.
Default: Uses existing setting
Valid Values: db.t1.micro | db.m1.small | db.m1.medium |
db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge |
db.m2.4xlarge
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Constraints:
Boolean applyImmediately
PreferredMaintenanceWindow
setting for
the DB instance. If this parameter is passed as
false
, changes to the DB instance are applied on the next
call to RebootDBInstance, the next maintenance reboot, or the
next failure reboot, whichever occurs first. See each parameter to
determine when a change is applied.
Default: false
String masterUserPassword
Changing this parameter
does not result in an outage and the change is asynchronously applied
as soon as possible. Between the time of the request and the
completion of the request, the MasterUserPassword
element
exists in the PendingModifiedValues
element of the
operation response.
Default: Uses existing setting
Constraints:
Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric
characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).
String dBParameterGroupName
ApplyImmediately
parameter is set to true
for this request. Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
Integer backupRetentionPeriod
Changing this parameter can result in
an outage if you change from 0 to a non-zero value or from a non-zero
value to 0. These changes are applied during the next maintenance
window unless the ApplyImmediately
parameter is set to
true
for this request. If you change the parameter from
one non-zero value to another non-zero value, the change is
asynchronously applied as soon as possible.
Default: Uses existing setting
Constraints:
String preferredBackupWindow
BackupRetentionPeriod
. Changing this parameter does not
result in an outage and the change is asynchronously applied as soon
as possible. Constraints:
String preferredMaintenanceWindow
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
Boolean multiAZ
ApplyImmediately
parameter is set to true
for this request. Constraints: Cannot be specified if the DB instance is a read replica.
String engineVersion
ApplyImmediately
parameter is set to true
for this request. For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
Example:
5.1.42
Boolean allowMajorVersionUpgrade
Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
Boolean autoMinorVersionUpgrade
true
during the
maintenance window, and a newer minor version is available, and RDS
has enabled auto patching for that engine version.Integer iops
ApplyImmediately
parameter is set to true
for this request. Default: Uses existing setting
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
String optionGroupName
ApplyImmediately
parameter
is set to true
for this request. If the parameter change
results in an option group that enables OEM, this change can cause a
brief (sub-second) period during which new connections are rejected
but existing connections are not interrupted. 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
String newDBInstanceIdentifier
Constraints:
String dBParameterGroupName
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
Valid Values (for
the application method): immediate | pending-reboot
String dBParameterGroupName
String dBSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".
Example:
mySubnetgroup
String dBSubnetGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
String subscriptionName
String snsTopicArn
String sourceType
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
Boolean enabled
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsToInclude
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsToRemove
Boolean applyImmediately
String optionName
String optionDescription
Boolean persistent
Boolean permanent
Integer port
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroupMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupMemberships
String optionName
Integer port
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroupMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
String optionGroupName
String optionGroupDescription
String engineName
String majorEngineVersion
com.amazonaws.internal.ListWithAutoConstructFlag<T> options
Boolean allowsVpcAndNonVpcInstanceMemberships
String vpcId
String name
String description
String engineName
String majorEngineVersion
String minimumRequiredMinorEngineVersion
Boolean portRequired
Integer defaultPort
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsDependedOn
Boolean persistent
Boolean permanent
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupOptionSettings
String settingName
String settingDescription
String defaultValue
String applyType
String allowedValues
Boolean isModifiable
String name
String value
String defaultValue
String description
String applyType
String dataType
String allowedValues
Boolean isModifiable
Boolean isCollection
String engine
String engineVersion
String dBInstanceClass
String licenseModel
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Boolean multiAZCapable
Boolean readReplicaCapable
Boolean vpc
String parameterName
String parameterValue
String description
String source
String applyType
String dataType
String allowedValues
Boolean isModifiable
true
) or not (false
) the
parameter can be modified. Some parameters have security or
operational implications that prevent them from being changed.String minimumEngineVersion
String applyMethod
Constraints:
Allowed Values: immediate, pending-reboot
String dBInstanceClass
DBInstanceClass
for the DB instance that
will be applied or is in progress.Integer allocatedStorage
AllocatedStorage
size for the DB
instance that will be applied or is in progress.String masterUserPassword
Integer port
Integer backupRetentionPeriod
Boolean multiAZ
String engineVersion
Integer iops
String dBInstanceIdentifier
DBInstanceIdentifier
for the DB instance
that will be applied or is in progress.String dBInstanceIdentifier
Constraints:
Example:
Integer backupRetentionPeriod
Default: 1
Constraints:
String preferredBackupWindow
BackupRetentionPeriod
parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for 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.
String reservedDBInstancesOfferingId
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
String reservedDBInstanceId
Example: myreservationID
Integer dBInstanceCount
Default: 1
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBInstanceIdentifier
Constraints:
Boolean forceFailover
true
, the reboot will be conducted through a MultiAZ
failover. Constraint: You cannot specify true
if the
instance is not configured for MultiAZ.
String subscriptionName
String sourceIdentifier
String resourceName
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
String reservedDBInstanceId
String reservedDBInstancesOfferingId
String dBInstanceClass
Date startTime
Integer duration
Double fixedPrice
Double usagePrice
String currencyCode
Integer dBInstanceCount
String productDescription
String offeringType
Boolean multiAZ
String state
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String reservedDBInstancesOfferingId
String dBInstanceClass
Integer duration
Double fixedPrice
Double usagePrice
String currencyCode
String productDescription
String offeringType
Boolean multiAZ
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String dBParameterGroupName
Constraints:
Boolean resetAllParameters
true
) or not (false
) to
reset all parameters in the DB parameter group to default values.
Default: true
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
MySQL
Valid Values (for Apply method): immediate
|
pending-reboot
You can use the immediate value with
dynamic parameters only. You can use the pending-reboot
value for both dynamic and static parameters, and changes are applied
when DB instance reboots.
Oracle
Valid Values (for Apply
method): pending-reboot
String dBParameterGroupName
String dBInstanceIdentifier
Constraints:
String dBSnapshotIdentifier
Constraints:
Example: my-snapshot-id
String dBInstanceClass
Valid Values: db.t1.micro | db.m1.small | db.m1.medium |
db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge
Integer port
Default: The same port as the original DB instance
Constraints: Value must
be 1150-65535
String availabilityZone
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if
the MultiAZ parameter is set to true
.
Example:
us-east-1a
String dBSubnetGroupName
Boolean multiAZ
Constraint:
You cannot specify the AvailabilityZone parameter if the MultiAZ
parameter is set to true
.
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.
Boolean autoMinorVersionUpgrade
String licenseModel
Default: Same as source.
Valid values: license-included
|
bring-your-own-license
|
general-public-license
String dBName
This parameter doesn't apply to the MySQL engine.
String engine
Default: The same as source
Constraint: Must be compatible with the engine of the source
Example: oracle-ee
Integer iops
Constraints: Must be an integer greater than 1000.
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String sourceDBInstanceIdentifier
Constraints:
String targetDBInstanceIdentifier
Constraints:
Date restoreTime
Valid Values: Value must be a UTC time
Constraints:
Example:
2009-09-07T23:45:00Z
Boolean useLatestRestorableTime
true
) or not (false
) the
DB instance is restored from the latest backup time. Default:
false
Constraints: Cannot be specified if RestoreTime parameter is provided.
String dBInstanceClass
Valid Values: db.t1.micro | db.m1.small | db.m1.medium |
db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge
Default: The same DBInstanceClass as the original DB instance.
Integer port
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
String availabilityZone
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Example:
us-east-1a
String dBSubnetGroupName
Boolean multiAZ
Constraint:
You cannot specify the AvailabilityZone parameter if the MultiAZ
parameter is set to true
.
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.
Boolean autoMinorVersionUpgrade
String licenseModel
Default: Same as source.
Valid values: license-included
|
bring-your-own-license
|
general-public-license
String dBName
This parameter is not used for the MySQL engine.
String engine
Default: The same as source
Constraint: Must be compatible with the engine of the source
Example: oracle-ee
Integer iops
Constraints: Must be an integer greater than 1000.
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBSecurityGroupName
String cIDRIP
CIDRIP
is specified, EC2SecurityGroupName
,
EC2SecurityGroupId
and
EC2SecurityGroupOwnerId
cannot be provided.String eC2SecurityGroupName
EC2SecurityGroupId
must be provided.
Otherwise, EC2SecurityGroupOwnerId and either
EC2SecurityGroupName
or EC2SecurityGroupId
must be provided.String eC2SecurityGroupId
EC2SecurityGroupId
must be provided.
Otherwise, EC2SecurityGroupOwnerId and either
EC2SecurityGroupName
or EC2SecurityGroupId
must be provided.String eC2SecurityGroupOwnerId
EC2SecurityGroupName
parameter. The AWS
Access Key ID is not an acceptable value. For VPC DB security groups,
EC2SecurityGroupId
must be provided. Otherwise,
EC2SecurityGroupOwnerId and either EC2SecurityGroupName
or EC2SecurityGroupId
must be provided.String subnetIdentifier
AvailabilityZone subnetAvailabilityZone
This data type is used as an element in the following data type:
String subnetStatus
String key
String value
String accountId
String clusterSecurityGroupName
String cIDRIP
String eC2SecurityGroupName
String eC2SecurityGroupOwnerId
Example: 111122223333
String snapshotIdentifier
String snapshotClusterIdentifier
String accountWithRestoreAccess
String name
String clusterIdentifier
String nodeType
String clusterStatus
available
, creating
, deleting
,
rebooting
, renaming
, and
resizing
.String modifyStatus
String masterUsername
String dBName
Endpoint endpoint
Date clusterCreateTime
Integer automatedSnapshotRetentionPeriod
com.amazonaws.internal.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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterParameterGroups
String clusterSubnetGroupName
String vpcId
String availabilityZone
String preferredMaintenanceWindow
PendingModifiedValues pendingModifiedValues
String clusterVersion
Boolean allowVersionUpgrade
true
, version upgrades will be applied automatically
to the cluster during the maintenance window.Integer numberOfNodes
Boolean publiclyAccessible
true
, the cluster can be accessed from a public
network.Boolean encrypted
true
, data in the cluster is encrypted at rest.RestoreStatus restoreStatus
HsmStatus hsmStatus
Values: active, applying
ClusterSnapshotCopyStatus clusterSnapshotCopyStatus
String clusterPublicKey
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterNodes
ElasticIpStatus elasticIpStatus
String clusterRevisionNumber
String parameterGroupName
String parameterGroupFamily
String description
String clusterSecurityGroupName
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> eC2SecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> iPRanges
String destinationRegion
Long retentionPeriod
String clusterSubnetGroupName
String description
String vpcId
String subnetGroupStatus
Complete
, Incomplete
and
Invalid
.com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
String sourceSnapshotIdentifier
Constraints:
available
.String sourceSnapshotClusterIdentifier
Constraints:
String targetSnapshotIdentifier
Constraints:
String parameterGroupName
Constraints:
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".
String description
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 Database Developer Guide.
Default: dev
Constraints:
String clusterIdentifier
Constraints:
Example: myexamplecluster
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
String nodeType
Valid Values: dw1.xlarge
|
dw1.8xlarge
| dw2.large
|
dw2.8xlarge
.
String masterUsername
Constraints:
String masterUserPassword
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterSecurityGroups
Default: The default cluster security group for Amazon Redshift.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Default: The default VPC security group is associated with the cluster.
String clusterSubnetGroupName
If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
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.
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.
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:
Integer automatedSnapshotRetentionPeriod
Default: 1
Constraints: Must be a value from 0 to 35.
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
String clusterVersion
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
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
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.
Boolean publiclyAccessible
true
, the cluster can be accessed from a public
network.Boolean encrypted
true
, the data in the cluster is encrypted at rest.
Default: false
String hsmClientCertificateIdentifier
String hsmConfigurationIdentifier
String elasticIp
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Management Guide.
String clusterSecurityGroupName
Constraints:
Example:
examplesecuritygroup
String description
String snapshotIdentifier
Constraints:
Example:
my-snapshot-id
String clusterIdentifier
String clusterSubnetGroupName
Constraints:
Example:
examplesubnetgroup
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
String subscriptionName
Constraints:
String snsTopicArn
String sourceType
Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.
com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceIds
Example: my-cluster-1, my-cluster-2
Example: my-snapshot-20131010
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
Values: Configuration, Management, Monitoring, Security
String severity
Values: ERROR, INFO
Boolean enabled
true
to activate the
subscription, set to false
to create the subscription but
not active it.String hsmClientCertificateIdentifier
String hsmConfigurationIdentifier
String description
String hsmIpAddress
String hsmPartitionName
String hsmPartitionPassword
String hsmServerPublicCertificate
String parameterGroupFamily
String marker
Marker
parameter and retrying the
command. If the Marker
field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
String parameterGroupName
Constraints:
String clusterIdentifier
Constraints:
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
String finalClusterSnapshotIdentifier
false
.
Constraints:
String clusterSecurityGroupName
String snapshotIdentifier
Constraints: Must be the name of an existing snapshot that is in
the available
state.
String snapshotClusterIdentifier
Constraints: Must be the name of valid cluster.
String clusterSubnetGroupName
String subscriptionName
String hsmClientCertificateIdentifier
String hsmConfigurationIdentifier
String parameterGroupName
Integer maxRecords
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords
, AWS returns a value in the
Marker
field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker
parameter and retrying the request.String marker
Marker
parameter and retrying the
command. If the Marker
field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterGroups
String parameterGroupName
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
Integer maxRecords
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords
, AWS returns a value in the
Marker
field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker
parameter and retrying the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
String marker
Marker
parameter and retrying the
command. If the Marker
field is empty, all response
records have been retrieved for the request.String clusterSecurityGroupName
Example:
securitygroup1
Integer maxRecords
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords
, AWS returns a value in the
Marker
field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker
parameter and retrying the request. Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.
String marker
Marker
parameter and retrying the
command. If the Marker
field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterSecurityGroups
String clusterIdentifier
String snapshotIdentifier
String snapshotType
Valid Values:
automated
| manual
Date startTime
Example: 2012-07-16T18:00:00Z
Date endTime
Example: 2012-07-16T18:00:00Z
Integer maxRecords
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords
, AWS returns a value in the
Marker
field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker
parameter and retrying the request.String ownerAccount
String marker
Marker
parameter and retrying the
command. If the Marker
field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshots
String clusterIdentifier
The default is that all clusters defined for an account are returned.
Integer maxRecords
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords
, AWS
returns a value in the Marker
field of the response. You
can retrieve the next set of response records by providing the
returned marker value in the Marker
parameter and
retrying the request. Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.
String marker
Marker
parameter and retrying the
command. If the Marker
field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> clusters
String clusterSubnetGroupName
Integer maxRecords
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords
, AWS returns a value in the
Marker
field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker
parameter and retrying the request.String marker
Marker
parameter and retrying the
command. If the Marker
field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterSubnetGroups
String clusterVersion
Example: 1.0
String clusterParameterGroupFamily
Constraints:
Integer maxRecords
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords
, AWS returns a value in the
Marker
field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker
parameter and retrying the request.String marker
Marker
parameter and retrying the
command. If the Marker
field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterVersions
Version
elements.String parameterGroupFamily
Integer maxRecords
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords
, AWS returns a value in the
Marker
field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker
parameter and retrying the request.String sourceType
Valid values: cluster, snapshot, parameter group, and security group.
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategoriesMapList
String sourceIdentifier
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
cluster
.cluster-security-group
.cluster-parameter-group
.cluster-snapshot
.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
Date startTime
Example: 2009-07-08T18:00Z
Date endTime
Example: 2009-07-08T18:00Z
Integer duration
Default: 60
Integer maxRecords
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords
, AWS
returns a value in the Marker
field of the response. You
can retrieve the next set of response records by providing the
returned marker value in the Marker
parameter and
retrying the request.String marker
Marker
parameter and retrying the
command. If the Marker
field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String subscriptionName
Integer maxRecords
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords
, AWS returns a value in the
Marker
field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker
parameter and retrying the request.String marker
Marker
parameter and retrying the
command. If the Marker
field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> eventSubscriptionsList
String hsmClientCertificateIdentifier
Integer maxRecords
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords
, AWS returns a value in the
Marker
field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker
parameter and retrying the request.String marker
Marker
parameter and retrying the
command. If the Marker
field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> hsmClientCertificates
String hsmConfigurationIdentifier
Integer maxRecords
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords
, AWS returns a value in the
Marker
field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker
parameter and retrying the request.String marker
Marker
parameter and retrying the
command. If the Marker
field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> hsmConfigurations
String clusterIdentifier
Example: examplecluster
Boolean loggingEnabled
true
if logging is on, false
if logging is
off.String bucketName
String s3KeyPrefix
Date lastSuccessfulDeliveryTime
Date lastFailureTime
String lastFailureMessage
String clusterVersion
Default: All versions.
Constraints: Must be one of the version returned from DescribeClusterVersions.
String nodeType
Integer maxRecords
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords
, AWS returns a value in the
Marker
field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker
parameter and retrying the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> orderableClusterOptions
String marker
Marker
parameter and retrying the
command. If the Marker
field is empty, all response
records have been retrieved for the request.String reservedNodeOfferingId
Integer maxRecords
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords
, AWS returns a value in the
Marker
field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker
parameter and retrying the request.String marker
Marker
parameter and retrying the
command. If the Marker
field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedNodeOfferings
String reservedNodeId
Integer maxRecords
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords
, AWS returns a value in the
Marker
field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker
parameter and retrying the request.String marker
Marker
parameter and retrying the
command. If the Marker
field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedNodes
String clusterIdentifier
By default, resize operations for all clusters defined for an AWS account are returned.
String targetNodeType
Integer targetNumberOfNodes
String targetClusterType
Valid
Values: multi-node
| single-node
String status
Valid Values: NONE
| IN_PROGRESS
| FAILED
|
SUCCEEDED
com.amazonaws.internal.ListWithAutoConstructFlag<T> importTablesCompleted
Valid Values: List of table names.
com.amazonaws.internal.ListWithAutoConstructFlag<T> importTablesInProgress
Valid Values: List of table names.
com.amazonaws.internal.ListWithAutoConstructFlag<T> importTablesNotStarted
Valid Values: List of table names
Double avgResizeRateInMegaBytesPerSecond
Long totalResizeDataInMegaBytes
Long progressInMegaBytes
Long elapsedTimeInSeconds
Long estimatedTimeToCompletionInSeconds
String clusterIdentifier
Example: examplecluster
Boolean loggingEnabled
true
if logging is on, false
if logging is
off.String bucketName
String s3KeyPrefix
Date lastSuccessfulDeliveryTime
Date lastFailureTime
String lastFailureMessage
String clusterIdentifier
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
String clusterIdentifier
Example: examplecluster
String bucketName
Constraints:
String s3KeyPrefix
Constraints:
Boolean loggingEnabled
true
if logging is on, false
if logging is
off.String bucketName
String s3KeyPrefix
Date lastSuccessfulDeliveryTime
Date lastFailureTime
String lastFailureMessage
String clusterIdentifier
Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.
String destinationRegion
Constraints: Must be the name of a valid region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
Integer retentionPeriod
Default: 7.
Constraints: Must be at least 1 and no more than 35.
String sourceIdentifier
String sourceType
Constraints:
Allowed Values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot
String message
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
String severity
Values: ERROR, INFO
Date date
String eventId
String sourceType
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String eventId
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
String eventDescription
String severity
Values: ERROR, INFO
String customerAwsId
String custSubscriptionId
String snsTopicArn
String status
Constraints:
Date subscriptionCreationTime
String sourceType
com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceIdsList
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategoriesList
Values: Configuration, Management, Monitoring, Security
String severity
Values: ERROR, INFO
Boolean enabled
true
indicates the subscription is enabled.String hsmClientCertificateIdentifier
String hsmClientCertificatePublicKey
String hsmConfigurationIdentifier
String description
String hsmIpAddress
String hsmPartitionName
String hsmClientCertificateIdentifier
String hsmConfigurationIdentifier
String status
Values: active, applying
String parameterGroupName
com.amazonaws.internal.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.
For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
String parameterGroupName
String parameterGroupStatus
String clusterIdentifier
Example:
examplecluster
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
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: dw1.xlarge
|
dw1.8xlarge
| dw2.large
|
dw2.8xlarge
.
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
.
com.amazonaws.internal.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:
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
String masterUserPassword
MasterUserPassword
element exists in the
PendingModifiedValues
element of the operation response.
Default: Uses existing setting.
Constraints:
String clusterParameterGroupName
Default: Uses existing setting.
Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.
Integer automatedSnapshotRetentionPeriod
If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.
Default: Uses existing setting.
Constraints: Must be a value from 0 to 35.
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.
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
Boolean allowVersionUpgrade
true
, upgrades will be applied automatically to the
cluster during the maintenance window. Default: false
String hsmClientCertificateIdentifier
String hsmConfigurationIdentifier
String newClusterIdentifier
Constraints:
Example: examplecluster
String clusterSubnetGroupName
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
String subscriptionName
String snsTopicArn
String sourceType
Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.
com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceIds
Example: my-cluster-1, my-cluster-2
Example: my-snapshot-20131010
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
Values: Configuration, Management, Monitoring, Security
String severity
Values: ERROR, INFO
Boolean enabled
true
indicates the subscription is enabledString clusterIdentifier
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
Integer retentionPeriod
If you decrease the retention period for automated snapshots that are copied to a destination region, Amazon Redshift will delete any existing automated snapshots that were copied to the destination region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35.
String clusterVersion
String clusterType
multi-node
.String nodeType
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
String parameterName
String parameterValue
String description
String source
String dataType
String allowedValues
Boolean isModifiable
true
, the parameter can be modified. Some parameters
have security or operational implications that prevent them from being
changed.String minimumEngineVersion
String masterUserPassword
String nodeType
Integer numberOfNodes
String clusterType
String clusterVersion
Integer automatedSnapshotRetentionPeriod
String clusterIdentifier
String clusterIdentifier
String reservedNodeId
String reservedNodeOfferingId
String nodeType
Date startTime
Integer duration
Double fixedPrice
Double usagePrice
String currencyCode
Integer nodeCount
String state
Possible Values:
String offeringType
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String reservedNodeOfferingId
String nodeType
Integer duration
Double fixedPrice
Double usagePrice
String currencyCode
String offeringType
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String parameterGroupName
Boolean resetAllParameters
true
, all parameters in the specified parameter group
will be reset to their default values. Default: true
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
Constraints: A maximum of 20 parameters can be reset in a single request.
String parameterGroupName
String parameterGroupStatus
String clusterIdentifier
Constraints:
String snapshotIdentifier
Example:
my-snapshot-id
String snapshotClusterIdentifier
Integer port
Default: The same port as the original cluster.
Constraints: Must be between
1115
and 65535
.
String availabilityZone
Default: A random, system-chosen Availability Zone.
Example:
us-east-1a
Boolean allowVersionUpgrade
true
, upgrades can be applied during the maintenance
window to the Amazon Redshift engine that is running on the cluster.
Default: true
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.
Boolean publiclyAccessible
true
, the cluster can be accessed from a public
network.String ownerAccount
String hsmClientCertificateIdentifier
String hsmConfigurationIdentifier
String elasticIp
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:
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterSecurityGroups
Default: The default cluster security group for Amazon Redshift.
Cluster security groups only apply to clusters outside of VPCs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Default: The default VPC security group is associated with the cluster.
VPC security groups only apply to clusters in VPCs.
String preferredMaintenanceWindow
Format:
ddd:hh24:mi-ddd:hh24:mi
Default: The value selected for the cluster from which the snapshot was taken. 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.
Integer automatedSnapshotRetentionPeriod
Default: The value selected for the cluster from which the snapshot was taken.
Constraints: Must be a value from 0 to 35.
String status
Double currentRestoreRateInMegaBytesPerSecond
Long snapshotSizeInMegaBytes
Long progressInMegaBytes
Long elapsedTimeInSeconds
Long estimatedTimeToCompletionInSeconds
String clusterSecurityGroupName
String cIDRIP
CIDRIP
is specified, EC2SecurityGroupName
and EC2SecurityGroupOwnerId
cannot be provided.String eC2SecurityGroupName
EC2SecurityGroupName
is specified,
EC2SecurityGroupOwnerId
must also be provided and
CIDRIP
cannot be provided.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
String snapshotIdentifier
String snapshotClusterIdentifier
String accountWithRestoreAccess
String clusterIdentifier
Constraints: Must be the name of valid cluster that has encryption enabled.
String snapshotIdentifier
String clusterIdentifier
Date snapshotCreateTime
String status
Integer port
String availabilityZone
Date clusterCreateTime
String masterUsername
String clusterVersion
String snapshotType
String nodeType
Integer numberOfNodes
String dBName
String vpcId
Boolean encrypted
true
, the data in the snapshot is encrypted at rest.Boolean encryptedWithHSM
true
indicates that
the data is encrypted using HSM keys.com.amazonaws.internal.ListWithAutoConstructFlag<T> accountsWithRestoreAccess
null
if no accounts are authorized.
Visible only to the snapshot owner.String ownerAccount
Double totalBackupSizeInMegaBytes
Double actualIncrementalBackupSizeInMegaBytes
Double backupProgressInMegaBytes
Double currentBackupRateInMegaBytesPerSecond
0
for a completed backup.Long estimatedSecondsToCompletion
0
for a completed backup.Long elapsedTimeInSeconds
String sourceRegion
String subnetIdentifier
AvailabilityZone subnetAvailabilityZone
String subnetStatus
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
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
Boolean evaluateTargetHealth
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide.
String action
Valid values: CREATE
|
DELETE
| UPSERT
Constraints:
Allowed Values: CREATE, DELETE, UPSERT
ResourceRecordSet resourceRecordSet
String comment
Constraints:
Length: 0 - 256
com.amazonaws.internal.ListWithAutoConstructFlag<T> changes
Change
element for each
resource record set that you want to create or delete.
Constraints:
Length: 1 -
String id
Constraints:
Length: 0 - 32
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
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.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
String hostedZoneId
Constraints:
Length: 0 - 32
ChangeBatch changeBatch
Changes
element.ChangeInfo changeInfo
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
String resourceType
healthcheck
.
Constraints:
Allowed Values: healthcheck
String resourceId
Constraints:
Length: 0 - 64
com.amazonaws.internal.ListWithAutoConstructFlag<T> addTags
Tag
elements. Each
Tag
element identifies a tag that you want to add or
update for the specified resource.
Constraints:
Length: 1 - 10
com.amazonaws.internal.ListWithAutoConstructFlag<T> removeTagKeys
Tag
keys that you want to remove from the
specified resource.
Constraints:
Length: 1 - 10
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
HealthCheck healthCheck
String location
Constraints:
Length: 0 - 1024
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
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
HostedZone hostedZone
ChangeInfo changeInfo
DelegationSet delegationSet
String location
Constraints:
Length: 0 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> nameServers
NameServer
that is
assigned to your hosted zone.
Constraints:
Length: 1 -
String healthCheckId
Constraints:
Length: 0 - 64
ChangeInfo changeInfo
String continentCode
Valid values: AF
|
AN
| AS
| EU
| OC
| NA
| SA
Constraint: Specifying
ContinentCode
with either CountryCode
or
SubdivisionCode
returns an InvalidInput error.
Constraints:
Length: 2 - 2
String countryCode
The default geo location uses a *
for
the country code. All other country codes follow the ISO 3166
two-character code.
Constraints:
Length: 1 - 2
String subdivisionCode
Constraint: Specifying SubdivisionCode
without
CountryCode
returns an InvalidInput error.
Constraints:
Length: 1 - 3
String continentCode
Constraints:
Length: 2 - 2
String continentName
ContinentCode
is also present.
Constraints:
Length: 1 - 32
String countryCode
The default geo location uses a *
for
the country code. All other country codes follow the ISO 3166
two-character code.
Constraints:
Length: 1 - 2
String countryName
CountryCode
is also present.
Constraints:
Length: 1 - 64
String subdivisionCode
Constraints:
Length: 1 - 3
String subdivisionName
SubdivisionCode
is also present.
Constraints:
Length: 1 - 64
String id
ChangeResourceRecordSets
returned in the
Id element when you submitted the request.
Constraints:
Length: 0 - 32
ChangeInfo changeInfo
com.amazonaws.internal.ListWithAutoConstructFlag<T> checkerIpRanges
String continentCode
Valid values: AF
|
AN
| AS
| EU
| OC
| NA
| SA
Constraint: Specifying
ContinentCode
with either CountryCode
or
SubdivisionCode
returns an InvalidInput error.
Constraints:
Length: 2 - 2
String countryCode
The default geo location uses a *
for
the country code. All other country codes follow the ISO 3166
two-character code.
Constraints:
Length: 1 - 2
String subdivisionCode
Constraint: Specifying SubdivisionCode
without
CountryCode
returns an InvalidInput error.
Constraints:
Length: 1 - 3
GeoLocationDetails geoLocationDetails
Long healthCheckCount
String healthCheckId
Constraints:
Length: 0 - 64
HealthCheck healthCheck
String id
Constraints:
Length: 0 - 32
HostedZone hostedZone
DelegationSet delegationSet
String id
Constraints:
Length: 0 - 64
String callerReference
Constraints:
Length: 1 - 64
HealthCheckConfig healthCheckConfig
Long healthCheckVersion
UpdateHealthCheck
to prevent overwriting
another change to the health check.
Constraints:
Range: 1 -
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])$
Integer port
Constraints:
Range: 1 - 65535
String type
Constraints:
Allowed Values: HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP
String resourcePath
Constraints:
Length: 0 - 255
String fullyQualifiedDomainName
Constraints:
Length: 0 - 255
String searchString
Constraints:
Length: 0 - 255
Integer requestInterval
Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
Constraints:
Range: 10 - 30
Integer failureThreshold
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Constraints:
Range: 1 - 10
String id
Constraints:
Length: 0 - 32
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
String callerReference
Constraints:
Length: 1 - 128
HostedZoneConfig config
Comment
element.Long resourceRecordSetCount
String comment
HostedZoneConfig
and
Comment
elements from the XML document.
Constraints:
Length: 0 - 256
String startContinentCode
ListGeoLocations
request to
list. For non-continent geo locations, this should be null. Valid
values: AF
| AN
| AS
|
EU
| OC
| NA
| SA
Constraint: Specifying ContinentCode
with either
CountryCode
or SubdivisionCode
returns an
InvalidInput error.
Constraints:
Length: 2 - 2
String startCountryCode
ListGeoLocations
request to list.
The default geo location uses a *
for the country
code. All other country codes follow the ISO 3166 two-character code.
Constraints:
Length: 1 - 2
String startSubdivisionCode
ListGeoLocations
request to
list. Constraint: Specifying SubdivisionCode
without
CountryCode
returns an InvalidInput error.
Constraints:
Length: 1 - 3
String maxItems
com.amazonaws.internal.ListWithAutoConstructFlag<T> geoLocationDetailsList
Boolean isTruncated
Valid
Values: true
| false
String nextContinentCode
Constraints:
Length: 2 - 2
String nextCountryCode
Constraints:
Length: 1 - 2
String nextSubdivisionCode
Constraints:
Length: 1 - 3
String maxItems
MaxItems
is 100.String marker
NextMarker
from the last
response in the marker
parameter to get the next page of
results.
Constraints:
Length: 0 - 64
String maxItems
com.amazonaws.internal.ListWithAutoConstructFlag<T> healthChecks
String marker
NextMarker
from the last
response in the marker
parameter to get the next page of
results.
Constraints:
Length: 0 - 64
Boolean isTruncated
Marker
element.
Valid Values: true
| false
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
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.String marker
NextMarker
from the last
response in the marker
parameter to get the next page of
results.
Constraints:
Length: 0 - 64
String maxItems
com.amazonaws.internal.ListWithAutoConstructFlag<T> hostedZones
String marker
NextMarker
from the last
response in the marker
parameter to get the next page of
results.
Constraints:
Length: 0 - 64
Boolean isTruncated
Marker
element.
Valid Values: true
| false
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
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.String hostedZoneId
Constraints:
Length: 0 - 32
String startRecordName
ListResourceRecordSets
request to list.
Constraints:
Length: 0 - 1024
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
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
String maxItems
com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceRecordSets
Boolean isTruncated
Valid
Values: true
| false
String nextRecordName
Constraints:
Length: 0 - 1024
String nextRecordType
Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA
String nextRecordIdentifier
SetIdentifier
for the next resource record set that has the current DNS name and
type.
Constraints:
Length: 1 - 128
String maxItems
MaxItems
is 100.ResourceTagSet resourceTagSet
ResourceTagSet
containing tags associated with the
specified resource.String resourceType
healthcheck
.
Constraints:
Allowed Values: healthcheck
com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceIds
Constraints:
Length: 1 - 10
com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceTagSets
ResourceTagSet
s containing tags associated with
the specified resources.String value
Value
element for the current resource
record set.
Constraints:
Length: 0 - 4000
String name
Constraints:
Length: 0 - 1024
String type
Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA
String setIdentifier
Constraints:
Length: 1 - 128
Long weight
Constraints:
Range: 0 - 255
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, cn-north-1
GeoLocation geoLocation
String failover
Valid values: PRIMARY
|
SECONDARY
Constraints:
Allowed Values: PRIMARY, SECONDARY
Long tTL
Constraints:
Range: 0 - 2147483647
com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceRecords
Constraints:
Length: 1 -
AliasTarget aliasTarget
String healthCheckId
Constraints:
Length: 0 - 64
String resourceType
healthcheck
.
Constraints:
Allowed Values: healthcheck
String resourceId
Constraints:
Length: 0 - 64
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Constraints:
Length: 1 - 10
String healthCheckId
Constraints:
Length: 0 - 64
Long healthCheckVersion
HealthCheckVersion
lets you prevent overwriting
another change to the health check.
Constraints:
Range: 1 -
String iPAddress
Specify this value only if you want to change it.
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])$
Integer port
Specify this value only if you want to change it.
Constraints:
Range: 1 - 65535
String resourcePath
Specify this value only if you want to change it.
Constraints:
Length: 0 - 255
String fullyQualifiedDomainName
Specify this value only if you want to change it.
Constraints:
Length: 0 - 255
String searchString
Type
is HTTP_STR_MATCH
or
HTTP_STR_MATCH
, the string that you want Route 53 to
search for in the response body from the specified resource. If the
string appears in the response body, Route 53 considers the resource
healthy. Specify this value only if you want to change it.
Constraints:
Length: 0 - 255
Integer failureThreshold
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Specify this value only if you want to change it.
Constraints:
Range: 1 - 10
HealthCheck healthCheck
String domainName
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
String idnLangCode
Constraints:
Length: 0 - 3
String availability
You
can only register domains designated as AVAILABLE
.
Type: String
Valid values:
AVAILABLE
??? The domain name is available.AVAILABLE_RESERVED
??? The domain name is reserved
under specific conditions.AVAILABLE_PREORDER
??? The domain name is available and can be preordered.UNAVAILABLE
??? The domain name is not
available.UNAVAILABLE_PREMIUM
??? The domain
name is not available.UNAVAILABLE_RESTRICTED
??? The domain name is forbidden.RESERVED
???
The domain name has been reserved for another person or
organization.
Constraints:
Allowed Values: AVAILABLE, AVAILABLE_RESERVED, AVAILABLE_PREORDER, UNAVAILABLE, UNAVAILABLE_PREMIUM, UNAVAILABLE_RESTRICTED, RESERVED
String firstName
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents:
RegistrantContact
, AdminContact
,
TechContact
Required: Yes
Constraints:
Length: 0 - 255
String lastName
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact
,
AdminContact
, TechContact
Required: Yes
Constraints:
Length: 0 - 255
String contactType
PERSON
, you must enter an organization name, and you
can't enable privacy protection for the contact. Type: String
Default: None
Constraints: Maximum 255 characters.
Valid
values: PERSON
| COMPANY
|
ASSOCIATION
| PUBLIC_BODY
Parents:
RegistrantContact
, AdminContact
,
TechContact
Required: Yes
Constraints:
Allowed Values: PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER
String organizationName
PERSON
. Type: String
Default: None
Constraints:
Maximum 255 characters. Contact type must not be PERSON
.
Parents: RegistrantContact
, AdminContact
,
TechContact
Required: No
Constraints:
Length: 0 - 255
String addressLine1
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents:
RegistrantContact
, AdminContact
,
TechContact
Required: Yes
Constraints:
Length: 0 - 255
String addressLine2
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents:
RegistrantContact
, AdminContact
,
TechContact
Required: No
Constraints:
Length: 0 - 255
String city
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents:
RegistrantContact
, AdminContact
,
TechContact
Required: Yes
Constraints:
Length: 0 - 255
String state
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents:
RegistrantContact
, AdminContact
,
TechContact
Required: No
Constraints:
Length: 0 - 255
String countryCode
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents:
RegistrantContact
, AdminContact
,
TechContact
Required: Yes
Constraints:
Allowed Values: AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GH, GI, GL, GM, GN, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, ID, IE, IL, IM, IN, IQ, IR, IS, IT, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PT, PW, PY, QA, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
String zipCode
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents:
RegistrantContact
, AdminContact
,
TechContact
Required: No
Constraints:
Length: 0 - 255
String phoneNumber
Type: String
Default: None
Constraints: Phone number must be specified in the format
"+[country dialing code].[number including any area code>]". For
example, a US phone number might appear as
"+1.1234567890"
.
Parents:
RegistrantContact
, AdminContact
,
TechContact
Required: Yes
Constraints:
Length: 0 - 30
String email
Type: String
Default: None
Constraints: Maximum 254 characters.
Parents:
RegistrantContact
, AdminContact
,
TechContact
Required: Yes
Constraints:
Length: 0 - 254
String fax
Type: String
Default: None
Constraints: Phone number must be specified in the format
"+[country dialing code].[number including any area code]". For
example, a US phone number might appear as
"+1.1234567890"
.
Parents:
RegistrantContact
, AdminContact
,
TechContact
Required: No
Constraints:
Length: 0 - 30
com.amazonaws.internal.ListWithAutoConstructFlag<T> extraParams
Type: Complex
Default: None
Parents:
RegistrantContact
, AdminContact
,
TechContact
Children: Name
,
Value
Required: No
String domainName
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
String operationId
Type: String
Default: None
Constraints: Maximum 255 characters.
Constraints:
Length: 0 - 255
String domainName
Type: String
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
Boolean autoRenew
Type: Boolean
Valid values: True
|
False
Boolean transferLock
Type: Boolean
Valid values: True
|
False
Date expiry
Type: Long
String domainName
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
String operationId
Type: String
Default: None
Constraints: Maximum 255 characters.
Constraints:
Length: 0 - 255
String name
Type: String
Default: None
Valid values:
DUNS_NUMBER
| BRAND_NUMBER
|
BIRTH_DEPARTMENT
| BIRTH_DATE_IN_YYYY_MM_DD
| BIRTH_COUNTRY
| BIRTH_CITY
|
DOCUMENT_NUMBER
| AU_ID_NUMBER
|
AU_ID_TYPE
| CA_LEGAL_TYPE
|
FI_BUSINESS_NUMBER
| FI_ID_NUMBER
|
IT_PIN
| RU_PASSPORT_DATA
|
SE_ID_NUMBER
| SG_ID_NUMBER
|
VAT_NUMBER
Parent: ExtraParams
Required: Yes
Constraints:
Allowed Values: DUNS_NUMBER, BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, BIRTH_CITY, DOCUMENT_NUMBER, AU_ID_NUMBER, AU_ID_TYPE, CA_LEGAL_TYPE, FI_BUSINESS_NUMBER, FI_ID_NUMBER, IT_PIN, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER
String value
Type: String
Default: None
Constraints: Maximum 2048 characters.
Parent:
ExtraParams
Required: Yes
Constraints:
Length: 0 - 2048
String domainName
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
String domainName
Type: String
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> nameservers
Type: String
Boolean autoRenew
Type: Boolean
ContactDetail adminContact
Type: Complex
Children: FirstName
, MiddleName
,
LastName
, ContactType
,
OrganizationName
, AddressLine1
,
AddressLine2
, City
, State
,
CountryCode
, ZipCode
,
PhoneNumber
, Email
, Fax
,
ExtraParams
ContactDetail registrantContact
Type: Complex
Children: FirstName
, MiddleName
,
LastName
, ContactType
,
OrganizationName
, AddressLine1
,
AddressLine2
, City
, State
,
CountryCode
, ZipCode
,
PhoneNumber
, Email
, Fax
,
ExtraParams
ContactDetail techContact
Type: Complex
Children: FirstName
, MiddleName
,
LastName
, ContactType
,
OrganizationName
, AddressLine1
,
AddressLine2
, City
, State
,
CountryCode
, ZipCode
,
PhoneNumber
, Email
, Fax
,
ExtraParams
Boolean adminPrivacy
true
, WHOIS
("who is") queries will return contact information for our registrar
partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Boolean registrantPrivacy
true
, WHOIS
("who is") queries will return contact information for our registrar
partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Boolean techPrivacy
true
, WHOIS
("who is") queries will return contact information for our registrar
partner, Gandi, instead of the contact information that you enter.
Type: Boolean
String registrarName
"GANDI SAS"
. Type: String
String whoIsServer
Type: String
String registrarUrl
Type: String
String abuseContactEmail
Type: String
Constraints:
Length: 0 - 254
String abuseContactPhone
Type: String
Constraints:
Length: 0 - 30
String registryDomainId
Date creationDate
Date updatedDate
Date expirationDate
String reseller
"Amazon"
as the reseller.
Type: String
String dnsSec
com.amazonaws.internal.ListWithAutoConstructFlag<T> statusList
ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, transferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars use this same set of status codes.
For a current list of domain name status
codes and an explanation of what each code means, go to the ICANN website and search for
epp status codes
. (Search on the ICANN website; web
searches sometimes return an old version of the document.)
Type: Array of String
String operationId
Type: String
Default: None
Required: Yes
Constraints:
Length: 0 - 255
String operationId
Type: String
Constraints:
Length: 0 - 255
String status
Type: String
Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, ERROR, SUCCESSFUL, FAILED
String message
Type: String
String domainName
Type: String
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
String type
Type: String
Constraints:
Allowed Values: REGISTER_DOMAIN, DELETE_DOMAIN, TRANSFER_IN_DOMAIN, UPDATE_DOMAIN_CONTACT, UPDATE_NAMESERVER, CHANGE_PRIVACY_PROTECTION, DOMAIN_LOCK
Date submittedDate
String marker
MaxItems
, you can use Marker
to return
additional domains. Get the value of NextPageMarker
from
the previous response, and submit another request that includes the
value of NextPageMarker
in the Marker
element. Type: String
Default: None
Constraints: The marker must match the value specified in the previous request.
Required: No
Constraints:
Length: 0 - 4096
Integer maxItems
Type: Integer
Default: 20
Constraints: A numeral between 1 and 100.
Required: No
Constraints:
Range: 0 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> domains
Type: Complex type containing a list of domain summaries.
Children: AutoRenew
,
DomainName
, Expiry
,
TransferLock
String nextPageMarker
MaxItems
in the request, submit another request and include the value of
NextPageMarker
in the value of Marker
.
Type: String
Parent: Operations
Constraints:
Length: 0 - 4096
String marker
MaxItems
, you can use
Marker
to return additional operations. Get the value of
NextPageMarker
from the previous response, and submit
another request that includes the value of NextPageMarker
in the Marker
element. Type: String
Default: None
Required: No
Constraints:
Length: 0 - 4096
Integer maxItems
Type: Integer
Default: 20
Constraints: A value between 1 and 100.
Required: No
Constraints:
Range: 0 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> operations
Type: Complex type containing a list of operation summaries
Children: OperationId
,
Status
, SubmittedDate
, Type
String nextPageMarker
MaxItems
in the request, submit another request and
include the value of NextPageMarker
in the value of
Marker
. Type: String
Parent:
Operations
Constraints:
Length: 0 - 4096
String name
Type: String
Constraint: Maximum 255 characterss
Parent:
Nameservers
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> glueIps
Type: List of IP addresses.
Constraints: The list can contain only one IPv4 and one IPv6 address.
Parent:
Nameservers
String operationId
Type: String
Constraints:
Length: 0 - 255
String status
Type: String
Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, ERROR, SUCCESSFUL, FAILED
String type
Type: String
Valid values:
REGISTER_DOMAIN
| DELETE_DOMAIN
|
TRANSFER_IN_DOMAIN
| UPDATE_DOMAIN_CONTACT
|
UPDATE_NAMESERVER
|
CHANGE_PRIVACY_PROTECTION
| DOMAIN_LOCK
Constraints:
Allowed Values: REGISTER_DOMAIN, DELETE_DOMAIN, TRANSFER_IN_DOMAIN, UPDATE_DOMAIN_CONTACT, UPDATE_NAMESERVER, CHANGE_PRIVACY_PROTECTION, DOMAIN_LOCK
Date submittedDate
String domainName
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
String idnLangCode
Constraints:
Length: 0 - 3
Integer durationInYears
Type: Integer
Default: 1
Valid values: Integer from 1 to 10
Required: Yes
Constraints:
Range: 1 - 10
Boolean autoRenew
true
) or not (false
). Autorenewal only
takes effect after the account is charged. Type: Boolean
Valid
values: true
| false
Default:
true
Required: No
ContactDetail adminContact
Type: Complex
Children:
FirstName
, MiddleName
,
LastName
, ContactType
,
OrganizationName
, AddressLine1
,
AddressLine2
, City
, State
,
CountryCode
, ZipCode
,
PhoneNumber
, Email
, Fax
,
ExtraParams
Required: Yes
ContactDetail registrantContact
Type: Complex
Children:
FirstName
, MiddleName
,
LastName
, ContactType
,
OrganizationName
, AddressLine1
,
AddressLine2
, City
, State
,
CountryCode
, ZipCode
,
PhoneNumber
, Email
, Fax
,
ExtraParams
Required: Yes
ContactDetail techContact
Type: Complex
Children:
FirstName
, MiddleName
,
LastName
, ContactType
,
OrganizationName
, AddressLine1
,
AddressLine2
, City
, State
,
CountryCode
, ZipCode
,
PhoneNumber
, Email
, Fax
,
ExtraParams
Required: Yes
Boolean privacyProtectAdminContact
Type: Boolean
Default:
true
Valid values: true
|
false
Required: No
Boolean privacyProtectRegistrantContact
Type: Boolean
Default:
true
Valid values: true
|
false
Required: No
Boolean privacyProtectTechContact
Type: Boolean
Default:
true
Valid values: true
|
false
Required: No
String operationId
Type: String
Default: None
Constraints: Maximum 255 characters.
Constraints:
Length: 0 - 255
String domainName
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
String authCode
Type: String
Constraints:
Length: 0 - 1024
String domainName
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
String idnLangCode
Constraints:
Length: 0 - 3
Integer durationInYears
Type: Integer
Default: 1
Valid values: Integer from 1 to 10
Required: Yes
Constraints:
Range: 1 - 10
com.amazonaws.internal.ListWithAutoConstructFlag<T> nameservers
Type: Complex
Children: GlueIps
, Name
String authCode
Type: String
Required: Yes
Constraints:
Length: 0 - 1024
Boolean autoRenew
Type: Boolean
Valid values: true
|
false
Default: true
Required: No
ContactDetail adminContact
Type: Complex
Children:
FirstName
, MiddleName
,
LastName
, ContactType
,
OrganizationName
, AddressLine1
,
AddressLine2
, City
, State
,
CountryCode
, ZipCode
,
PhoneNumber
, Email
, Fax
,
ExtraParams
Required: Yes
ContactDetail registrantContact
Type: Complex
Children:
FirstName
, MiddleName
,
LastName
, ContactType
,
OrganizationName
, AddressLine1
,
AddressLine2
, City
, State
,
CountryCode
, ZipCode
,
PhoneNumber
, Email
, Fax
,
ExtraParams
Required: Yes
ContactDetail techContact
Type: Complex
Children:
FirstName
, MiddleName
,
LastName
, ContactType
,
OrganizationName
, AddressLine1
,
AddressLine2
, City
, State
,
CountryCode
, ZipCode
,
PhoneNumber
, Email
, Fax
,
ExtraParams
Required: Yes
Boolean privacyProtectAdminContact
Type: Boolean
Default:
true
Valid values: true
|
false
Required: No
Boolean privacyProtectRegistrantContact
Type: Boolean
Default:
true
Valid values: true
|
false
Required: No
Boolean privacyProtectTechContact
Type: Boolean
Default:
true
Valid values: true
|
false
Required: No
String operationId
Type: String
Default: None
Constraints: Maximum 255 characters.
Constraints:
Length: 0 - 255
String domainName
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
Boolean adminPrivacy
Type: Boolean
Default: None
Valid
values: true
| false
Required: No
Boolean registrantPrivacy
Type: Boolean
Default: None
Valid
values: true
| false
Required: No
Boolean techPrivacy
Type: Boolean
Default: None
Valid
values: true
| false
Required: No
String operationId
Type: String
Default: None
Constraints: Maximum 255 characters.
Constraints:
Length: 0 - 255
String domainName
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
ContactDetail adminContact
Type: Complex
Children:
FirstName
, MiddleName
,
LastName
, ContactType
,
OrganizationName
, AddressLine1
,
AddressLine2
, City
, State
,
CountryCode
, ZipCode
,
PhoneNumber
, Email
, Fax
,
ExtraParams
Required: Yes
ContactDetail registrantContact
Type: Complex
Children:
FirstName
, MiddleName
,
LastName
, ContactType
,
OrganizationName
, AddressLine1
,
AddressLine2
, City
, State
,
CountryCode
, ZipCode
,
PhoneNumber
, Email
, Fax
,
ExtraParams
Required: Yes
ContactDetail techContact
Type: Complex
Children:
FirstName
, MiddleName
,
LastName
, ContactType
,
OrganizationName
, AddressLine1
,
AddressLine2
, City
, State
,
CountryCode
, ZipCode
,
PhoneNumber
, Email
, Fax
,
ExtraParams
Required: Yes
String operationId
Type: String
Default: None
Constraints: Maximum 255 characters.
Constraints:
Length: 0 - 255
String domainName
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> nameservers
Type: Complex
Children: Name
, GlueIps
Required: Yes
String operationId
Type: String
Default: None
Constraints: Maximum 255 characters.
Constraints:
Length: 0 - 255
String extendedRequestId
PauseStatus status
String assumedRoleId
Constraints:
Length: 2 - 96
Pattern: [\w+=,.@:-]*
String arn
Constraints:
Length: 20 - 2048
String roleArn
Constraints:
Length: 20 - 2048
String roleSessionName
AssumedRoleUser
.
Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*
String policy
The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole in Using Temporary Security Credentials.
Constraints:
Length: 1 - 2048
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
Integer durationSeconds
Constraints:
Range: 900 - 3600
String externalId
Constraints:
Length: 2 - 96
Pattern: [\w+=,.@:-]*
String serialNumber
AssumeRole
call. Specify this
value if the trust policy of the role being assumed includes a
condition that requires MFA authentication. The value is either the
serial number for a hardware device (such as
GAHT12345678
) or an Amazon Resource Name (ARN) for a
virtual device (such as
arn:aws:iam::123456789012:mfa/user
).
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
String tokenCode
TokenCode
value is missing or expired, the
AssumeRole
call returns an "access denied" error.
Constraints:
Length: 6 - 6
Pattern: [\d]*
Credentials credentials
AssumedRoleUser assumedRoleUser
RoleSessionName
that
you specified when you called AssumeRole
.Integer packedPolicySize
Constraints:
Range: 0 -
String roleArn
Constraints:
Length: 20 - 2048
String principalArn
Constraints:
Length: 20 - 2048
String sAMLAssertion
For more information, see Configuring a Relying Party and Adding Claims in the Using IAM guide.
Constraints:
Length: 4 - 50000
String policy
The policy parameter is optional. If
you pass a policy, the temporary security credentials that are
returned by the operation have the permissions that are allowed by
both the access policy of the role that is being assumed,
and the policy that you pass. This gives you a way to
further restrict the permissions for the resulting temporary security
credentials. You cannot use the passed policy to grant permissions
that are in excess of those allowed by the access policy of the role
that is being assumed. For more information, see Permissions
for AssumeRoleWithSAML in Using Temporary Security
Credentials.
Constraints:
Length: 1 - 2048
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
Integer durationSeconds
NotOnOrAfter
value.
The actual expiration time is whichever value is shorter.
Constraints:
Range: 900 - 129600
Credentials credentials
AssumedRoleUser assumedRoleUser
Integer packedPolicySize
Constraints:
Range: 0 -
String subject
String subjectType
String issuer
String audience
String nameQualifier
String roleArn
Constraints:
Length: 20 - 2048
String roleSessionName
AssumedRoleUser
response element.
Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*
String webIdentityToken
AssumeRoleWithWebIdentity
call.
Constraints:
Length: 4 - 2048
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
String policy
The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRoleWithWebIdentity in Using Temporary Security Credentials.
Constraints:
Length: 1 - 2048
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
Integer durationSeconds
Constraints:
Range: 900 - 129600
Credentials credentials
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
.Integer packedPolicySize
Constraints:
Range: 0 -
String provider
iss
field. For OAuth 2.0 Access Tokens, this contains the value of the
ProviderId
parameter that was passed in the
AssumeRoleWithWebIdentity
request.String audience
String accessKeyId
Constraints:
Length: 16 - 32
Pattern: [\w]*
String secretAccessKey
String sessionToken
Date expiration
String encodedMessage
Constraints:
Length: 1 - 10240
String decodedMessage
DecodeAuthorizationMessage
.String federatedUserId
Constraints:
Length: 2 - 96
Pattern: [\w+=,.@\:-]*
String arn
Constraints:
Length: 20 - 2048
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+=,.@-]*
String policy
GetFederationToken
call and evaluated along with the
policy or policies that are attached to the IAM user whose credentials
are used to call GetFederationToken
. The passed policy is
used to scope down the permissions that are available to the IAM user,
by allowing only a subset of the permissions that are granted to the
IAM user. The passed policy cannot grant more permissions than those
granted to the IAM user. The final permissions for the federated user
are the most restrictive set based on the intersection of the passed
policy and the IAM user policy. If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.
For more information about how permissions work, see Permissions for GetFederationToken in Using Temporary Security Credentials.
Constraints:
Length: 1 - 2048
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
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-based policies, such as an Amazon S3 bucket policy.Integer packedPolicySize
Constraints:
Range: 0 -
Integer durationSeconds
Constraints:
Range: 900 - 129600
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+=/:,.@-]*
String tokenCode
Constraints:
Length: 6 - 6
Pattern: [\d]*
Credentials credentials
Float boxUsage
String domainName
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String domainName
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String domainName
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
String domainName
String itemName
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
UpdateCondition expected
String domainName
String domainName
Integer itemCount
Long itemNamesSizeBytes
Integer attributeNameCount
Long attributeNamesSizeBytes
Integer attributeValueCount
Long attributeValuesSizeBytes
Integer timestamp
Float boxUsage
String domainName
String itemName
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeNames
Boolean consistentRead
true
, any data previously
written to SimpleDB will be returned. Otherwise, results will be
consistent eventually, and the client may not see data that was
written immediately before your read.com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
String name
String alternateNameEncoding
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainNames
String nextToken
MaxNumberOfDomains
still available.Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
String domainName
String itemName
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
UpdateCondition expected
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
Float boxUsage
String selectExpression
String nextToken
ItemNames
.Boolean consistentRead
true
, any data previously
written to SimpleDB will be returned. Otherwise, results will be
consistent eventually, and the client may not see data that was
written immediately before your read.com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String nextToken
MaxNumberOfItems
were matched, the response size exceeded
1 megabyte, or the execution time exceeded 5 seconds.Float boxUsage
String name
String value
Exists
parameter is equal to true
.Boolean exists
true
if the attribute must exist for
the update condition to be satisfied. Specify false
if
the attribute should not exist in order for the update condition to be
satisfied.Content text
Content html
String identity
String emailAddress
com.amazonaws.internal.ListWithAutoConstructFlag<T> toAddresses
com.amazonaws.internal.ListWithAutoConstructFlag<T> ccAddresses
com.amazonaws.internal.ListWithAutoConstructFlag<T> bccAddresses
com.amazonaws.internal.ListWithAutoConstructFlag<T> identities
com.amazonaws.internal.ListWithAutoConstructFlag<T> identities
com.amazonaws.internal.ListWithAutoConstructFlag<T> identities
Double max24HourSend
Double maxSendRate
Double sentLast24Hours
com.amazonaws.internal.ListWithAutoConstructFlag<T> sendDataPoints
Boolean dkimEnabled
String dkimVerificationStatus
Constraints:
Allowed Values: Pending, Success, Failed, TemporaryFailure, NotStarted
com.amazonaws.internal.ListWithAutoConstructFlag<T> dkimTokens
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
String bounceTopic
String complaintTopic
String deliveryTopic
Boolean forwardingEnabled
true
indicates that Amazon SES
will forward bounce and complaint notifications as email, while
false
indicates that bounce and complaint notifications
will be published only to the specified bounce and complaint Amazon
SNS topics.String verificationStatus
Constraints:
Allowed Values: Pending, Success, Failed, TemporaryFailure, NotStarted
String verificationToken
String identityType
Constraints:
Allowed Values: EmailAddress, Domain
String nextToken
Integer maxItems
com.amazonaws.internal.ListWithAutoConstructFlag<T> identities
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> verifiedEmailAddresses
ByteBuffer data
The To:, CC:, and BCC: headers in the raw message can contain a group list.
For more information, go to the Amazon SES Developer Guide.
Date timestamp
Long deliveryAttempts
Long bounces
Long complaints
Long rejects
String source
By default, the string must be 7-bit
ASCII. If the text must contain any other characters, then you must
use MIME encoded-word syntax (RFC 2047) instead of a literal string.
MIME encoded-word syntax uses the following form:
=?charset?encoding?encoded-text?=
. For more information,
see RFC 2047.
Destination destination
Message message
com.amazonaws.internal.ListWithAutoConstructFlag<T> replyToAddresses
String returnPath
ReturnPath
parameter.String messageId
SendEmail
action.String source
By default, the string must be 7-bit
ASCII. If the text must contain any other characters, then you must
use MIME encoded-word syntax (RFC 2047) instead of a literal string.
MIME encoded-word syntax uses the following form:
=?charset?encoding?encoded-text?=
. For more information,
see RFC 2047.
Source
parameter and have
feedback forwarding enabled, then bounces and complaints will be sent
to this email address. This takes precedence over any
Return-Path header that you might include in the raw text of
the message.
com.amazonaws.internal.ListWithAutoConstructFlag<T> destinations
RawMessage rawMessage
String messageId
SendRawEmail
action.String identity
[email protected]
,
example.com
.Boolean forwardingEnabled
true
specifies that Amazon SES
will forward bounce and complaint notifications as email, in addition
to any Amazon SNS topic publishing otherwise specified.
false
specifies that Amazon SES will publish bounce and
complaint notifications only through Amazon SNS. This value can only
be set to false
when Amazon SNS topics are set for both
Bounce
and Complaint
notification types.String identity
[email protected]
, example.com
.String notificationType
Constraints:
Allowed Values: Bounce, Complaint, Delivery
String snsTopic
SnsTopic
is cleared and publishing is disabled.String domain
com.amazonaws.internal.ListWithAutoConstructFlag<T> dkimTokens
Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign emails originating from that domain.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
String domain
String verificationToken
String emailAddress
String emailAddress
String details
ActivityType activityType
String activityId
String details
ActivityTaskTimeoutType timeoutType
String details
WorkflowExecution workflowExecution
WorkflowType workflowType
String details
String key
ScheduleActivityTaskFailedCause failureCause
SignalExternalWorkflowExecutionFailedCause failureCause
WorkflowExecution signaledExecution
StartChildWorkflowExecutionFailedCause failureCause
StartTimerFailedCause failureCause
String details
String taskToken
Constraints:
Length: 1 - 1024
String activityId
Constraints:
Length: 1 - 256
Long startedEventId
ActivityTaskStarted
event recorded in the
history.WorkflowExecution workflowExecution
ActivityType activityType
String input
Constraints:
Length: 0 - 32768
String details
Constraints:
Length: 0 - 32768
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.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.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.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.String activityId
Constraints:
Length: 1 - 256
String result
Constraints:
Length: 0 - 32768
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.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.String reason
Constraints:
Length: 0 - 256
String details
Constraints:
Length: 0 - 32768
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.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
String activityId
Constraints:
Length: 1 - 256
String input
Constraints:
Length: 0 - 32768
String control
Constraints:
Length: 0 - 32768
String scheduleToStartTimeout
Constraints:
Length: 0 - 8
String scheduleToCloseTimeout
Constraints:
Length: 0 - 8
String startToCloseTimeout
Constraints:
Length: 0 - 8
TaskList taskList
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.String heartbeatTimeout
Constraints:
Length: 0 - 8
String identity
Constraints:
Length: 0 - 256
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.Boolean cancelRequested
true
if cancellation of the task is requested.String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE, SCHEDULE_TO_START, SCHEDULE_TO_CLOSE, HEARTBEAT
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.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.String details
details
parameter for the
last call made by the activity to
RecordActivityTaskHeartbeat
.
Constraints:
Length: 0 - 2048
String name
Constraints:
Length: 1 - 256
String version
Constraints:
Length: 1 - 64
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
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.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
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
String status
Constraints:
Allowed Values: REGISTERED, DEPRECATED
String description
Constraints:
Length: 0 - 1024
Date creationDate
Date deprecationDate
com.amazonaws.internal.ListWithAutoConstructFlag<T> typeInfos
String nextPageToken
Constraints:
Length: 0 - 2048
String timerId
Constraints:
Length: 1 - 256
String timerId
CancelTimer
decision that
failed.
Constraints:
Length: 1 - 256
String cause
Constraints:
Allowed Values: TIMER_ID_UNKNOWN, OPERATION_NOT_PERMITTED
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.String details
Constraints:
Length: 0 - 32768
String cause
Constraints:
Allowed Values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED
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
String details
Constraints:
Length: 0 - 32768
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.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
String result
Constraints:
Length: 0 - 32768
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.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
String reason
Constraints:
Length: 0 - 256
String details
Constraints:
Length: 0 - 32768
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.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
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
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.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
String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE
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.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.String status
Constraints:
Allowed Values: COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT
String result
Constraints:
Length: 0 - 32768
String cause
Constraints:
Allowed Values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED
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.String input
Constraints:
Length: 0 - 32768
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
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
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
String workflowTypeVersion
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
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.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.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.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.String taskToken
Constraints:
Length: 1 - 1024
Long startedEventId
DecisionTaskStarted
event recorded in the
history.WorkflowExecution workflowExecution
WorkflowType workflowType
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String nextPageToken
Constraints:
Length: 0 - 2048
Long previousStartedEventId
String executionContext
Constraints:
Length: 0 - 32768
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.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
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
String identity
Constraints:
Length: 0 - 256
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.String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE
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.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.String domain
Constraints:
Length: 1 - 256
ActivityType activityType
String name
Constraints:
Length: 1 - 256
String domain
Constraints:
Length: 1 - 256
WorkflowType workflowType
String domain
Constraints:
Length: 1 - 256
ActivityType activityType
String name
Constraints:
Length: 1 - 256
String domain
Constraints:
Length: 1 - 256
WorkflowExecution execution
String domain
Constraints:
Length: 1 - 256
WorkflowType workflowType
String workflowExecutionRetentionPeriodInDays
Constraints:
Length: 1 - 8
DomainInfo domainInfo
DomainConfiguration configuration
String name
Constraints:
Length: 1 - 256
String status
Constraints:
Allowed Values: REGISTERED, DEPRECATED
String description
Constraints:
Length: 0 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainInfos
String nextPageToken
Constraints:
Length: 0 - 2048
WorkflowExecution workflowExecution
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
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.String cause
Constraints:
Allowed Values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED
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.String domain
Constraints:
Length: 1 - 256
WorkflowExecution execution
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
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
Boolean reverseOrder
true
, returns the events in reverse order. By
default the results are returned in ascending order of the
eventTimeStamp
of the events.com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String nextPageToken
Constraints:
Length: 0 - 2048
Date eventTimestamp
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
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.String domain
Constraints:
Length: 1 - 256
String name
Constraints:
Length: 1 - 256
String registrationStatus
Constraints:
Allowed Values: REGISTERED, DEPRECATED
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
Integer maximumPageSize
Constraints:
Range: 0 - 1000
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.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.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
Integer maximumPageSize
Constraints:
Range: 0 - 1000
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.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
String registrationStatus
Constraints:
Allowed Values: REGISTERED, DEPRECATED
Integer maximumPageSize
Constraints:
Range: 0 - 1000
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.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.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
Integer maximumPageSize
Constraints:
Range: 0 - 1000
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.String domain
Constraints:
Length: 1 - 256
String name
Constraints:
Length: 1 - 256
String registrationStatus
Constraints:
Allowed Values: REGISTERED, DEPRECATED
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
Integer maximumPageSize
Constraints:
Range: 0 - 1000
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.String markerName
Constraints:
Length: 1 - 256
String details
Constraints:
Length: 0 - 32768
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.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".
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
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".
String identity
Constraints:
Length: 0 - 256
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
Integer maximumPageSize
Constraints:
Range: 0 - 1000
Boolean reverseOrder
true
, returns the events in reverse order. By
default the results are returned in ascending order of the
eventTimestamp
of the events.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
String details
Constraints:
Length: 0 - 2048
String markerName
Constraints:
Length: 1 - 256
String cause
Constraints:
Allowed Values: OPERATION_NOT_PERMITTED
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.String domain
Constraints:
Length: 1 - 256
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
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
String description
Constraints:
Length: 0 - 1024
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
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.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
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
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
String description
Constraints:
Length: 0 - 1024
String workflowExecutionRetentionPeriodInDays
NONE
is specified, the records for workflow
executions in this domain are not retained at all.
Constraints:
Length: 1 - 8
String domain
Constraints:
Length: 1 - 256
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
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
String description
Constraints:
Length: 0 - 1024
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
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.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
String activityId
activityId
of the activity task to be canceled.
Constraints:
Length: 1 - 256
String activityId
RequestCancelActivityTask
decision that failed.
Constraints:
Length: 1 - 256
String cause
Constraints:
Allowed Values: ACTIVITY_ID_UNKNOWN, OPERATION_NOT_PERMITTED
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.String workflowId
workflowId
of the external workflow execution to
cancel. This field is required.
Constraints:
Length: 1 - 256
String runId
runId
of the external workflow execution to cancel.
Constraints:
Length: 0 - 64
String control
Constraints:
Length: 0 - 32768
String workflowId
workflowId
of the external workflow to which the
cancel request was to be delivered.
Constraints:
Length: 1 - 256
String runId
runId
of the external workflow execution.
Constraints:
Length: 0 - 64
String cause
Constraints:
Allowed Values: UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION, REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED
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.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.String control
String workflowId
workflowId
of the external workflow execution to be
canceled.
Constraints:
Length: 1 - 256
String runId
runId
of the external workflow execution to be
canceled.
Constraints:
Length: 0 - 64
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.String control
Constraints:
Length: 0 - 32768
String domain
Constraints:
Length: 1 - 256
String workflowId
Constraints:
Length: 1 - 256
String runId
Constraints:
Length: 0 - 64
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
String details
Constraints:
Length: 0 - 32768
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
String result
Constraints:
Length: 0 - 32768
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
String reason
Constraints:
Length: 0 - 256
String details
Constraints:
Length: 0 - 32768
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> decisions
String executionContext
Constraints:
Length: 0 - 32768
String runId
runId
of a workflow execution. This Id is generated
by the service and can be used to uniquely identify the workflow
execution within a domain.
Constraints:
Length: 1 - 64
ActivityType activityType
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
String control
Constraints:
Length: 0 - 32768
String input
Constraints:
Length: 0 - 32768
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".
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
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
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.String activityId
ScheduleActivityTask
decision that failed.
Constraints:
Length: 1 - 256
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
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.String workflowId
workflowId
of the workflow execution to be signaled.
This field is required.
Constraints:
Length: 1 - 256
String runId
runId
of the workflow execution to be signaled.
Constraints:
Length: 0 - 64
String signalName
Constraints:
Length: 1 - 256
String input
Constraints:
Length: 0 - 32768
String control
Constraints:
Length: 0 - 32768
String workflowId
workflowId
of the external workflow execution that
the signal was being delivered to.
Constraints:
Length: 1 - 256
String runId
runId
of the external workflow execution that the
signal was being delivered to.
Constraints:
Length: 0 - 64
String cause
Constraints:
Allowed Values: UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION, SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED
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.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.String control
String workflowId
workflowId
of the external workflow execution.
Constraints:
Length: 1 - 256
String runId
runId
of the external workflow execution to send the
signal to.
Constraints:
Length: 0 - 64
String signalName
Constraints:
Length: 1 - 256
String input
Constraints:
Length: 0 - 32768
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.String control
Constraints:
Length: 0 - 32768
String domain
Constraints:
Length: 1 - 256
String workflowId
Constraints:
Length: 1 - 256
String runId
Constraints:
Length: 0 - 64
String signalName
Constraints:
Length: 1 - 256
String input
WorkflowExecutionSignaled
event in
the target workflow execution's history.
Constraints:
Length: 0 - 32768
WorkflowType workflowType
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
String control
Constraints:
Length: 0 - 32768
String input
Constraints:
Length: 0 - 32768
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".
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
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
WorkflowType workflowType
StartChildWorkflowExecution
Decision that failed.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
String workflowId
workflowId
of the child workflow execution.
Constraints:
Length: 1 - 256
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.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.String control
String workflowId
workflowId
of the child workflow execution.
Constraints:
Length: 1 - 256
WorkflowType workflowType
String control
Constraints:
Length: 0 - 32768
String input
Constraints:
Length: 0 - 32768
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
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.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
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
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
String control
Constraints:
Length: 0 - 32768
String startToFireTimeout
The duration is specified in seconds. The valid values are integers greater than or equal to 0.
Constraints:
Length: 1 - 8
String timerId
StartTimer
decision that
failed.
Constraints:
Length: 1 - 256
String cause
Constraints:
Allowed Values: TIMER_ID_ALREADY_IN_USE, OPEN_TIMERS_LIMIT_EXCEEDED, TIMER_CREATION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED
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.String domain
Constraints:
Length: 1 - 256
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".
String input
input
is made available to the new workflow execution in
the WorkflowExecutionStarted
history event.
Constraints:
Length: 0 - 32768
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
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
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
String tag
Constraints:
Length: 1 - 256
String name
Constraints:
Length: 1 - 256
String domain
Constraints:
Length: 1 - 256
String workflowId
Constraints:
Length: 1 - 256
String runId
Constraints:
Length: 0 - 64
String reason
Constraints:
Length: 0 - 256
String details
Constraints:
Length: 0 - 32768
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
String timerId
Constraints:
Length: 1 - 256
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.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.String timerId
Constraints:
Length: 1 - 256
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.String timerId
Constraints:
Length: 1 - 256
String control
Constraints:
Length: 0 - 32768
String startToFireTimeout
The duration is specified in seconds. The valid values are integers greater than or equal to 0.
Constraints:
Length: 1 - 8
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.String details
Constraints:
Length: 0 - 32768
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
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.String cause
Constraints:
Allowed Values: CHILD_POLICY_APPLIED
String result
Constraints:
Length: 0 - 32768
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.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
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
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
String input
Constraints:
Length: 0 - 32768
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.String newExecutionRunId
runId
of the new workflow execution.
Constraints:
Length: 1 - 64
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
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
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
WorkflowType workflowType
WorkflowExecutionInfo executionInfo
WorkflowExecutionConfiguration executionConfiguration
WorkflowExecutionOpenCounts openCounts
Date latestActivityTaskTimestamp
String latestExecutionContext
Constraints:
Length: 0 - 32768
String reason
Constraints:
Length: 0 - 256
String details
Constraints:
Length: 0 - 32768
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.String workflowId
Constraints:
Length: 1 - 256
WorkflowExecution execution
WorkflowType workflowType
Date startTimestamp
Date closeTimestamp
String executionStatus
Constraints:
Allowed Values: OPEN, CLOSED
String closeStatus
Constraints:
Allowed Values: COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT
WorkflowExecution parent
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
Boolean cancelRequested
com.amazonaws.internal.ListWithAutoConstructFlag<T> executionInfos
String nextPageToken
Constraints:
Length: 0 - 2048
Integer openActivityTasks
Constraints:
Range: 0 -
Integer openDecisionTasks
Constraints:
Range: 0 - 1
Integer openTimers
Constraints:
Range: 0 -
Integer openChildWorkflowExecutions
Constraints:
Range: 0 -
String signalName
Constraints:
Length: 1 - 256
String input
Constraints:
Length: 0 - 32768
WorkflowExecution externalWorkflowExecution
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.String input
Constraints:
Length: 0 - 32768
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
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
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
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
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.String reason
Constraints:
Length: 0 - 256
String details
Constraints:
Length: 0 - 32768
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
String cause
Constraints:
Allowed Values: CHILD_POLICY_APPLIED, EVENT_LIMIT_EXCEEDED, OPERATOR_INITIATED
String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE
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
String name
Constraints:
Length: 1 - 256
String version
Constraints:
Length: 1 - 64
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
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.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
String status
Constraints:
Allowed Values: REGISTERED, DEPRECATED
String description
Constraints:
Length: 0 - 1024
Date creationDate
Date deprecationDate
com.amazonaws.internal.ListWithAutoConstructFlag<T> typeInfos
String nextPageToken
Constraints:
Length: 0 - 2048
String topicArn
String label
com.amazonaws.internal.ListWithAutoConstructFlag<T> aWSAccountIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> actionNames
Valid values: any Amazon SNS action name.
String topicArn
String token
Subscribe
action.String authenticateOnUnsubscribe
true
and the request has an
AWS signature, then only the topic owner and the subscription owner
can unsubscribe the endpoint. The unsubscribe action requires AWS
authentication.String subscriptionArn
String name
String platform
Map<K,V> attributes
String platformApplicationArn
String platformApplicationArn
String token
String customUserData
Map<K,V> attributes
String endpointArn
String name
Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
String topicArn
String endpointArn
String platformApplicationArn
String topicArn
String endpointArn
Map<K,V> attributes
CustomUserData
-- arbitrary user data to associate with the endpoint. Amazon SNS does
not use this data. The data must be in UTF-8 format and less than
2KB.Enabled
-- flag that enables/disables
delivery to the endpoint. Amazon SNS will set this to false when a
notification service indicates to Amazon SNS that the endpoint is
invalid. Users can set it back to true, typically after updating
Token.Token
-- device token, also referred to
as a registration id, for an app and mobile device. This is returned
from the notification service when an app and mobile device are
registered with the notification service.String platformApplicationArn
Map<K,V> attributes
EventEndpointCreated
-- Topic ARN to which
EndpointCreated event notifications should be sent.EventEndpointDeleted
-- Topic ARN to which
EndpointDeleted event notifications should be sent.EventEndpointUpdated
-- Topic ARN to which
EndpointUpdate event notifications should be sent.EventDeliveryFailure
-- Topic ARN to which
DeliveryFailure event notifications should be sent upon Direct Publish
delivery failure (permanent) to one of the application's
endpoints.String subscriptionArn
Map<K,V> attributes
SubscriptionArn
-- the
subscription's ARNTopicArn
-- the topic ARN
that the subscription is associated withOwner
-- the AWS account ID of the subscription's ownerConfirmationWasAuthenticated
-- true if the
subscription confirmation request was authenticatedDeliveryPolicy
-- the JSON serialization of the
subscription's delivery policyEffectiveDeliveryPolicy
-- the JSON serialization of
the effective delivery policy that takes into account the topic
delivery policy and account system defaultsString topicArn
Map<K,V> attributes
TopicArn
-- the topic's ARNOwner
-- the AWS account ID of the topic's ownerPolicy
-- the JSON serialization of the topic's
access control policyDisplayName
-- the
human-readable name used in the "From" field for notifications to
email and email-json endpointsSubscriptionsPending
-- the number of subscriptions
pending confirmation on this topicSubscriptionsConfirmed
-- the number of confirmed
subscriptions on this topicSubscriptionsDeleted
-- the number of deleted subscriptions on this topicDeliveryPolicy
-- the JSON serialization of the
topic's delivery policyEffectiveDeliveryPolicy
-- the JSON serialization of the effective delivery policy that takes
into account system defaultsString platformApplicationArn
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> endpoints
String nextToken
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> platformApplications
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> subscriptions
String nextToken
ListSubscriptionsByTopic
request. This element is returned if there are more subscriptions to
retrieve.String nextToken
ListSubscriptions
request.com.amazonaws.internal.ListWithAutoConstructFlag<T> subscriptions
String nextToken
ListSubscriptions
request. This element is returned if there are more subscriptions to
retrieve.String nextToken
ListTopics
request.com.amazonaws.internal.ListWithAutoConstructFlag<T> topics
String nextToken
ListTopics
request. This
element is returned if there are additional topics to retrieve.String dataType
String stringValue
ByteBuffer binaryValue
String topicArn
String targetArn
String message
If you want to send the same message to all transport protocols, include the text of the message as a String value.
If you want to send different messages
for each transport protocol, set the value of the
MessageStructure
parameter to json
and use a
JSON object for the Message
parameter. See the Examples
section for the format of the JSON object.
Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters).
JSON-specific constraints:
Publish
call to return an error (no partial
delivery).String subject
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
String messageStructure
MessageStructure
to json
if you want to
send a different message for each protocol. For example, using one
publish action, you can send a short message to your SMS subscribers
and a longer message to your email subscribers. If you set
MessageStructure
to json
, the value of the
Message
parameter must: You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").
For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide.
Valid value:
json
Map<K,V> messageAttributes
String messageId
Length Constraint: Maximum 100 characters
String endpointArn
Map<K,V> attributes
CustomUserData
-- arbitrary user data
to associate with the endpoint. Amazon SNS does not use this data. The
data must be in UTF-8 format and less than 2KB.Enabled
-- flag that enables/disables delivery to the
endpoint. Amazon SNS will set this to false when a notification
service indicates to Amazon SNS that the endpoint is invalid. Users
can set it back to true, typically after updating Token.Token
-- device token, also referred to as a
registration id, for an app and mobile device. This is returned from
the notification service when an app and mobile device are registered
with the notification service.String platformApplicationArn
Map<K,V> attributes
PlatformCredential
-- The
credential received from the notification service. For
APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM,
PlatformCredential is "API key". For ADM, PlatformCredential is
"client secret".PlatformPrincipal
-- The
principal received from the notification service. For
APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM,
PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is
"client id".EventEndpointCreated
-- Topic ARN
to which EndpointCreated event notifications should be sent.EventEndpointDeleted
-- Topic ARN to which
EndpointDeleted event notifications should be sent.EventEndpointUpdated
-- Topic ARN to which
EndpointUpdate event notifications should be sent.EventDeliveryFailure
-- Topic ARN to which
DeliveryFailure event notifications should be sent upon Direct Publish
delivery failure (permanent) to one of the application's
endpoints.String subscriptionArn
String attributeName
Valid values:
DeliveryPolicy
| RawMessageDelivery
String attributeValue
String topicArn
String attributeName
Valid values: Policy
|
DisplayName
| DeliveryPolicy
String attributeValue
String topicArn
String protocol
http
-- delivery of JSON-encoded message via HTTP
POSThttps
-- delivery of JSON-encoded message
via HTTPS POSTemail
-- delivery of message via
SMTPemail-json
-- delivery of JSON-encoded
message via SMTPsms
-- delivery of message via
SMSsqs
-- delivery of JSON-encoded message to
an Amazon SQS queueapplication
-- delivery of
JSON-encoded message to an EndpointArn for a mobile app and
device.String endpoint
http
protocol, the endpoint is
an URL beginning with "http://"https
protocol, the endpoint is a URL beginning with "https://"email
protocol, the endpoint is an email addressemail-json
protocol, the endpoint is an email
addresssms
protocol, the endpoint is a
phone number of an SMS-enabled devicesqs
protocol, the endpoint is the ARN of an Amazon SQS
queueapplication
protocol, the endpoint
is the EndpointArn of a mobile app and device.String subscriptionArn
String subscriptionArn
String owner
String protocol
String endpoint
String topicArn
String topicArn
String subscriptionArn
String queueUrl
String label
AliceSendMessage
). Constraints: Maximum 80 characters;
alphanumeric characters, hyphens (-), and underscores (_) are allowed.com.amazonaws.internal.ListWithAutoConstructFlag<T> aWSAccountIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> actions
* | SendMessage | ReceiveMessage |
DeleteMessage | ChangeMessageVisibility | GetQueueAttributes |
GetQueueUrl
. For more information about these actions, see Understanding
Permissions in the Amazon SQS Developer Guide.
Specifying SendMessage
, DeleteMessage
, or
ChangeMessageVisibility
for the ActionName.n
also grants permissions for the corresponding batch versions of those
actions: SendMessageBatch
,
DeleteMessageBatch
, and
ChangeMessageVisibilityBatch
.
String queueUrl
com.amazonaws.internal.ListWithAutoConstructFlag<T> entries
String id
Id
s of a batch
request need to be unique within the request.String receiptHandle
Integer visibilityTimeout
com.amazonaws.internal.ListWithAutoConstructFlag<T> successful
com.amazonaws.internal.ListWithAutoConstructFlag<T> failed
String id
String queueUrl
String receiptHandle
Integer visibilityTimeout
String queueName
Map<K,V> attributes
The following
lists the names, descriptions, and values of the special request
parameters the CreateQueue
action uses:
DelaySeconds
- The time in seconds that the delivery
of all messages in the queue will be delayed. An integer from 0 to 900
(15 minutes). The default for this attribute is 0 (zero).MaximumMessageSize
- The limit of how many bytes a
message can contain before Amazon SQS rejects it. An integer from 1024
bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this
attribute is 262144 (256 KiB).MessageRetentionPeriod
- The number of seconds Amazon
SQS retains a message. Integer representing seconds, from 60 (1
minute) to 1209600 (14 days). The default for this attribute is 345600
(4 days).Policy
- The queue's policy. A valid
form-url-encoded policy. For more information about policy structure,
see Basic
Policy Structure in the Amazon SQS Developer Guide. For
more information about form-url-encoding, see http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1.ReceiveMessageWaitTimeSeconds
- The time for which a
ReceiveMessage call will wait for a message to arrive. An
integer from 0 to 20 (seconds). The default for this attribute is 0.
VisibilityTimeout
- The visibility timeout for
the queue. An integer from 0 to 43200 (12 hours). The default for this
attribute is 30. For more information about visibility timeout, see Visibility
Timeout in the Amazon SQS Developer Guide.String queueUrl
String queueUrl
com.amazonaws.internal.ListWithAutoConstructFlag<T> entries
com.amazonaws.internal.ListWithAutoConstructFlag<T> successful
com.amazonaws.internal.ListWithAutoConstructFlag<T> failed
String id
String queueUrl
String queueUrl
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeNames
String queueUrl
String queueUrl
com.amazonaws.internal.ListWithAutoConstructFlag<T> queueUrls
String queueNamePrefix
com.amazonaws.internal.ListWithAutoConstructFlag<T> queueUrls
String messageId
String receiptHandle
String mD5OfBody
String body
Map<K,V> attributes
SenderId
, SentTimestamp
,
ApproximateReceiveCount
, and/or
ApproximateFirstReceiveTimestamp
.
SentTimestamp
and
ApproximateFirstReceiveTimestamp
are each returned as an
integer representing the epoch time in
milliseconds.String mD5OfMessageAttributes
Map<K,V> messageAttributes
String stringValue
ByteBuffer binaryValue
com.amazonaws.internal.ListWithAutoConstructFlag<T> stringListValues
com.amazonaws.internal.ListWithAutoConstructFlag<T> binaryListValues
String dataType
String queueUrl
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeNames
The following lists the names and descriptions of the attributes that can be returned:
All
- returns all
values.ApproximateFirstReceiveTimestamp
-
returns the time when the message was first received (epoch time in
milliseconds).ApproximateReceiveCount
- returns
the number of times a message has been received but not deleted.SenderId
- returns the AWS account number (or the IP
address, if anonymous access is allowed) of the sender.SentTimestamp
- returns the time when the message was
sent (epoch time in milliseconds).com.amazonaws.internal.ListWithAutoConstructFlag<T> messageAttributeNames
Integer maxNumberOfMessages
All of the messages are not necessarily returned.
Integer visibilityTimeout
ReceiveMessage
request.Integer waitTimeSeconds
com.amazonaws.internal.ListWithAutoConstructFlag<T> messages
String queueUrl
String label
String queueUrl
com.amazonaws.internal.ListWithAutoConstructFlag<T> entries
String id
Id
s of a batch
request need to be unique within the request.String messageBody
Integer delaySeconds
Map<K,V> messageAttributes
com.amazonaws.internal.ListWithAutoConstructFlag<T> successful
com.amazonaws.internal.ListWithAutoConstructFlag<T> failed
String id
String messageId
String mD5OfMessageBody
String mD5OfMessageAttributes
String queueUrl
String messageBody
Integer delaySeconds
DelaySeconds
value
become available for processing after the delay time is finished. If
you don't specify a value, the default value for the queue applies.Map<K,V> messageAttributes
String mD5OfMessageBody
String mD5OfMessageAttributes
String messageId
String queueUrl
Map<K,V> attributes
The following lists the names,
descriptions, and values of the special request parameters the
SetQueueAttributes
action uses:
DelaySeconds
- The time in seconds that the delivery
of all messages in the queue will be delayed. An integer from 0 to 900
(15 minutes). The default for this attribute is 0 (zero).MaximumMessageSize
- The limit of how many bytes a
message can contain before Amazon SQS rejects it. An integer from 1024
bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this
attribute is 262144 (256 KiB).MessageRetentionPeriod
- The number of seconds Amazon
SQS retains a message. Integer representing seconds, from 60 (1
minute) to 1209600 (14 days). The default for this attribute is 345600
(4 days).Policy
- The queue's policy. A valid
form-url-encoded policy. For more information about policy structure,
see Basic
Policy Structure in the Amazon SQS Developer Guide. For
more information about form-url-encoding, see http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1.ReceiveMessageWaitTimeSeconds
- The time for which a
ReceiveMessage call will wait for a message to arrive. An integer from
0 to 20 (seconds). The default for this attribute is 0. VisibilityTimeout
- The visibility timeout for the
queue. An integer from 0 to 43200 (12 hours). The default for this
attribute is 30. For more information about visibility timeout, see
Visibility Timeout in the Amazon SQS Developer Guide.RedrivePolicy
- The parameters for dead letter queue
functionality of the source queue. For more information about
RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter
Queues in the Amazon SQS Developer Guide.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
String gatewayName
Constraints:
Length: 2 - 255
Pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$
String gatewayTimezone
Constraints:
Length: 3 - 10
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
String gatewayType
STORED
.
Constraints:
Length: 2 - 20
String tapeDriveType
String mediumChangerType
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskIds
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskIds
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskIds
String gatewayARN
Constraints:
Length: 50 - 500
String volumeARN
String volumeId
String volumeType
String volumeStatus
Long volumeSizeInBytes
Double volumeProgress
String sourceSnapshotId
VolumeiSCSIAttributes volumeiSCSIAttributes
String gatewayARN
Constraints:
Length: 50 - 500
String tapeARN
Constraints:
Length: 50 - 500
String tapeARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
String tapeARN
Constraints:
Length: 50 - 500
String tapeARN
Constraints:
Length: 50 - 500
String targetARN
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
Constraints:
Length: 50 - 800
String secretToAuthenticateInitiator
Constraints:
Length: 12 - 16
String initiatorName
Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+
String secretToAuthenticateTarget
Constraints:
Length: 12 - 16
String gatewayARN
Constraints:
Length: 50 - 500
Long volumeSizeInBytes
String snapshotId
String targetName
String networkInterfaceId
String clientToken
String volumeARN
Constraints:
Length: 50 - 500
String snapshotDescription
Constraints:
Length: 1 - 255
String volumeARN
Constraints:
Length: 50 - 500
String snapshotId
DescribeSnapshots
) or creating a volume from a
snapshot (CreateStorediSCSIVolume).
Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z
String gatewayARN
Constraints:
Length: 50 - 500
String diskId
Constraints:
Length: 1 - 300
String snapshotId
Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z
Boolean preserveExistingData
Valid Values: true, false
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]+$
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
String volumeARN
Constraints:
Length: 50 - 500
Long volumeSizeInBytes
String targetARN
Constraints:
Length: 50 - 800
String gatewayARN
Constraints:
Length: 50 - 500
Long tapeSizeInBytes
Constraints:
Range: 107374182400 - 2748779069440
String clientToken
ClientToken
you specified in the
initial request. ClientToken
prevents creating the tape multiple times.
Constraints:
Length: 5 - 100
Integer numTapesToCreate
Constraints:
Range: 1 - 10
String tapeBarcodePrefix
Constraints:
Length: 1 - 4
Pattern: ^[A-Z]*$
com.amazonaws.internal.ListWithAutoConstructFlag<T> tapeARNs
String gatewayARN
Constraints:
Length: 50 - 500
String bandwidthType
String gatewayARN
Constraints:
Length: 50 - 500
String targetARN
Constraints:
Length: 50 - 800
String initiatorName
Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
String volumeARN
String volumeARN
String tapeARN
Constraints:
Length: 50 - 500
String tapeARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
String tapeARN
Constraints:
Length: 50 - 500
String tapeARN
Constraints:
Length: 50 - 500
String volumeARN
Constraints:
Length: 50 - 500
String volumeARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
Long averageUploadRateLimitInBitsPerSec
Constraints:
Range: 51200 -
Long averageDownloadRateLimitInBitsPerSec
Constraints:
Range: 102400 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeARNs
com.amazonaws.internal.ListWithAutoConstructFlag<T> cachediSCSIVolumes
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskIds
Long cacheAllocatedInBytes
Double cacheUsedPercentage
Double cacheDirtyPercentage
Double cacheHitPercentage
Double cacheMissPercentage
String targetARN
Constraints:
Length: 50 - 800
com.amazonaws.internal.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.
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayId
Constraints:
Length: 12 - 30
String gatewayTimezone
Constraints:
Length: 3 - 10
String gatewayState
Constraints:
Length: 2 - 25
com.amazonaws.internal.ListWithAutoConstructFlag<T> gatewayNetworkInterfaces
String gatewayType
Constraints:
Length: 2 - 20
String nextUpdateAvailabilityDate
Constraints:
Length: 1 - 25
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
Integer hourOfDay
Integer minuteOfHour
Integer dayOfWeek
String timezone
String volumeARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeARNs
com.amazonaws.internal.ListWithAutoConstructFlag<T> storediSCSIVolumes
com.amazonaws.internal.ListWithAutoConstructFlag<T> tapeARNs
String marker
Constraints:
Length: 1 - 1000
Integer limit
Constraints:
Range: 1 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> tapeArchives
String marker
Constraints:
Length: 1 - 1000
String gatewayARN
Constraints:
Length: 50 - 500
String marker
Constraints:
Length: 1 - 1000
Integer limit
Constraints:
Range: 1 -
String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> tapeRecoveryPointInfos
String marker
Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response.
Constraints:
Length: 1 - 1000
String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> tapeARNs
String marker
DescribeTapes
. This marker indicates which page of
results to retrieve. If not specified, the first page of results is retrieved.
Constraints:
Length: 1 - 1000
Integer limit
Constraints:
Range: 1 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> tapes
String marker
If a response does not contain a marker, then there are no more results to be retrieved.
Constraints:
Length: 1 - 1000
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskIds
Long uploadBufferUsedInBytes
Long uploadBufferAllocatedInBytes
String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> vTLDeviceARNs
String marker
Constraints:
Length: 1 - 1000
Integer limit
Constraints:
Range: 1 -
String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> vTLDevices
String marker
Constraints:
Length: 1 - 1000
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskIds
Long workingStorageUsedInBytes
Long workingStorageAllocatedInBytes
String targetARN
Constraints:
Length: 50 - 800
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
Integer networkInterfacePort
Boolean chapEnabled
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayType
String gatewayOperationalState
com.amazonaws.internal.ListWithAutoConstructFlag<T> gateways
String marker
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> disks
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeRecoveryPointInfos
String gatewayARN
Constraints:
Length: 50 - 500
String marker
Constraints:
Length: 1 - 1000
Integer limit
Constraints:
Range: 1 -
String gatewayARN
Constraints:
Length: 50 - 500
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeInfos
String ipv4Address
String macAddress
String ipv6Address
String tapeARN
Constraints:
Length: 50 - 500
String gatewayARN
You retrieve archived virtual tapes to only one gateway and the gateway must be a Gateway-Virtual Tape Library.
Constraints:
Length: 50 - 500
String tapeARN
Constraints:
Length: 50 - 500
String tapeARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
String tapeARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
String volumeARN
String volumeId
String volumeType
String volumeStatus
Long volumeSizeInBytes
Double volumeProgress
String volumeDiskId
String sourceSnapshotId
Boolean preservedExistingData
VolumeiSCSIAttributes volumeiSCSIAttributes
String tapeARN
Constraints:
Length: 50 - 500
String tapeBarcode
Constraints:
Length: 8 - 16
Pattern: ^[A-Z0-9]*$
Long tapeSizeInBytes
Constraints:
Range: 107374182400 - 2748779069440
String tapeStatus
String vTLDevice
Constraints:
Length: 50 - 500
Double progress
Range: 0 (not started) to 100 (complete).
String tapeARN
Constraints:
Length: 50 - 500
String tapeBarcode
Constraints:
Length: 8 - 16
Pattern: ^[A-Z0-9]*$
Long tapeSizeInBytes
Constraints:
Range: 107374182400 - 2748779069440
Date completionTime
The string format of the completion time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
String retrievedTo
The virtual tape is retrieved from the Virtual Tape Shelf (VTS).
Constraints:
Length: 50 - 500
String tapeStatus
String tapeARN
Constraints:
Length: 50 - 500
Date tapeRecoveryPointTime
The string format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
Long tapeSizeInBytes
Constraints:
Range: 107374182400 - 2748779069440
String tapeStatus
String gatewayARN
Constraints:
Length: 50 - 500
Long averageUploadRateLimitInBitsPerSec
Constraints:
Range: 51200 -
Long averageDownloadRateLimitInBitsPerSec
Constraints:
Range: 102400 -
String gatewayARN
Constraints:
Length: 50 - 500
String targetARN
Constraints:
Length: 50 - 800
String secretToAuthenticateInitiator
Constraints:
Length: 12 - 16
String initiatorName
Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+
String secretToAuthenticateTarget
Constraints:
Length: 12 - 16
String targetARN
Constraints:
Length: 50 - 800
String initiatorName
Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayName
Constraints:
Length: 2 - 255
Pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$
String gatewayTimezone
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
Integer hourOfDay
Constraints:
Range: 0 - 23
Integer minuteOfHour
Constraints:
Range: 0 - 59
Integer dayOfWeek
Constraints:
Range: 0 - 6
String gatewayARN
Constraints:
Length: 50 - 500
String volumeARN
Constraints:
Length: 50 - 500
Integer startAt
Constraints:
Range: 0 - 23
Integer recurrenceInHours
Constraints:
Range: 1 - 24
String description
Constraints:
Length: 1 - 255
String volumeARN
Constraints:
Length: 50 - 500
String targetARN
Constraints:
Length: 50 - 800
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
Integer networkInterfacePort
Integer lunNumber
Constraints:
Range: 1 -
Boolean chapEnabled
String vTLDeviceARN
Constraints:
Length: 50 - 500
String vTLDeviceType
String vTLDeviceVendor
String vTLDeviceProductIdentifier
DeviceiSCSIAttributes deviceiSCSIAttributes
String attachmentSetId
com.amazonaws.internal.ListWithAutoConstructFlag<T> attachments
String caseId
String communicationBody
Constraints:
Length: 1 - 8000
com.amazonaws.internal.ListWithAutoConstructFlag<T> ccEmailAddresses
Constraints:
Length: 0 - 10
String attachmentSetId
Boolean result
String fileName
ByteBuffer data
String caseId
String displayId
String subject
String status
String serviceCode
String categoryCode
String severityCode
String submittedBy
String timeCreated
RecentCaseCommunications recentCommunications
nextToken
to retrieve the next set of
communications.com.amazonaws.internal.ListWithAutoConstructFlag<T> ccEmailAddresses
String language
String caseId
String body
String submittedBy
String timeCreated
com.amazonaws.internal.ListWithAutoConstructFlag<T> attachmentSet
String subject
String serviceCode
Constraints:
Pattern: [0-9a-z\-_]+
String severityCode
The availability of severity levels depends on each customer's support subscription. In other words, your subscription may not necessarily require the urgent level of response time.
String categoryCode
String communicationBody
Constraints:
Length: 1 - 8000
com.amazonaws.internal.ListWithAutoConstructFlag<T> ccEmailAddresses
Constraints:
Length: 0 - 10
String language
String issueType
String attachmentSetId
String caseId
String attachmentId
Attachment attachment
com.amazonaws.internal.ListWithAutoConstructFlag<T> caseIdList
Constraints:
Length: 0 - 100
String displayId
String afterTime
String beforeTime
Boolean includeResolvedCases
String nextToken
Integer maxResults
Constraints:
Range: 10 - 100
String language
Boolean includeCommunications
com.amazonaws.internal.ListWithAutoConstructFlag<T> cases
String nextToken
String caseId
String beforeTime
String afterTime
String nextToken
Integer maxResults
Constraints:
Range: 10 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> communications
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> serviceCodeList
Constraints:
Length: 0 - 100
String language
com.amazonaws.internal.ListWithAutoConstructFlag<T> services
String language
com.amazonaws.internal.ListWithAutoConstructFlag<T> severityLevels
com.amazonaws.internal.ListWithAutoConstructFlag<T> checkIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> statuses
String checkId
String language
TrustedAdvisorCheckResult result
String language
com.amazonaws.internal.ListWithAutoConstructFlag<T> checks
com.amazonaws.internal.ListWithAutoConstructFlag<T> checkIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> summaries
com.amazonaws.internal.ListWithAutoConstructFlag<T> communications
String nextToken
String checkId
TrustedAdvisorCheckRefreshStatus status
String caseId
String initialCaseStatus
String finalCaseStatus
String code
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> categories
TrustedAdvisorCostOptimizingSummary costOptimizing
String id
String name
String description
String category
com.amazonaws.internal.ListWithAutoConstructFlag<T> metadata
String checkId
String status
Long millisUntilNextRefreshable
String checkId
String timestamp
String status
TrustedAdvisorResourcesSummary resourcesSummary
TrustedAdvisorCategorySpecificSummary categorySpecificSummary
com.amazonaws.internal.ListWithAutoConstructFlag<T> flaggedResources
String checkId
String timestamp
String status
Boolean hasFlaggedResources
TrustedAdvisorResourcesSummary resourcesSummary
TrustedAdvisorCategorySpecificSummary categorySpecificSummary
Double estimatedMonthlySavings
Double estimatedPercentMonthlySavings
String status
String region
String resourceId
Boolean isSuppressed
com.amazonaws.internal.ListWithAutoConstructFlag<T> metadata
Long resourcesProcessed
Long resourcesFlagged
Long resourcesIgnored
Long resourcesSuppressed
Copyright © 2015. All rights reserved.