String requestId
String errorCode
AmazonServiceException.ErrorType errorType
AmazonServiceException.ErrorType
String errorMessage
int statusCode
String serviceName
String rawResponseContent
String extraInfo
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, WaitingForInstanceWarmup, 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 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
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
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
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
If you
specify VPCZoneIdentifier
and
AvailabilityZones
, ensure that the Availability Zones of
the subnets match the values 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
ephemeral0
to
ephemeral3
.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String deviceName
/dev/sdh
or xvdh
).
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Ebs ebs
Boolean noDevice
If this parameter is true for the root device, the instance might fail the EC2 health check. Auto Scaling launches a replacement instance if the instance fails the health check.
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
InstanceId
parameter to specify an EC2 instance instead
of a launch configuration.
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String instanceId
LaunchConfigurationName
parameter to specify a launch configuration instead of an EC2
instance. When you specify an ID of an instance, Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.
For more information, see Create an Auto Scaling Group from an 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 this parameter is not specified, the default value is 300. For more information, see Understanding Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
VPCZoneIdentifier
parameter.
Constraints:
Length: 1 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
For more information, see Load Balance Your Auto Scaling Group in the Auto Scaling Developer Guide.
String healthCheckType
EC2
and ELB
. By default, health checks use Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Checks.
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer healthCheckGracePeriod
This
parameter is required if you are adding an 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 to Your Auto Scaling Group in the Auto Scaling Developer Guide.
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 more information, see Auto Scaling and 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, see Choosing a Termination Policy for Your Auto Scaling Group in the Auto Scaling Developer Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
For more information, see Tagging Auto Scaling Groups and 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-Classic, you can either specify security group names or the security group IDs. For more information about security groups for EC2-Classic, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide.
If your instances are launched into a VPC, specify security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
String classicLinkVPCId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> classicLinkVPCSecurityGroups
ClassicLinkVPCId
. This parameter is required if
ClassicLinkVPCId
is specified, and is not supported
otherwise. For more information, see ClassicLink
in the Amazon Elastic Compute Cloud User Guide.String userData
At this time, launch configurations don't support compressed (zipped) user data files.
Constraints:
Length: 0 - 21847
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String instanceId
The new launch configuration derives attributes from the instance, with the exception of the block device mapping.
To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.
For more information, see Create a Launch Configuration Using an EC2 Instance in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 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 generates metrics every minute and your account is charged
a fee. When you disable detailed monitoring, by specifying
False
, CloudWatch generates metrics every 5 minutes. For
more information, see Monitor
Your Auto Scaling Instances in the Auto Scaling Developer
Guide.
String spotPrice
Constraints:
Length: 1 - 255
String iamInstanceProfile
EC2 instances launched with an IAM role will automatically have AWS security credentials available. You can use IAM roles with Auto Scaling to automatically enable applications running on your EC2 instances to securely access other AWS resources. For more information, see Launch Auto Scaling Instances with an IAM Role in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 1600
Pattern: [\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 subnet using the VPCZoneIdentifier parameter when you create your group.
Default: If the instance is
launched into a default subnet, the default is true
. If
the instance is launched into a nondefault subnet, the default is
false
. For more information, see Supported
Platforms in the Amazon Elastic Compute Cloud User Guide.
String placementTenancy
dedicated
runs on single-tenant hardware and can only be
launched into a VPC. You must set the value of this parameter to
dedicated
if want to launch Dedicated Instances into a
shared tenancy VPC (VPC with instance placement tenancy attribute set
to default
).
If you specify a value for this parameter, be sure to specify at least one subnet using the VPCZoneIdentifier parameter when you create your group.
For more information, see Auto Scaling and 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
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
Integer maxNumberOfAutoScalingGroups
Integer maxNumberOfLaunchConfigurations
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
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer maxRecords
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancers
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> metrics
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyTypes
SimpleScaling
and StepScaling
.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
parameter 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
You can describe up
to a maximum of 50 instances with a single call. If there are more
items to return, the call returns a token. To get the next set of
items, repeat the call with the returned token in the
NextToken
parameter.
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
,
and 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> loadBalancerNames
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 GiB. If you
specify SnapshotId
and VolumeSize
,
VolumeSize
must be equal to or larger than the size of
the snapshot.
Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the size of the snapshot.
Required: Required when the volume type is
io1
.
Constraints:
Range: 1 - 16384
String volumeType
Valid values: standard | io1 | gp2
Default: standard
Constraints:
Length: 1 - 255
Boolean deleteOnTermination
Default: true
Integer iops
Valid values: Range is 100 to 4000.
Default: None
Constraints:
Range: 100 - 20000
String metric
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String granularity
1Minute
.
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
Note that the
GroupStandbyInstances
metric is not enabled by default.
You must explicitly request this metric.
String granularity
1Minute
.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
Standby
mode. You must
specify at least one instance ID.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean shouldDecrementDesiredCapacity
Standby
mode
count as part of the Auto Scaling group's desired capacity. If set,
the desired capacity for the Auto Scaling group decrements by the
number of instances moved to Standby
mode.com.amazonaws.internal.ListWithAutoConstructFlag<T> activities
Standby
mode.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
This parameter is not supported if the policy type is
StepScaling
.
For more information, see Understanding Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
Double metricValue
BreachThreshold
. This
enables you to execute a policy of type StepScaling
and
determine which step adjustment to use. For example, if the breach
threshold is 50 and you want to use a step adjustment with a lower
bound of 0 and an upper bound of 10, you can set the metric value to
59. If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.
This
parameter is required if the policy type is StepScaling
and not supported otherwise.
Double breachThreshold
This parameter is required if
the policy type is StepScaling
and not supported
otherwise.
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
Standby
mode.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
Quarantined
state is not used.
Constraints:
Allowed Values: Pending, Pending:Wait, Pending:Proceed, Quarantined, InService, Terminating, Terminating:Wait, Terminating:Proceed, Terminated, Detaching, Detached, EnteringStandby, Standby
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 classicLinkVPCId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> classicLinkVPCSecurityGroups
ClassicLinkVPCId
. This parameter is required if
ClassicLinkVPCId
is specified, and cannot be used
otherwise. For more information, see ClassicLink
in the Amazon Elastic Compute Cloud User Guide.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
true
) or not (false
).Boolean associatePublicIpAddress
true
) or not (false
).String placementTenancy
default
or
dedicated
. An instance with dedicated
tenancy runs in an isolated, single-tenant hardware and can only be
launched into a VPC.
Constraints:
Length: 1 - 64
Pattern: [\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, the maximum is set to 48 hours.String defaultResult
CONTINUE
and ABANDON
. The
default value is CONTINUE
.String loadBalancerName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String state
Adding
- The
instances in the group are being registered with the load
balancer.
Added
- All instances in the group
are registered with the load balancer.
InService
- At least one instance in the group
passed an ELB health check.
Removing
- The
instances are being deregistered from the load balancer. If connection
draining is enabled, Elastic Load Balancing waits for in-flight
requests to complete before deregistering the instances.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String metric
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String granularity
1Minute
.
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
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String processName
Launch
Terminate
AddToLoadBalancer
AlarmNotification
AZRebalance
HealthCheck
ReplaceUnhealthy
ScheduledActions
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]*
String policyType
SimpleScaling
and
StepScaling
. If the policy type is null, the value is
treated as SimpleScaling
.
Constraints:
Length: 1 - 64
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String adjustmentType
ChangeInCapacity
,
ExactCapacity
, and PercentChangeInCapacity
.
For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer minAdjustmentStep
MinAdjustmentMagnitude
instead.Integer minAdjustmentMagnitude
AdjustmentType
is PercentChangeInCapacity
,
the scaling policy changes the DesiredCapacity
of the
Auto Scaling group by at least this many instances. Otherwise, the
error is ValidationError
.Integer scalingAdjustment
This parameter is required if
the policy type is SimpleScaling
and not supported
otherwise.
Integer cooldown
This
parameter is not supported unless the policy type is
SimpleScaling
.
For more information, see Understanding Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
String metricAggregationType
Minimum
, Maximum
, and Average
.
If the aggregation type is null, the value is treated as
Average
. This parameter is not supported if the policy
type is SimpleScaling
.
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> stepAdjustments
This parameter is required if the policy type is
StepScaling
and not supported otherwise.
Integer estimatedInstanceWarmup
This
parameter is not supported if the policy type is
SimpleScaling
.
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
StartTime
instead.
The time for this action to start. If both Time
and
StartTime
are specified, their values must be identical.
Date startTime
2014-06-01T00:00:00Z
). If you try to schedule your action in the past, Auto Scaling returns an error message.
When StartTime
and EndTime
are specified with Recurrence
, they form the boundaries
of when the recurring action starts and stops.
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
Launch
Terminate
HealthCheck
ReplaceUnhealthy
AZRebalance
AlarmNotification
ScheduledActions
AddToLoadBalancer
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]*
String policyARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String policyType
SimpleScaling
and
StepScaling
.
Constraints:
Length: 1 - 64
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String adjustmentType
ScalingAdjustment
is interpreted. Valid values are
ChangeInCapacity
, ExactCapacity
, and
PercentChangeInCapacity
.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer minAdjustmentStep
MinAdjustmentMagnitude
instead.Integer minAdjustmentMagnitude
AdjustmentType
is PercentChangeInCapacity
,
the scaling policy changes the DesiredCapacity
of the
Auto Scaling group by at least this many instances. Otherwise, the
error is ValidationError
.Integer scalingAdjustment
Integer cooldown
com.amazonaws.internal.ListWithAutoConstructFlag<T> stepAdjustments
String metricAggregationType
Minimum
, Maximum
, and Average
.
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer estimatedInstanceWarmup
com.amazonaws.internal.ListWithAutoConstructFlag<T> alarms
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
StartTime
instead.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. Specify
True
to make Auto Scaling to wait for the cool-down
period associated with the Auto Scaling group to complete before
initiating a scaling activity to set your Auto Scaling group to its
new capacity.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 for
CreateAutoScalingGroup.
Double metricIntervalLowerBound
Double metricIntervalUpperBound
The upper bound must be greater than the lower bound.
Integer scalingAdjustment
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
Launch
Terminate
HealthCheck
ReplaceUnhealthy
AZRebalance
AlarmNotification
ScheduledActions
AddToLoadBalancer
String resourceId
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String resourceType
auto-scaling-group
.
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
.
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
true
, terminating this instance also decrements the
size of the Auto Scaling group.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, see Auto Scaling and 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, see Choosing a Termination Policy for Your Auto Scaling Group in 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
Currently, the only valid value is
CAPABILITY_IAM
, which is required for the following
resources:
AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy,
AWS::IAM::Role,
AWS::IAM::User, and
AWS::IAM::UserToGroupAddition. If your stack template contains
these resources, we recommend that you review any permissions
associated with them. If you don't specify this parameter, this action
returns an InsufficientCapabilities
error.
com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceTypes
AWS::EC2::Instance
,
AWS::EC2::*
, or Custom::MyCustomInstance
.
Use the following syntax to describe template resource types:
AWS::*
(for all AWS resource), Custom::*
(for all custom resources), Custom::logical_ID
(for a specific custom resource),
AWS::service_name::*
(for all resources of a
particular AWS service), and
AWS::service_name::resource_logical_ID
(for
a specific AWS resource). If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
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 nextToken
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> accountLimits
String nextToken
Constraints:
Length: 1 - 1024
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 templateBody
Conditional: You
must specify only one of the following parameters:
StackName
, TemplateBody
, or
TemplateURL
.
Constraints:
Length: 1 -
String templateURL
Conditional: You
must specify only one of the following parameters:
StackName
, TemplateBody
, or
TemplateURL
.
Constraints:
Length: 1 - 1024
String stackName
Conditional: You must specify only one
of the following parameters: StackName
,
TemplateBody
, or TemplateURL
.
Constraints:
Length: 1 -
Pattern: ([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
String description
Description
property of
the template.com.amazonaws.internal.ListWithAutoConstructFlag<T> capabilities
String capabilitiesReason
Capabilities
response element.com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceTypes
AWS::EC2::Instance
,
AWS::Dynamo::Table
, and
Custom::MyCustomInstance
. Use the following syntax to
describe template resource types: AWS::*
(for all AWS
resources), Custom::*
(for all custom resources),
Custom::logical_ID
(for a specific custom
resource), AWS::service_name::*
(for all resources
of a particular AWS service), and
AWS::service_name::resource_logical_ID
(for
a specific AWS resource).String version
String metadata
Metadata
property of
the template.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 parameterKey
String parameterValue
Boolean usePreviousValue
true
,
do not specify a parameter value.com.amazonaws.internal.ListWithAutoConstructFlag<T> allowedValues
String parameterKey
String defaultValue
String parameterType
Boolean noEcho
String description
ParameterConstraints parameterConstraints
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 stackName
Constraints:
Length: 1 -
Pattern: ([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)
String logicalResourceId
String uniqueId
Constraints:
Length: 1 - 64
String status
Constraints:
Allowed Values: SUCCESS, FAILURE
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, DELETE_SKIPPED, 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, DELETE_SKIPPED, 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, DELETE_SKIPPED, 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, DELETE_SKIPPED, 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. For more information, see the Parameter
data type.com.amazonaws.internal.ListWithAutoConstructFlag<T> capabilities
CAPABILITY_IAM
, which is required for the following
resources:
AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy,
AWS::IAM::Role,
AWS::IAM::User, and
AWS::IAM::UserToGroupAddition. If your stack template contains
these resources, we recommend that you review any permissions
associated with them. If you don't specify this parameter, this action
returns an InsufficientCapabilities error.com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceTypes
AWS::EC2::Instance
,
AWS::EC2::*
, or Custom::MyCustomInstance
.
If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management
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
Capabilities
response element.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
CachedMethods cachedMethods
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
Long defaultTTL
Long maxTTL
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
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
Long defaultTTL
Long maxTTL
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
String originPath
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 minimumProtocolVersion
Constraints:
Allowed Values: SSLv3, TLSv1
String label
The label of the new high-availability partition group.
String hapgArn
The ARN of the high-availability partition group.
String subnetId
The identifier of the subnet in your VPC in which to place the HSM.
String sshKey
The SSH public key to install on the HSM.
String eniIp
The IP address to assign to the HSM's ENI.
String iamRoleArn
The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
String externalId
The external ID from IamRoleArn, if present.
String subscriptionType
The subscription type.
String clientToken
A user-defined token to ensure idempotence. Subsequent calls to this action with the same token will be ignored.
String syslogIp
The IP address for the syslog monitoring server.
String hsmArn
The ARN of the HSM.
String clientArn
The ARN of the client.
String hapgArn
The ARN of the high-availability partition group to delete.
String status
The status of the action.
String hsmArn
The ARN of the HSM to delete.
String status
The status of the action.
String clientArn
The ARN of the client to delete.
String status
The status of the action.
String hapgArn
The ARN of the high-availability partition group to describe.
String hapgArn
The ARN of the high-availability partition group.
String hapgSerial
The serial number of the high-availability partition group.
com.amazonaws.internal.SdkInternalList<T> hsmsLastActionFailed
com.amazonaws.internal.SdkInternalList<T> hsmsPendingDeletion
com.amazonaws.internal.SdkInternalList<T> hsmsPendingRegistration
String label
The label for the high-availability partition group.
String lastModifiedTimestamp
The date and time the high-availability partition group was last modified.
com.amazonaws.internal.SdkInternalList<T> partitionSerialList
The list of partition serial numbers that belong to the high-availability partition group.
String state
The state of the high-availability partition group.
String hsmArn
The ARN of the HSM.
String status
The status of the HSM.
String statusDetails
Contains additional information about the status of the HSM.
String availabilityZone
The Availability Zone that the HSM is in.
String eniId
The identifier of the elastic network interface (ENI) attached to the HSM.
String eniIp
The IP address assigned to the HSM's ENI.
String subscriptionType
The subscription type.
String subscriptionStartDate
The subscription start date.
String subscriptionEndDate
The subscription end date.
String vpcId
The identifier of the VPC that the HSM is in.
String subnetId
The identifier of the subnet the HSM is in.
String iamRoleArn
The ARN of the IAM role assigned to the HSM.
String serialNumber
The serial number of the HSM.
String vendorName
The name of the HSM vendor.
String hsmType
The HSM model type.
String softwareVersion
The HSM software version.
String sshPublicKey
The public SSH key.
String sshKeyLastUpdated
The date and time the SSH key was last updated.
String serverCertUri
The URI of the certificate server.
String serverCertLastUpdated
The date and time the server certificate was last updated.
com.amazonaws.internal.SdkInternalList<T> partitions
The list of partitions on the HSM.
String clientArn
The ARN of the client.
String certificate
The certificate installed on the HSMs used by this client.
String certificateFingerprint
The certificate fingerprint.
String lastModifiedTimestamp
The date and time the client was last modified.
String label
The label of the client.
String clientArn
The ARN of the client.
String clientVersion
The client version.
com.amazonaws.internal.SdkInternalList<T> hapgList
A list of ARNs that identify the high-availability partition groups that are associated with the client.
com.amazonaws.internal.SdkInternalList<T> aZList
The list of Availability Zones that have available AWS CloudHSM capacity.
com.amazonaws.internal.SdkInternalList<T> hapgList
The list of high-availability partition groups.
String nextToken
If not null, more results are available. Pass this value to ListHapgs to retrieve the next set of items.
com.amazonaws.internal.SdkInternalList<T> hsmList
The list of ARNs that identify the HSMs.
String nextToken
If not null, more results are available. Pass this value to ListHsms to retrieve the next set of items.
String nextToken
The NextToken value from a previous call to ListLunaClients. Pass null if this is the first call.
com.amazonaws.internal.SdkInternalList<T> clientList
The list of clients.
String nextToken
If not null, more results are available. Pass this to ListLunaClients to retrieve the next set of items.
String hapgArn
The ARN of the high-availability partition group to modify.
String label
The new label for the high-availability partition group.
com.amazonaws.internal.SdkInternalList<T> partitionSerialList
The list of partition serial numbers to make members of the high-availability partition group.
String hapgArn
The ARN of the high-availability partition group.
String hsmArn
The ARN of the HSM to modify.
String subnetId
The new identifier of the subnet that the HSM is in.
String eniIp
The new IP address for the elastic network interface attached to the HSM.
String iamRoleArn
The new IAM role ARN.
String externalId
The new external ID.
String syslogIp
The new IP address for the syslog monitoring server.
String hsmArn
The ARN of the HSM.
String clientArn
The ARN of the client.
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
String id
Map<K,V> fields
Map<K,V> exprs
Map<K,V> highlights
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
You specify the expressions in JSON
using the form {"EXPRESSIONNAME":"EXPRESSION"}
. You can
define and use multiple expressions in a search request. For example:
{"expression1":"_score*rating",
"expression2":"(1/rank)*year"}
For information about the variables, operators, and functions you can use in expressions, see Writing 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.
To count particular buckets of values, use the
buckets
option. For example, the following request uses
the buckets
option to calculate and return facet counts
by decade.
{"year":{"buckets":["[1970,1979]","[1980,1989]","[1990,1999]","[2000,2009]","[2010,}"]}}
To sort facets by facet count, use the count
option. For example, the following request sets the 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.
{"year":{"sort":"count","size":3}}
To sort the facets by value, use the bucket
option. For example, the following request sets the sort
option to bucket
to sort the facet values numerically by
year, with earliest year listed first.
{"year":{"sort":"bucket"}}
For more information, see Getting and Using Facet Information in the Amazon CloudSearch Developer Guide.
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
.
For example, the following request retrieves highlights for the
actors
and title
fields.
{
"actors": {}, "title": {"format": "text","max_phrases": 2,"pre_tag":
"","post_tag": ""} }
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. You specify the options in JSON
using the following form
{"OPTION1":"VALUE1","OPTION2":VALUE2"..."OPTIONN":"VALUEN"}.
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
. 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 japaneseTokenizationDictionary
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
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
,
JapaneseTokenizationDictionary
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
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name score
is reserved and cannot
be used as a field name. To reference a document's ID, you can use the
name _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
,
JapaneseTokenizationDictionary
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_]*\*?|\*[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 -
Limits limits
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
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
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name score
is reserved and cannot
be used as a field name. To reference a document's ID, you can use the
name _id
.
Constraints:
Length: 1 - 64
Pattern: ([a-z][a-z0-9_]*\*?|\*[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
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name score
is reserved and cannot
be used as a field name. To reference a document's ID, you can use the
name _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
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name score
is reserved and cannot
be used as a field name. To reference a document's ID, you can use the
name _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, search.m3.medium, search.m3.large, search.m3.xlarge, search.m3.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
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
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name score
is reserved and cannot
be used as a field name. To reference a document's ID, you can use the
name _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
String s3BucketName
String s3KeyPrefix
String snsTopicName
Boolean includeGlobalServiceEvents
String cloudWatchLogsLogGroupArn
String cloudWatchLogsRoleArn
String name
String s3BucketName
String s3KeyPrefix
String snsTopicName
Boolean includeGlobalServiceEvents
String cloudWatchLogsLogGroupArn
String cloudWatchLogsRoleArn
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> trailNameList
com.amazonaws.internal.ListWithAutoConstructFlag<T> trailList
String eventId
String eventName
Date eventTime
String username
com.amazonaws.internal.ListWithAutoConstructFlag<T> resources
String cloudTrailEvent
String name
Boolean isLogging
String latestDeliveryError
String latestNotificationError
Date latestDeliveryTime
Date latestNotificationTime
Date startLoggingTime
Date stopLoggingTime
String latestCloudWatchLogsDeliveryError
Date latestCloudWatchLogsDeliveryTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> lookupAttributes
Date startTime
Date endTime
Integer maxResults
Constraints:
Range: 1 - 50
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String nextToken
String resourceType
String resourceName
String name
String name
String name
String s3BucketName
String s3KeyPrefix
String snsTopicName
Boolean includeGlobalServiceEvents
String cloudWatchLogsLogGroupArn
String cloudWatchLogsRoleArn
String name
String s3BucketName
String s3KeyPrefix
String snsTopicName
Boolean includeGlobalServiceEvents
String cloudWatchLogsLogGroupArn
String cloudWatchLogsRoleArn
String name
String s3BucketName
String s3KeyPrefix
String snsTopicName
Boolean includeGlobalServiceEvents
String cloudWatchLogsLogGroupArn
String cloudWatchLogsRoleArn
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 repositoryName
The name of the repository in which you want to create the new branch.
String branchName
The name of the new branch to create.
String commitId
The ID of the commit to point the new branch to.
String repositoryName
The name of the new repository to be created.
String repositoryDescription
A comment or description about the new repository.
RepositoryMetadata repositoryMetadata
Information about the newly created repository.
String repositoryName
The name of the repository to delete.
String repositoryId
The ID of the repository that was deleted.
BranchInfo branch
The name of the branch.
String repositoryName
The name of the repository to get information about.
RepositoryMetadata repositoryMetadata
Information about the repository.
String nextToken
An enumeration token that allows the operation to batch the results of the operation. Batch sizes are 1,000 for list repository operations. When the client sends the token back to AWS CodeCommit, another page of 1,000 records is retrieved.
String sortBy
The criteria used to sort the results of a list repositories operation.
String order
The order in which to sort the results of a list repositories operation.
List<E> repositories
Lists the repositories called by the list repositories operation.
String nextToken
An enumeration token that allows the operation to batch the results of the operation. Batch sizes are 1,000 for list repository operations. When the client sends the token back to AWS CodeCommit, another page of 1,000 records is retrieved.
String accountId
The ID of the AWS account associated with the repository.
String repositoryId
The ID of the repository.
String repositoryName
The repository's name.
String repositoryDescription
A comment or description about the repository.
String defaultBranch
The repository's default branch name.
Date lastModifiedDate
The date and time the repository was last modified, in timestamp format.
Date creationDate
The date and time the repository was created, in timestamp format.
String cloneUrlHttp
The URL to use for cloning the repository over HTTPS.
String cloneUrlSsh
The URL to use for cloning the repository over SSH.
String arn
The Amazon Resource Name (ARN) of the repository.
com.amazonaws.internal.SdkInternalList<T> tags
The tag key-value pairs to add to the on-premises instances.
com.amazonaws.internal.SdkInternalList<T> instanceNames
The names of the on-premises instances to add tags to.
String applicationId
The application ID.
String applicationName
The application name.
Date createTime
The time that the application was created.
Boolean linkedToGitHub
True if the user has authenticated with GitHub for the specified application; otherwise, false.
com.amazonaws.internal.SdkInternalList<T> applicationNames
A list of application names, with multiple application names separated by spaces.
com.amazonaws.internal.SdkInternalList<T> applicationsInfo
Information about the applications.
com.amazonaws.internal.SdkInternalList<T> deploymentIds
A list of deployment IDs, with multiple deployment IDs separated by spaces.
com.amazonaws.internal.SdkInternalList<T> deploymentsInfo
Information about the deployments.
com.amazonaws.internal.SdkInternalList<T> instanceNames
The names of the on-premises instances to get information about.
com.amazonaws.internal.SdkInternalList<T> instanceInfos
Information about the on-premises instances.
String applicationName
The name of the application. This name must be unique with the applicable IAM user or AWS account.
String applicationId
A unique application ID.
String deploymentConfigName
The name of the deployment configuration to create.
MinimumHealthyHosts minimumHealthyHosts
The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.
The type parameter takes either of the following values:
The value parameter takes an integer.
For example, to set a minimum of 95% healthy instances, specify a type of FLEET_PERCENT and a value of 95.
String deploymentConfigId
A unique deployment configuration ID.
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String deploymentGroupName
The name of an existing deployment group for the specified application.
String deploymentConfigName
If specified, the deployment configuration name must be one of the predefined values, or it can be a custom deployment configuration:
To create a custom deployment configuration, call the create deployment configuration operation.
com.amazonaws.internal.SdkInternalList<T> ec2TagFilters
The Amazon EC2 tags to filter on.
com.amazonaws.internal.SdkInternalList<T> onPremisesInstanceTagFilters
The on-premises instance tags to filter on.
com.amazonaws.internal.SdkInternalList<T> autoScalingGroups
A list of associated Auto Scaling groups.
String serviceRoleArn
A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.
String deploymentGroupId
A unique deployment group ID.
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String deploymentGroupName
The deployment group's name.
RevisionLocation revision
The type of revision to deploy, along with information about the revision's location.
String deploymentConfigName
The name of an existing deployment configuration associated with the applicable IAM user or AWS account.
If not specified, the value configured in the deployment group will be used as the default. If the deployment group does not have a deployment configuration associated with it, then CodeDeployDefault.OneAtATime will be used by default.
String description
A comment about the deployment.
Boolean ignoreApplicationStopFailures
If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.
If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed.
String deploymentId
A unique deployment ID.
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String deploymentConfigName
The name of an existing deployment configuration associated with the applicable IAM user or AWS account.
com.amazonaws.internal.SdkInternalList<T> hooksNotCleanedUp
If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling. If the output does contain data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group.
String deploymentConfigId
The deployment configuration ID.
String deploymentConfigName
The deployment configuration name.
MinimumHealthyHosts minimumHealthyHosts
Information about the number or percentage of minimum healthy instances.
Date createTime
The time that the deployment configuration was created.
String applicationName
The application name.
String deploymentGroupId
The deployment group ID.
String deploymentGroupName
The deployment group name.
String deploymentConfigName
The deployment configuration name.
com.amazonaws.internal.SdkInternalList<T> ec2TagFilters
The Amazon EC2 tags to filter on.
com.amazonaws.internal.SdkInternalList<T> onPremisesInstanceTagFilters
The on-premises instance tags to filter on.
com.amazonaws.internal.SdkInternalList<T> autoScalingGroups
A list of associated Auto Scaling groups.
String serviceRoleArn
A service role ARN.
RevisionLocation targetRevision
Information about the deployment group's target revision, including the revision's type and its location.
String applicationName
The application name.
String deploymentGroupName
The deployment group name.
String deploymentConfigName
The deployment configuration name.
String deploymentId
The deployment ID.
RevisionLocation revision
Information about the location of application artifacts that are stored and the service to retrieve them from.
String status
The current state of the deployment as a whole.
ErrorInformation errorInformation
Information about any error associated with this deployment.
Date createTime
A timestamp indicating when the deployment was created.
Date startTime
A timestamp indicating when the deployment began deploying to the deployment group.
Note that in some cases, the reported value of the start time may be later than the complete time. This is due to differences in the clock settings of various back-end servers that participate in the overall deployment process.
Date completeTime
A timestamp indicating when the deployment was completed.
DeploymentOverview deploymentOverview
A summary of the deployment status of the instances in the deployment.
String description
A comment about the deployment.
String creator
How the deployment was created:
Boolean ignoreApplicationStopFailures
If true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.
If false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed.
Long pending
The number of instances that are pending in the deployment.
Long inProgress
The number of instances that are in progress in the deployment.
Long succeeded
The number of instances that have succeeded in the deployment.
Long failed
The number of instances that have failed in the deployment.
Long skipped
The number of instances that have been skipped in the deployment.
String instanceName
The name of the on-premises instance to deregister.
String errorCode
The associated error code:
String scriptName
The name of the script.
String message
The message associated with the error.
String logTail
The last portion of the associated diagnostic log.
String code
The error code:
String message
An accompanying error message.
String description
A comment about the revision.
com.amazonaws.internal.SdkInternalList<T> deploymentGroups
A list of deployment groups that use this revision.
Date firstUsedTime
When the revision was first used by AWS CodeDeploy.
Date lastUsedTime
When the revision was last used by AWS CodeDeploy.
Date registerTime
When the revision was registered with AWS CodeDeploy.
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
ApplicationInfo application
Information about the application.
String applicationName
The name of the application that corresponds to the revision.
RevisionLocation revision
Information about the application revision to get, including the revision's type and its location.
String applicationName
The name of the application that corresponds to the revision.
RevisionLocation revision
Additional information about the revision, including the revision's type and its location.
GenericRevisionInfo revisionInfo
General information about the revision.
String deploymentConfigName
The name of an existing deployment configuration associated with the applicable IAM user or AWS account.
DeploymentConfigInfo deploymentConfigInfo
Information about the deployment configuration.
DeploymentGroupInfo deploymentGroupInfo
Information about the deployment group.
InstanceSummary instanceSummary
Information about the instance.
String deploymentId
An existing deployment ID associated with the applicable IAM user or AWS account.
DeploymentInfo deploymentInfo
Information about the deployment.
String instanceName
The name of the on-premises instance to get information about
InstanceInfo instanceInfo
Information about the on-premises instance.
String repository
The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision.
Specified as account/repository.
String commitId
The SHA1 commit ID of the GitHub commit that references the that represents the bundled artifacts for the application revision.
String instanceName
The name of the on-premises instance.
String iamUserArn
The IAM user ARN associated with the on-premises instance.
String instanceArn
The ARN of the on-premises instance.
Date registerTime
The time that the on-premises instance was registered.
Date deregisterTime
If the on-premises instance was deregistered, the time that the on-premises instance was deregistered.
com.amazonaws.internal.SdkInternalList<T> tags
Information about the tags for the on-premises instance.
String deploymentId
The deployment ID.
String instanceId
The instance ID.
String status
The deployment status for this instance:
Date lastUpdatedAt
A timestamp indicating when the instance information was last updated.
com.amazonaws.internal.SdkInternalList<T> lifecycleEvents
A list of lifecycle events for this instance.
String lifecycleEventName
The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, AfterInstall, ApplicationStart, or ValidateService.
Diagnostics diagnostics
Diagnostic information about the deployment lifecycle event.
Date startTime
A timestamp indicating when the deployment lifecycle event started.
Date endTime
A timestamp indicating when the deployment lifecycle event ended.
String status
The deployment lifecycle event status:
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String sortBy
The column name to sort the list results by:
If not specified or set to null, the results will be returned in an arbitrary order.
String sortOrder
The order to sort the list results by:
If not specified, the results will be sorted in ascending order.
If set to null, the results will be sorted in an arbitrary order.
String s3Bucket
A specific Amazon S3 bucket name to limit the search for revisions.
If set to null, then all of the user's buckets will be searched.
String s3KeyPrefix
A specific key prefix for the set of Amazon S3 objects to limit the search for revisions.
String deployed
Whether to list revisions based on whether the revision is the target revision of an deployment group:
String nextToken
An identifier that was returned from the previous list application revisions call, which can be used to return the next set of applications in the list.
com.amazonaws.internal.SdkInternalList<T> revisions
A list of revision locations that contain the matching revisions.
String nextToken
If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list application revisions call to return the next set of application revisions in the list.
String nextToken
An identifier that was returned from the previous list applications call, which can be used to return the next set of applications in the list.
com.amazonaws.internal.SdkInternalList<T> applications
A list of application names.
String nextToken
If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list applications call to return the next set of applications in the list.
String nextToken
An identifier that was returned from the previous list deployment configurations call, which can be used to return the next set of deployment configurations in the list.
com.amazonaws.internal.SdkInternalList<T> deploymentConfigsList
A list of deployment configurations, including the built-in configurations such as CodeDeployDefault.OneAtATime.
String nextToken
If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list deployment configurations call to return the next set of deployment configurations in the list.
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String nextToken
An identifier that was returned from the previous list deployment groups call, which can be used to return the next set of deployment groups in the list.
String applicationName
The application name.
com.amazonaws.internal.SdkInternalList<T> deploymentGroups
A list of corresponding deployment group names.
String nextToken
If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list deployment groups call to return the next set of deployment groups in the list.
String deploymentId
The unique ID of a deployment.
String nextToken
An identifier that was returned from the previous list deployment instances call, which can be used to return the next set of deployment instances in the list.
com.amazonaws.internal.SdkInternalList<T> instanceStatusFilter
A subset of instances to list, by status:
com.amazonaws.internal.SdkInternalList<T> instancesList
A list of instances IDs.
String nextToken
If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list deployment instances call to return the next set of deployment instances in the list.
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String deploymentGroupName
The name of an existing deployment group for the specified application.
com.amazonaws.internal.SdkInternalList<T> includeOnlyStatuses
A subset of deployments to list, by status:
TimeRange createTimeRange
A deployment creation start- and end-time range for returning a subset of the list of deployments.
String nextToken
An identifier that was returned from the previous list deployments call, which can be used to return the next set of deployments in the list.
com.amazonaws.internal.SdkInternalList<T> deployments
A list of deployment IDs.
String nextToken
If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list deployments call to return the next set of deployments in the list.
String registrationStatus
The on-premises instances registration status:
com.amazonaws.internal.SdkInternalList<T> tagFilters
The on-premises instance tags that will be used to restrict the corresponding on-premises instance names that are returned.
String nextToken
An identifier that was returned from the previous list on-premises instances call, which can be used to return the next set of on-premises instances in the list.
com.amazonaws.internal.SdkInternalList<T> instanceNames
The list of matching on-premises instance names.
String nextToken
If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list on-premises instances call to return the next set of on-premises instances in the list.
Integer value
The minimum healthy instances value.
String type
The minimum healthy instances type:
For example, for 9 instances, if a HOST_COUNT of 6 is specified, deploy to up to 3 instances at a time. The deployment succeeds if 6 or more instances are successfully deployed to; otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to 5 instances at a time. The deployment succeeds if 4 or more instances are successfully deployed to; otherwise, the deployment fails.
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String description
A comment about the revision.
RevisionLocation revision
Information about the application revision to register, including the revision's type and its location.
com.amazonaws.internal.SdkInternalList<T> tags
The tag key-value pairs to remove from the on-premises instances.
com.amazonaws.internal.SdkInternalList<T> instanceNames
The names of the on-premises instances to remove tags from.
String revisionType
The application revision's type:
S3Location s3Location
GitHubLocation gitHubLocation
String bucket
The name of the Amazon S3 bucket where the application revision is stored.
String key
The name of the Amazon S3 object that represents the bundled artifacts for the application revision.
String bundleType
The file type of the application revision. Must be one of the following:
String version
A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.
If the version is not specified, the system will use the most recent version by default.
String eTag
The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.
If the ETag is not specified as an input parameter, ETag validation of the object will be skipped.
String deploymentId
The unique ID of a deployment.
String applicationName
The application name corresponding to the deployment group to update.
String currentDeploymentGroupName
The current name of the existing deployment group.
String newDeploymentGroupName
The new name of the deployment group, if you want to change it.
String deploymentConfigName
The replacement deployment configuration name to use, if you want to change it.
com.amazonaws.internal.SdkInternalList<T> ec2TagFilters
The replacement set of Amazon EC2 tags to filter on, if you want to change them.
com.amazonaws.internal.SdkInternalList<T> onPremisesInstanceTagFilters
The replacement set of on-premises instance tags for filter on, if you want to change them.
com.amazonaws.internal.SdkInternalList<T> autoScalingGroups
The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.
String serviceRoleArn
A replacement service role's ARN, if you want to change it.
com.amazonaws.internal.SdkInternalList<T> hooksNotCleanedUp
If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the AWS account. If the output does contain data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the AWS account.
String status
Whether the job worker has received the specified job.
String jobId
The unique system-generated ID of the job.
String nonce
A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.
String clientToken
The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
String status
The status information for the third party job, if any.
String name
The name of the action configuration property.
Boolean required
Whether the configuration property is a required value.
Boolean key
Whether the configuration property is a key.
Boolean secret
Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.
When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret.
Boolean queryable
Indicates that the proprety will be used in conjunction with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.
If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
String description
The description of the action configuration property that will be displayed to users.
String type
The type of the configuration property.
String name
The name of the action within the context of a job.
String name
The action declaration's name.
ActionTypeId actionTypeId
The configuration information for the action type.
Integer runOrder
The order in which actions are run.
Map<K,V> configuration
The action declaration's configuration.
List<E> outputArtifacts
The name or ID of the result of the action declaration, such as a test or build artifact.
List<E> inputArtifacts
The name or ID of the artifact consumed by the action, such as a test or build artifact.
String roleArn
The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline.
String status
The status of the action, or for a completed action, the last status of the action.
String summary
A summary of the run of the action.
Date lastStatusChange
The last status change of the action.
String externalExecutionId
The external ID of the run of the action.
String externalExecutionUrl
The URL of a resource external to AWS that will be used when running the action, for example an external repository URL.
Integer percentComplete
A percentage of completeness of the action as it runs.
ErrorDetails errorDetails
The details of an error returned by a URL external to AWS.
String revisionId
The system-generated unique ID that identifies the revision number of the action.
String revisionChangeId
The unique identifier of the change that set the state to this revision, for example a deployment ID or timestamp.
Date created
The date and time when the most recent version of the action was created, in timestamp format.
String actionName
The name of the action.
ActionRevision currentRevision
ActionExecution latestExecution
String entityUrl
A URL link for more information about the state of the action, such as a deployment group details page.
String revisionUrl
A URL link for more information about the revision, such as a commit details page.
ActionTypeId id
ActionTypeSettings settings
The settings for the action type.
List<E> actionConfigurationProperties
The configuration properties for the action type.
ArtifactDetails inputArtifactDetails
The details of the input artifact for the action, such as its commit ID.
ArtifactDetails outputArtifactDetails
The details of the output artifact of the action, such as its commit ID.
String category
A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below.
String owner
The creator of the action being called.
String provider
The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy.
String version
A string that identifies the action type.
String thirdPartyConfigurationUrl
The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.
String entityUrlTemplate
The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display within the pipeline.
String executionUrlTemplate
The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.
String revisionUrlTemplate
The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
String name
The artifact's name.
String revision
The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).
ArtifactLocation location
The location of an artifact.
String type
The type of artifact in the location.
S3ArtifactLocation s3Location
The Amazon S3 bucket that contains the artifact.
String type
The type of the artifact store, such as S3.
String location
The location for storing the artifacts for a pipeline, such as an S3 bucket or folder.
EncryptionKey encryptionKey
String category
The category of the custom action, such as a source action or a build action.
String provider
The provider of the service used in the custom action, such as AWS CodeDeploy.
String version
The version number of the custom action.
1
. This is required.ActionTypeSettings settings
List<E> configurationProperties
The configuration properties for the custom action.
ArtifactDetails inputArtifactDetails
ArtifactDetails outputArtifactDetails
ActionType actionType
PipelineDeclaration pipeline
PipelineDeclaration pipeline
String name
The name of the pipeline to be deleted.
String pipelineName
The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
String stageName
The name of the stage where you want to disable the inbound or outbound transition of artifacts.
String transitionType
Specifies whether artifacts will be prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).
String reason
The reason given to the user why a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.
String pipelineName
The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.
String stageName
The name of the stage where you want to enable the transition of artifacts, either into the stage (inbound) or from that stage to the next stage (outbound).
String transitionType
Specifies whether artifacts will be allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already-processed artifacts will be allowed to transition to the next stage (outbound).
String summary
The summary of the current status of the actions.
String externalExecutionId
The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.
Integer percentComplete
The percentage of work completed on the action, represented on a scale of zero to one hundred percent.
String jobId
The unique system-generated ID for the job.
JobDetails jobDetails
The details of the job.
If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.
PipelineDeclaration pipeline
String name
The name of the pipeline about which you want to get information.
String pipelineName
The name of the pipeline for which you want to get the state.
Integer pipelineVersion
The version number of the pipeline.
1
.List<E> stageStates
A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.
Date created
The date and time the pipeline was created, in timestamp format.
Date updated
The date and time the pipeline was last updated, in timestamp format.
ThirdPartyJobDetails jobDetails
The details of the job, including any protected values defined for the job.
String name
The name of the artifact to be worked on, for example, "My App".
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
String id
The unique system-generated ID of the job.
JobData data
Additional data about a job.
String nonce
A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.
String accountId
The ID of the AWS account to use when performing the job.
ActionTypeId actionTypeId
ActionConfiguration actionConfiguration
PipelineContext pipelineContext
List<E> inputArtifacts
The artifact supplied to the job.
List<E> outputArtifacts
The output of the job.
AWSSessionCredentials artifactCredentials
String continuationToken
A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.
EncryptionKey encryptionKey
String nextToken
An identifier that was returned from the previous list pipelines call, which can be used to return the next set of pipelines in the list.
String name
The name of the output of an artifact, such as "My App".
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
Output artifact names must be unique within a pipeline.
String pipelineName
The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.
StageContext stage
The stage of the pipeline.
ActionContext action
String name
The name of the action to be performed.
String roleArn
The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.
ArtifactStore artifactStore
List<E> stages
The stage in which to perform the action.
Integer version
The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically incremented when a pipeline is updated.
ActionTypeId actionTypeId
Integer maxBatchSize
The maximum number of jobs to return in a poll for jobs call.
Map<K,V> queryParam
A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value will be returned.
ActionTypeId actionTypeId
Integer maxBatchSize
The maximum number of jobs to return in a poll for jobs call.
String pipelineName
The name of the pipeline that will start processing the revision to the source.
String stageName
The name of the stage that contains the action that will act upon the revision.
String actionName
The name of the action that will process the revision.
ActionRevision actionRevision
String jobId
The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.
FailureDetails failureDetails
The details about the failure of a job.
String jobId
The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.
CurrentRevision currentRevision
The ID of the current revision of the artifact successfully worked upon by the job.
String continuationToken
A system-generated token, such as a AWS CodeDeploy deployment ID, that the successful job used to complete a job asynchronously.
ExecutionDetails executionDetails
The execution details of the successful job, such as the actions taken by the job worker.
String jobId
The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.
String clientToken
The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
FailureDetails failureDetails
String jobId
The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs.
String clientToken
The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
CurrentRevision currentRevision
String continuationToken
A system-generated token, such as a AWS CodeDeploy deployment ID, that a job uses in order to continue the job asynchronously.
ExecutionDetails executionDetails
String name
The name of the stage.
String stageName
The name of the stage.
TransitionState inboundTransitionState
The state of the inbound transition, which is either enabled or disabled.
List<E> actionStates
The state of the stage.
String name
The name of the pipeline to start.
String pipelineExecutionId
The unique system-generated ID of the pipeline that was started.
ActionTypeId actionTypeId
ActionConfiguration actionConfiguration
PipelineContext pipelineContext
List<E> inputArtifacts
The name of the artifact that will be worked upon by the action, if any. This name might be system-generated, such as "MyApp", or might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.
List<E> outputArtifacts
The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or might be defined by the user when the action is created.
AWSSessionCredentials artifactCredentials
String continuationToken
A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.
EncryptionKey encryptionKey
String id
The identifier used to identify the job details in AWS CodePipeline.
ThirdPartyJobData data
The data to be returned by the third party job worker.
String nonce
A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.
Boolean enabled
Whether the transition between stages is enabled (true) or disabled (false).
String lastChangedBy
The ID of the user who last changed the transition state.
Date lastChangedAt
The timestamp when the transition state was last changed.
String disabledReason
The user-specified reason why the transition between two stages of a pipeline was disabled.
PipelineDeclaration pipeline
The name of the pipeline to be updated.
PipelineDeclaration pipeline
The structure of the updated pipeline.
String identityPoolName
A string that you provide.
Boolean allowUnauthenticatedIdentities
TRUE if the identity pool supports unauthenticated logins.
Map<K,V> supportedLoginProviders
Optional key:value pairs mapping provider names to provider app IDs.
String developerProviderName
The "domain" by which Cognito will refer to your users. This name acts as
a placeholder that allows your backend and the Cognito service to
communicate about the developer provider. For the
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.
List<E> openIdConnectProviderARNs
A list of OpendID Connect provider ARNs.
String identityPoolId
String identityPoolName
A string that you provide.
Boolean allowUnauthenticatedIdentities
Map<K,V> supportedLoginProviders
Optional key:value pairs mapping provider names to provider app IDs.
String developerProviderName
The "domain" by which Cognito will refer to your users.
List<E> openIdConnectProviderARNs
A list of OpendID Connect provider ARNs.
String accessKeyId
The Access Key portion of the credentials.
String secretKey
The Secret Access Key portion of the credentials
String sessionToken
The Session Token portion of the credentials
Date expiration
The date at which these credentials will expire.
String identityPoolId
String identityPoolId
String identityPoolId
String identityPoolName
A string that you provide.
Boolean allowUnauthenticatedIdentities
Map<K,V> supportedLoginProviders
Optional key:value pairs mapping provider names to provider app IDs.
String developerProviderName
The "domain" by which Cognito will refer to your users.
List<E> openIdConnectProviderARNs
A list of OpendID Connect provider ARNs.
String identityId
A unique identifier in the format REGION:GUID.
String identityId
List<E> logins
Date creationDate
Date on which the identity was created.
Date lastModifiedDate
Date on which the identity was last modified.
String identityId
A unique identifier in the format REGION:GUID.
Credentials credentials
Credentials for the provided identity ID.
String identityPoolId
An identity pool ID in the format REGION:GUID.
String accountId
String identityPoolId
Map<K,V> logins
A set of optional name-value pairs that map provider names to provider tokens.
The available provider names for Logins
are as follows:
graph.facebook.com
accounts.google.com
www.amazon.com
api.twitter.com
www.digits.com
String identityId
String identityPoolId
An identity pool ID in the format REGION:GUID.
String identityId
A unique identifier in the format REGION:GUID.
Map<K,V> logins
A set of optional name-value pairs that map provider names to provider
tokens. Each name-value pair represents a user from a public provider or
developer provider. If the user is from a developer provider, the
name-value pair will follow the syntax
"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.
Long tokenDuration
The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration.
String identityId
Map<K,V> logins
String identityId
List<E> logins
Date creationDate
Date on which the identity was created.
Date lastModifiedDate
Date on which the identity was last modified.
String identityPoolId
Integer maxResults
String nextToken
Boolean hideDisabled
An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.
String identityPoolId
An identity pool ID in the format REGION:GUID.
String identityId
A unique identifier in the format REGION:GUID.
String developerUserIdentifier
A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.
Integer maxResults
The maximum number of identities to return.
String nextToken
A pagination token. The first call you make will have
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.
String identityId
A unique identifier in the format REGION:GUID.
List<E> developerUserIdentifierList
This is the list of developer user identifiers associated with an identity ID. Cognito supports the association of multiple developer user identifiers with an identity ID.
String nextToken
A pagination token. The first call you make will have
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.
String sourceUserIdentifier
User identifier for the source user. The value should be a
DeveloperUserIdentifier
.
String destinationUserIdentifier
User identifier for the destination user. The value should be a
DeveloperUserIdentifier
.
String developerProviderName
The "domain" by which Cognito will refer to your users. This is a
(pseudo) domain name that you provide while creating an identity pool.
This name acts as a placeholder that allows your backend and the Cognito
service to communicate about the developer provider. For the
DeveloperProviderName
, you can use letters as well as period
(.), underscore (_), and dash (-).
String identityPoolId
An identity pool ID in the format REGION:GUID.
String identityId
A unique identifier in the format REGION:GUID.
String identityId
A unique identifier in the format REGION:GUID.
String identityPoolId
An identity pool ID in the format REGION:GUID.
String developerProviderName
The "domain" by which Cognito will refer to your users.
String developerUserIdentifier
String identityPoolId
String identityPoolName
A string that you provide.
Boolean allowUnauthenticatedIdentities
Map<K,V> supportedLoginProviders
Optional key:value pairs mapping provider names to provider app IDs.
String developerProviderName
The "domain" by which Cognito will refer to your users.
List<E> openIdConnectProviderARNs
A list of OpendID Connect provider ARNs.
String identityPoolId
String identityPoolName
A string that you provide.
Boolean allowUnauthenticatedIdentities
Map<K,V> supportedLoginProviders
Optional key:value pairs mapping provider names to provider app IDs.
String developerProviderName
The "domain" by which Cognito will refer to your users.
List<E> openIdConnectProviderARNs
A list of OpendID Connect provider ARNs.
String identityPoolId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
String identityPoolId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
String streamName
Constraints:
Length: 1 - 128
String roleArn
Constraints:
Length: 20 - 2048
Pattern: arn:aws:iam::\d+:role/.*
String streamingStatus
ENABLED - Streaming of updates to identity pool is enabled.
DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.
Constraints:
Allowed Values: ENABLED, DISABLED
String identityId
Constraints:
Length: 1 - 55
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 - 55
Pattern: [\w-]+:[0-9a-f-]+
String identityId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
String datasetName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+
Dataset dataset
String identityPoolId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
String identityId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
String datasetName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+
Dataset dataset
String identityPoolId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
IdentityPoolUsage identityPoolUsage
String identityPoolId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
String identityId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
IdentityUsage identityUsage
String identityPoolId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
String identityPoolId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
Date bulkPublishStartTime
Date bulkPublishCompleteTime
String bulkPublishStatus
NOT_STARTED - No bulk publish has been requested for this identity pool
IN_PROGRESS - Data is being published to the configured stream
SUCCEEDED - All data for the identity pool has been published to the configured stream
FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.
Constraints:
Allowed Values: NOT_STARTED, IN_PROGRESS, FAILED, SUCCEEDED
String failureMessage
String identityPoolId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
String identityPoolId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
String identityPoolId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
PushSync pushSync
CognitoStreams cognitoStreams
String identityPoolId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
Long syncSessionsCount
Long dataStorage
Date lastModifiedDate
String identityId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
String identityPoolId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
Date lastModifiedDate
Integer datasetCount
Long dataStorage
String identityPoolId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
String identityId
Constraints:
Length: 1 - 55
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 - 55
Pattern: [\w-]+:[0-9a-f-]+
String identityId
Constraints:
Length: 1 - 55
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> applicationArns
String roleArn
Constraints:
Length: 20 - 2048
Pattern: arn:aws:iam::\d+:role/.*
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 - 55
Pattern: [\w-]+:[0-9a-f-]+
String identityId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
String platform
Constraints:
Allowed Values: APNS, APNS_SANDBOX, GCM, ADM
String token
String deviceId
Constraints:
Length: 1 - 256
String identityPoolId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
PushSync pushSync
CognitoStreams cognitoStreams
String identityPoolId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
PushSync pushSync
CognitoStreams cognitoStreams
String identityPoolId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
String identityId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
String datasetName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+
String deviceId
Constraints:
Length: 1 - 256
String identityPoolId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
String identityId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
String datasetName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+
String deviceId
Constraints:
Length: 1 - 256
String identityPoolId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
String identityId
Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+
String datasetName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+
String deviceId
Constraints:
Length: 1 - 256
com.amazonaws.internal.ListWithAutoConstructFlag<T> recordPatches
String syncSessionToken
String clientContext
com.amazonaws.internal.ListWithAutoConstructFlag<T> records
String lastStatus
Constraints:
Allowed Values: Success, Failure, Not_Applicable
String lastErrorCode
String lastErrorMessage
Date lastAttemptTime
Date lastSuccessfulTime
String lastStatus
Note Providing an SNS topic on a DeliveryChannel for AWS Config is optional. If the SNS delivery is turned off, the last status will be Not_Applicable.
Constraints:
Allowed Values: Success, Failure, Not_Applicable
String lastErrorCode
String lastErrorMessage
Date lastStatusChangeTime
String version
String accountId
Date configurationItemCaptureTime
String configurationItemStatus
Constraints:
Allowed Values: Ok, Failed, Discovered, Deleted
String configurationStateId
String configurationItemMD5Hash
You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.
String arn
String resourceType
Constraints:
Allowed Values: AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway
String resourceId
sg-xxxxxx
).String resourceName
String awsRegion
String availabilityZone
Date resourceCreationTime
Map<K,V> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> relatedEvents
A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What is AWS CloudTrail?.
An empty field indicates that the current configuration was not initiated by any event.
com.amazonaws.internal.ListWithAutoConstructFlag<T> relationships
String configuration
String name
Constraints:
Length: 1 - 256
String roleARN
RecordingGroup recordingGroup
String name
Date lastStartTime
Date lastStopTime
Boolean recording
String lastStatus
Constraints:
Allowed Values: Pending, Success, Failure
String lastErrorCode
String lastErrorMessage
Date lastStatusChangeTime
String deliveryChannelName
Constraints:
Length: 1 - 256
String deliveryChannelName
Constraints:
Length: 1 - 256
String configSnapshotId
String name
Constraints:
Length: 1 - 256
String s3BucketName
String s3KeyPrefix
String snsTopicARN
String name
ConfigExportDeliveryInfo configSnapshotDeliveryInfo
ConfigExportDeliveryInfo configHistoryDeliveryInfo
ConfigStreamDeliveryInfo configStreamDeliveryInfo
com.amazonaws.internal.ListWithAutoConstructFlag<T> configurationRecorderNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> configurationRecorders
com.amazonaws.internal.ListWithAutoConstructFlag<T> configurationRecorderNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> configurationRecordersStatus
com.amazonaws.internal.ListWithAutoConstructFlag<T> deliveryChannelNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> deliveryChannels
com.amazonaws.internal.ListWithAutoConstructFlag<T> deliveryChannelNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> deliveryChannelsStatus
String resourceType
Constraints:
Allowed Values: AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway
String resourceId
sg-xxxxxx
).Date laterTime
Date earlierTime
String chronologicalOrder
Constraints:
Allowed Values: Reverse, Forward
Integer limit
Constraints:
Range: 0 - 100
String nextToken
nextToken
string returned on a previous page that you
use to get the next page of results in a paginated response.com.amazonaws.internal.ListWithAutoConstructFlag<T> configurationItems
String nextToken
String resourceType
Constraints:
Allowed Values: AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway
com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceIds
String resourceName
Integer limit
Constraints:
Range: 0 - 100
Boolean includeDeletedResources
String nextToken
nextToken
string returned on a previous page that you
use to get the next page of results in a paginated response.com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceIdentifiers
String nextToken
ConfigurationRecorder configurationRecorder
DeliveryChannel deliveryChannel
Boolean allSupported
com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceTypes
AWS::EC2::Instance
or
AWS::CloudTrail::Trail
). resourceTypes is only
valid if you have chosen not to select allSupported. For a list
of valid resourceTypes values, see the resourceType
Value column in the following topic: Supported
AWS Resource Types.String resourceType
Constraints:
Allowed Values: AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway
String resourceId
sg-xxxxxx
).String resourceName
String relationshipName
String resourceType
Constraints:
Allowed Values: AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway
String resourceId
sg-xxxxxx
).String resourceName
Date resourceDeletionTime
String configurationRecorderName
Constraints:
Length: 1 - 256
String configurationRecorderName
Constraints:
Length: 1 - 256
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterValues
Date startTimestamp
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Constraints:
Length: 0 - 10
String name
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String uniqueId
CreatePipeline
. For example, if the first call to
CreatePipeline
does not succeed, you can pass in the same
unique identifier and pipeline name combination on a subsequent call
to CreatePipeline
. CreatePipeline
ensures
that if a pipeline already exists with the same name and unique
identifier, a new pipeline is not created. Instead, you'll receive the
pipeline identifier from the previous attempt. The uniqueness of the
name and unique identifier combination is scoped to the AWS account or
IAM user credentials.
Constraints:
Length: 1 - 1024
Pattern: [\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]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Constraints:
Length: 0 - 10
String pipelineId
df-06372391ZG65EXAMPLE
.
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]*
Boolean cancelActive
CANCELED
.
If this value is false, the pipeline is deactivated after all running
objects finish.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
DescribeObjects
.Boolean evaluateExpressions
String marker
DescribeObjects
with the marker value
from the previous call 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
DescribeObjects
again with this marker
value. If the value is null, there are no more results.
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean hasMoreResults
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) to use the last definition saved to
the pipeline or active
to use the last definition 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
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterObjects
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterValues
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
ListPipelines
with the marker value from
the previous call 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
ListPipelinesOutput
again with this
marker value. If the value is null, there are no more results.
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean hasMoreResults
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 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 id
Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
String id
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 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]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Constraints:
Length: 0 - 10
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
. For
more information, see 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
taskId
, which contains an identifier for the task being
assigned. The calling task runner uses taskId
in
subsequent calls to ReportTaskProgress and
SetTaskStatus.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> parameterObjects
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterValues
com.amazonaws.internal.ListWithAutoConstructFlag<T> validationErrors
pipelineObjects
.com.amazonaws.internal.ListWithAutoConstructFlag<T> validationWarnings
pipelineObjects
.Boolean errored
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
Query
object can contain a maximum of ten selectors. The
conditions in the query are limited to top-level String fields in the
object. These filters can be applied to components, instances, and
attempts.String sphere
COMPONENT
, INSTANCE
,
and ATTEMPT
.
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String marker
QueryObjects
with the marker value from
the previous call 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
QueryObjects
will
return in a single call. The default value is 100.com.amazonaws.internal.ListWithAutoConstructFlag<T> ids
String marker
QueryObjects
again with this marker
value. If the value is null, there are no more results.
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean hasMoreResults
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
String taskId
Constraints:
Length: 1 - 2048
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> fields
Boolean canceled
String taskrunnerId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String workerGroup
workerGroup
. 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
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, use PAUSE
or
RESUME
. For instances, use TRY_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. Preconditions use
false.
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 key
Constraints:
Length: 1 - 128
String value
Constraints:
Length: 0 - 256
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> parameterObjects
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterValues
com.amazonaws.internal.ListWithAutoConstructFlag<T> validationErrors
com.amazonaws.internal.ListWithAutoConstructFlag<T> validationWarnings
Boolean errored
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 arn
The artifact's ARN.
String name
The artifact's name.
String type
The artifact's type.
Allowed values include the following:
APPIUM_JAVA_OUTPUT: The Appium Java output type.
APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type.
APPIUM_SERVER_OUTPUT: The Appium server output type.
AUTOMATION_OUTPUT: The automation output type.
CALABASH_JSON_OUTPUT: The Calabash JSON output type.
CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type.
CALABASH_PRETTY_OUTPUT: The Calabash pretty output type.
CALABASH_STANDARD_OUTPUT: The Calabash standard output type.
DEVICE_LOG: The device log type.
EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test.
INSTRUMENTATION_OUTPUT: The instrumentation type.
MESSAGE_LOG: The message log type.
RESULT_LOG: The result log type.
SCREENSHOT: The screenshot type.
SERVICE_LOG: The service log type.
UNKNOWN: An unknown type.
String extension
The artifact's file extension.
String url
The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the artifact's file.
Integer total
The total number of entities.
Integer passed
The number of passed entities.
Integer failed
The number of failed entities.
Integer warned
The number of warned entities.
Integer errored
The number of errored entities.
Integer stopped
The number of stopped entities.
Integer skipped
The number of skipped entities.
DevicePool devicePool
The newly created device pool.
String name
The project's name.
Project project
The newly created project.
String projectArn
The ARN of the project for the upload.
String name
The upload's file name.
String type
The upload's upload type.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
String contentType
The upload's content type (for example, "application/octet-stream").
Upload upload
The newly created upload.
String arn
The device's ARN.
String name
The device's display name.
String manufacturer
The device's manufacturer name.
String model
The device's model name.
String formFactor
The device's form factor.
Allowed values include:
PHONE: The phone form factor.
TABLET: The tablet form factor.
String platform
The device's platform.
Allowed values include:
ANDROID: The Android platform.
IOS: The iOS platform.
String os
The device's operating system type.
CPU cpu
Information about the device's CPU.
Resolution resolution
Long heapSize
The device's heap size, expressed in bytes.
Long memory
The device's total memory size, expressed in bytes.
String image
The device's image name.
String carrier
The device's carrier.
String radio
The device's radio.
String arn
The device pool's ARN.
String name
The device pool's name.
String description
The device pool's description.
String type
The device pool's type.
Allowed values include:
CURATED: A device pool that is created and managed by AWS Device Farm.
PRIVATE: A device pool that is created and managed by the device pool developer.
List<E> rules
Information about the device pool's rules.
AccountSettings accountSettings
String devicePoolArn
The device pool's ARN.
String appArn
The ARN of the app that is associated with the specified device pool.
String testType
The test type for the specified device pool.
Allowed values include the following:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
String arn
The device pool's ARN.
DevicePool devicePool
String arn
The device type's ARN.
Device device
String arn
The job's ARN.
Job job
String arn
The project's ARN.
Project project
String arn
The run's ARN.
Run run
String arn
The suite's ARN.
Suite suite
String arn
The test's ARN.
Test test
String arn
The upload's ARN.
Upload upload
String arn
The job's ARN.
String name
The job's name.
String type
The job's type.
Allowed values include the following:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
Date created
When the job was created.
String status
The job's status.
Allowed values include:
COMPLETED: A completed status.
PENDING: A pending status.
PROCESSING: A processing status.
RUNNING: A running status.
SCHEDULING: A scheduling status.
String result
The job's result.
Allowed values include:
ERRORED: An error condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
STOPPED: A stopped condition.
PASSED: A passing condition.
PENDING: A pending condition.
WARNED: A warning condition.
Date started
The job's start time.
Date stopped
The job's stop time.
Counters counters
The job's result counters.
String message
A message about the job's result.
Device device
String arn
The Run, Job, Suite, or Test ARN.
String type
The artifacts' type.
Allowed values include:
String nextToken
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
String arn
The project ARN.
String type
The device pools' type.
Allowed values include:
CURATED: A device pool that is created and managed by AWS Device Farm.
PRIVATE: A device pool that is created and managed by the device pool developer.
String nextToken
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
List<E> devicePools
Information about the device pools.
String nextToken
If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
Map<K,V> uniqueProblems
Information about the unique problems.
Allowed values include:
ERRORED: An error condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
STOPPED: A stopped condition.
PASSED: A passing condition.
PENDING: A pending condition.
WARNED: A warning condition.
String nextToken
If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
ProblemDetail run
Information about the associated run.
ProblemDetail job
Information about the associated job.
ProblemDetail suite
Information about the associated suite.
ProblemDetail test
Information about the associated test.
Device device
Information about the associated device.
String result
The problem's result.
Allowed values include:
ERRORED: An error condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
STOPPED: A stopped condition.
PASSED: A passing condition.
PENDING: A pending condition.
WARNED: A warning condition.
String message
A message about the problem's result.
Boolean wifi
True if Wi-Fi is enabled at the beginning of the test; otherwise, false.
Boolean bluetooth
True if Bluetooth is enabled at the beginning of the test; otherwise, false.
Boolean nfc
True if NFC is enabled at the beginning of the test; otherwise, false.
Boolean gps
True if GPS is enabled at the beginning of the test; otherwise, false.
String attribute
The rule's attribute.
Allowed values include:
ARN: The ARN.
FORM_FACTOR: The form factor (for example, phone or tablet).
MANUFACTURER: The manufacturer.
PLATFORM: The platform (for example, Android or iOS).
String operator
The rule's operator.
EQUALS: The equals operator.
GREATER_THAN: The greater-than operator.
IN: The in operator.
LESS_THAN: The less-than operator.
NOT_IN: The not-in operator.
String value
The rule's value.
String arn
The run's ARN.
String name
The run's name.
String type
The run's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
String platform
The run's platform.
Allowed values include:
ANDROID: The Android platform.
IOS: The iOS platform.
Date created
When the run was created.
String status
The run's status.
Allowed values include:
COMPLETED: A completed status.
PENDING: A pending status.
PROCESSING: A processing status.
RUNNING: A running status.
SCHEDULING: A scheduling status.
String result
The run's result.
Allowed values include:
ERRORED: An error condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
STOPPED: A stopped condition.
PASSED: A passing condition.
PENDING: A pending condition.
WARNED: A warning condition.
Date started
The run's start time.
Date stopped
The run's stop time.
Counters counters
The run's result counters.
String message
A message about the run's result.
Integer totalJobs
The total number of jobs for the run.
Integer completedJobs
The total number of completed jobs.
String billingMethod
Specifies the billing method for a test run: metered
or
unmetered
. If the parameter is not specified, the default
value is unmetered
.
String arn
The sample's ARN.
String type
The sample's type.
Must be one of the following values:
CPU: A CPU sample type. This is expressed as the app processing CPU time (including child processes) as reported by process, as a percentage.
MEMORY: A memory usage sample type. This is expressed as the total proportional set size of an app process, in kilobytes.
NATIVE_AVG_DRAWTIME
NATIVE_FPS
NATIVE_FRAMES
NATIVE_MAX_DRAWTIME
NATIVE_MIN_DRAWTIME
OPENGL_AVG_DRAWTIME
OPENGL_FPS
OPENGL_FRAMES
OPENGL_MAX_DRAWTIME
OPENGL_MIN_DRAWTIME
RX
RX_RATE: The total number of bytes per second (TCP and UDP) that are sent, by app process.
THREADS: A threads sample type. This is expressed as the total number of threads per app process.
TX
TX_RATE: The total number of bytes per second (TCP and UDP) that are received, by app process.
String url
The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the sample's file.
String extraDataPackageArn
The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm will extract to external data for Android or the app's sandbox for iOS.
String networkProfileArn
Reserved for internal use.
String locale
Information about the locale that is used for the run.
Location location
Information about the location that is used for the run.
Radios radios
Information about the radio states for the run.
List<E> auxiliaryApps
A list of auxiliary apps for the run.
String billingMethod
Specifies the billing method for a test run: metered
or
unmetered
. If the parameter is not specified, the default
value is unmetered
.
String projectArn
The ARN of the project for the run to be scheduled.
String appArn
The ARN of the app to schedule a run.
String devicePoolArn
The ARN of the device pool for the run to be scheduled.
String name
The name for the run to be scheduled.
ScheduleRunTest test
Information about the test for the run to be scheduled.
ScheduleRunConfiguration configuration
Information about the settings for the run to be scheduled.
Run run
Information about the scheduled run.
String type
The test's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
String testPackageArn
The ARN of the uploaded test that will be run.
String filter
The test's filter.
Map<K,V> parameters
The test's parameters, such as test framework parameters and fixture settings.
String arn
The suite's ARN.
String name
The suite's name.
String type
The suite's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
Date created
When the suite was created.
String status
The suite's status.
Allowed values include:
COMPLETED: A completed status.
PENDING: A pending status.
PROCESSING: A processing status.
RUNNING: A running status.
SCHEDULING: A scheduling status.
String result
The suite's result.
Allowed values include:
ERRORED: An error condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
STOPPED: A stopped condition.
PASSED: A passing condition.
PENDING: A pending condition.
WARNED: A warning condition.
Date started
The suite's start time.
Date stopped
The suite's stop time.
Counters counters
The suite's result counters.
String message
A message about the suite's result.
String arn
The test's ARN.
String name
The test's name.
String type
The test's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
Date created
When the test was created.
String status
The test's status.
Allowed values include:
COMPLETED: A completed status.
PENDING: A pending status.
PROCESSING: A processing status.
RUNNING: A running status.
SCHEDULING: A scheduling status.
String result
The test's result.
Allowed values include:
ERRORED: An error condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
STOPPED: A stopped condition.
PASSED: A passing condition.
PENDING: A pending condition.
WARNED: A warning condition.
Date started
The test's start time.
Date stopped
The test's stop time.
Counters counters
The test's result counters.
String message
A message about the test's result.
String arn
The upload's ARN.
String name
The upload's file name.
Date created
When the upload was created.
String type
The upload's type.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
String status
The upload's status.
Must be one of the following values:
FAILED: A failed status.
INITIALIZED: An initialized status.
PROCESSING: A processing status.
SUCCEEDED: A succeeded status.
String url
The pre-signed Amazon S3 URL that was used to store a file through a corresponding PUT request.
String metadata
The upload's metadata. For example, for Android, this contains information that is parsed from the manifest and is displayed in the AWS Device Farm console after the associated app is uploaded.
String contentType
The upload's content type (for example, "application/octet-stream").
String message
A message about the upload's result.
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 requestId
String requestId
String computerId
Constraints:
Length: 1 - 256
Pattern: [&\w+-.@]+
String computerName
Constraints:
Length: 1 - 15
com.amazonaws.internal.ListWithAutoConstructFlag<T> computerAttributes
String name
corp.example.com
.
Constraints:
Pattern: ^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$
String shortName
CORP
.
Constraints:
Pattern: ^[^\\/:*?\"\<\>|.]+[^\\/:*?\"<>|]*$
String password
Constraints:
Length: 1 - 128
String description
Constraints:
Length: 0 - 128
Pattern: ^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$
String size
Constraints:
Allowed Values: Small, Large
DirectoryConnectSettings connectSettings
String directoryId
Constraints:
Pattern: ^d-[0-9a-f]{10}$
String directoryId
Constraints:
Pattern: ^d-[0-9a-f]{10}$
String alias
The alias must be unique amongst all aliases
in AWS. This operation will throw an
EntityAlreadyExistsException
if this alias already
exists.
Constraints:
Length: 1 - 62
Pattern: ^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*
String directoryId
Constraints:
Pattern: ^d-[0-9a-f]{10}$
String computerName
Constraints:
Length: 1 - 15
String password
Constraints:
Length: 8 - 64
Pattern: [\u0020-\u00FF]+
String organizationalUnitDistinguishedName
Constraints:
Length: 1 - 2000
com.amazonaws.internal.ListWithAutoConstructFlag<T> computerAttributes
Computer computer
String name
corp.example.com
.
Constraints:
Pattern: ^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$
String shortName
CORP
.
Constraints:
Pattern: ^[^\\/:*?\"\<\>|.]+[^\\/:*?\"<>|]*$
String password
Administrator
and this password.
Constraints:
Pattern: (?=^.{8,64}$)((?=.*\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[^A-Za-z0-9])(?=.*[a-z])|(?=.*[^A-Za-z0-9])(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9]))^.*
String description
Constraints:
Length: 0 - 128
Pattern: ^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$
String size
Constraints:
Allowed Values: Small, Large
DirectoryVpcSettings vpcSettings
String directoryId
Constraints:
Pattern: ^d-[0-9a-f]{10}$
String snapshotId
Constraints:
Pattern: ^s-[0-9a-f]{10}$
String directoryId
Constraints:
Pattern: ^d-[0-9a-f]{10}$
String directoryId
Constraints:
Pattern: ^d-[0-9a-f]{10}$
String snapshotId
Constraints:
Pattern: ^s-[0-9a-f]{10}$
String snapshotId
Constraints:
Pattern: ^s-[0-9a-f]{10}$
com.amazonaws.internal.ListWithAutoConstructFlag<T> directoryIds
An empty list results in an
InvalidParameterException
being thrown.
String nextToken
Integer limit
Constraints:
Range: 0 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> directoryDescriptions
It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.
String nextToken
String directoryId
Constraints:
Pattern: ^d-[0-9a-f]{10}$
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotIds
String nextToken
Integer limit
Constraints:
Range: 0 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshots
It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.
String nextToken
String vpcId
Constraints:
Pattern: ^(vpc-[0-9a-f]{8})$
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> customerDnsIps
String customerUserName
Constraints:
Length: 1 -
Pattern: [a-zA-Z0-9._-]+
String vpcId
Constraints:
Pattern: ^(vpc-[0-9a-f]{8})$
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
String customerUserName
Constraints:
Length: 1 -
Pattern: [a-zA-Z0-9._-]+
String securityGroupId
Constraints:
Pattern: ^(sg-[0-9a-f]{8})$
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> connectIps
String directoryId
Constraints:
Pattern: ^d-[0-9a-f]{10}$
String name
Constraints:
Pattern: ^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$
String shortName
Constraints:
Pattern: ^[^\\/:*?\"\<\>|.]+[^\\/:*?\"<>|]*$
String size
Constraints:
Allowed Values: Small, Large
String alias
Constraints:
Length: 1 - 62
Pattern: ^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*
String accessUrl
http://.awsapps.com
.
Constraints:
Length: 1 - 128
String description
Constraints:
Length: 0 - 128
Pattern: ^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$
com.amazonaws.internal.ListWithAutoConstructFlag<T> dnsIpAddrs
String stage
Constraints:
Allowed Values: Requested, Creating, Created, Active, Inoperable, Impaired, Restoring, RestoreFailed, Deleting, Deleted, Failed
Date launchTime
Date stageLastUpdatedDateTime
String type
Constraints:
Allowed Values: SimpleAD, ADConnector
DirectoryVpcSettingsDescription vpcSettings
DirectoryConnectSettingsDescription connectSettings
RadiusSettings radiusSettings
String radiusStatus
Constraints:
Allowed Values: Creating, Completed, Failed
String stageReason
Boolean ssoEnabled
String requestId
Integer cloudOnlyDirectoriesLimit
Constraints:
Range: 0 -
Integer cloudOnlyDirectoriesCurrentCount
Constraints:
Range: 0 -
Boolean cloudOnlyDirectoriesLimitReached
Integer connectedDirectoriesLimit
Constraints:
Range: 0 -
Integer connectedDirectoriesCurrentCount
Constraints:
Range: 0 -
Boolean connectedDirectoriesLimitReached
String requestId
String vpcId
Constraints:
Pattern: ^(vpc-[0-9a-f]{8})$
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
String vpcId
Constraints:
Pattern: ^(vpc-[0-9a-f]{8})$
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
String securityGroupId
Constraints:
Pattern: ^(sg-[0-9a-f]{8})$
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
String directoryId
Constraints:
Pattern: ^d-[0-9a-f]{10}$
String directoryId
Constraints:
Pattern: ^d-[0-9a-f]{10}$
String userName
If the AD Connector service account does not have privileges to remove a service principle name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to disable single sign-on and are not stored by the service. The AD Connector service account is not changed.
Constraints:
Length: 1 -
Pattern: [a-zA-Z0-9._-]+
String password
Constraints:
Length: 1 - 128
String directoryId
Constraints:
Pattern: ^d-[0-9a-f]{10}$
RadiusSettings radiusSettings
String directoryId
Constraints:
Pattern: ^d-[0-9a-f]{10}$
String userName
If the AD Connector service account does not have privileges to add a service principle name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to enable single sign-on and are not stored by the service. The AD Connector service account is not changed.
Constraints:
Length: 1 -
Pattern: [a-zA-Z0-9._-]+
String password
Constraints:
Length: 1 - 128
String requestId
String requestId
DirectoryLimits directoryLimits
String directoryId
Constraints:
Pattern: ^d-[0-9a-f]{10}$
SnapshotLimits snapshotLimits
String requestId
String requestId
String requestId
com.amazonaws.internal.ListWithAutoConstructFlag<T> radiusServers
Integer radiusPort
Constraints:
Range: 1025 - 65535
Integer radiusTimeout
Constraints:
Range: 1 - 20
Integer radiusRetries
Constraints:
Range: 0 - 10
String sharedSecret
Constraints:
Length: 8 - 512
String authenticationProtocol
Constraints:
Allowed Values: PAP, CHAP, MS-CHAPv1, MS-CHAPv2
String displayLabel
Constraints:
Length: 1 - 64
Boolean useSameUsername
String snapshotId
Constraints:
Pattern: ^s-[0-9a-f]{10}$
String requestId
String directoryId
Constraints:
Pattern: ^d-[0-9a-f]{10}$
String snapshotId
Constraints:
Pattern: ^s-[0-9a-f]{10}$
String type
Constraints:
Allowed Values: Auto, Manual
String name
Constraints:
Length: 0 - 128
Pattern: ^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$
String status
Constraints:
Allowed Values: Creating, Completed, Failed
Date startTime
String requestId
Integer manualSnapshotsLimit
Constraints:
Range: 0 -
Integer manualSnapshotsCurrentCount
Constraints:
Range: 0 -
Boolean manualSnapshotsLimitReached
String requestId
String directoryId
Constraints:
Pattern: ^d-[0-9a-f]{10}$
RadiusSettings radiusSettings
String s
A String data type.
String n
A Number data type.
ByteBuffer b
A Binary data type.
List<E> sS
A String Set data type.
List<E> nS
A Number Set data type.
List<E> bS
A Binary Set data type.
Map<K,V> m
A Map of attribute values.
List<E> l
A List of attribute values.
Boolean nULLValue
A Null data type.
Boolean bOOL
A Boolean data type.
AttributeValue value
String action
Specifies how to perform the update. Valid values are PUT
(default), DELETE
, and ADD
. The behavior
depends on whether the specified primary key already exists in the table.
If an item with the specified Key is found in the table:
PUT
- Adds the specified attribute to the item. If the
attribute already exists, it is replaced by the new value.
DELETE
- If no value is specified, the attribute and its
value are removed from the item. The data type of the specified value
must match the existing value's data type.
If a set of values is specified, then those values are subtracted
from the old set. For example, if the attribute value was the set
[a,b,c]
and the DELETE action specified
[a,c]
, then the final attribute value would be
[b]
. Specifying an empty set is an error.
ADD
- If the attribute does not already exist, then the
attribute and its values are added to the item. If the attribute does
exist, then the behavior of ADD
depends on the data type of
the attribute:
If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD
to increment or decrement a number value for
an item that doesn't exist before the update, DynamoDB uses 0 as the
initial value.
In addition, if you use ADD
to update an existing item, and
intend to increment or decrement an attribute value which does not yet
exist, DynamoDB uses 0
as the initial value. For example,
suppose that the item you want to update does not yet have an attribute
named itemcount, but you decide to ADD
the number
3
to this attribute anyway, even though it currently does
not exist. DynamoDB will create the itemcount attribute, set its
initial value to 0
, and finally add 3
to it.
The result will be a new itemcount attribute in the item, with a
value of 3
.
If the existing data type is a set, and if the Value is also a
set, then the Value is added to the existing set. (This is a
set operation, not mathematical addition.) For example, if the
attribute value was the set [1,2]
, and the ADD
action specified [3]
, then the final attribute value would
be [1,2,3]
. An error occurs if an Add action is specified
for a set attribute and the attribute type specified does not match the
existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid for an existing attribute whose data type is
number or is a set. Do not use ADD
for any other data types.
If no item with the specified Key is found:
PUT
- DynamoDB creates a new item with the specified primary
key, and then adds the attribute.
DELETE
- Nothing happens; there is no attribute to delete.
ADD
- DynamoDB creates an item with the supplied primary key
and number (or set of numbers) for the attribute value. The only data
types allowed are number and number set; no other data types can be
specified.
Map<K,V> requestItems
A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per BatchGetItem request.
Each element in the map of items to retrieve consists of the following:
ConsistentRead - If true
, a strongly consistent read
is used; if false
(the default), an eventually consistent
read is used.
ExpressionAttributeNames - One or more substitution tokens for attribute names in the ProjectionExpression parameter. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Keys - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide all of the key attributes. For example, with a hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
ProjectionExpression - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
AttributesToGet -
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
String returnConsumedCapacity
Map<K,V> responses
A map of table name to a list of items. Each object in Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.
Map<K,V> unprocessedKeys
A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.
Each element consists of:
Keys - An array of primary key attribute values that define specific items in the table.
AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.
ConsistentRead - The consistency of a read operation. If set to
true
, then a strongly consistent read is used; otherwise, an
eventually consistent read is used.
If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.
List<E> consumedCapacity
The read capacity units consumed by the operation.
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
Map<K,V> requestItems
A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:
DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:
Key - A map of primary key attribute values that uniquely identify the ! item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
String returnConsumedCapacity
String returnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item
collections, if any, that were modified during the operation are returned
in the response. If set to NONE
(the default), no statistics
are returned.
Map<K,V> unprocessedItems
A map of tables and requests against those tables that were not processed. The UnprocessedItems value is in the same form as RequestItems, so you can provide this value directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.
Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to perform (DeleteRequest or PutRequest).
DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:
Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.
Map<K,V> itemCollectionMetrics
A list of tables that were processed by BatchWriteItem and, for each table, information about any item collections that were affected by individual DeleteItem or PutItem operations.
Each entry consists of the following subelements:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the 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.
List<E> consumedCapacity
The capacity units consumed by the operation.
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
Double capacityUnits
The total number of capacity units consumed on a table or an index.
List<E> attributeValueList
One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based
on ASCII character code values. For example, a
is greater
than A
, and a
is greater than B
.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
String comparisonOperator
A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ
: Equal. EQ
is supported for all datatypes,
including lists and maps.
AttributeValueList can contain only one AttributeValue
element of type String, Number, Binary, String Set, Number Set, or Binary
Set. If an item contains an AttributeValue element of a different
type than the one provided in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not equal
{"NS":["6", "2", "1"]}
.
NE
: Not equal. NE
is supported for all
datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of
type String, Number, Binary, String Set, Number Set, or Binary Set. If an
item contains an AttributeValue of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2", "1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one AttributeValue of
type String, Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one provided
in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GE
: Greater than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
NOT_NULL
: The attribute exists. NOT_NULL
is
supported for all datatypes, including lists and maps.
This operator tests for the existence of an attribute, not its data type.
If the data type of attribute "a
" is null, and you evaluate
it using NOT_NULL
, the result is a Boolean true. This
result is because the attribute "a
" exists; its data type is
not relevant to the NOT_NULL
comparison operator.
NULL
: The attribute does not exist. NULL
is
supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data
type. If the data type of attribute "a
" is null, and you
evaluate it using NULL
, the result is a Boolean
false. This is because the attribute "a
" exists; its
data type is not relevant to the NULL
comparison operator.
CONTAINS
: Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is of type String, then the operator checks
for a substring match. If the target attribute of the comparison is of
type Binary, then the operator looks for a subsequence of the target that
matches the input. If the target attribute of the comparison is a set ("
SS
", "NS
", or "BS
"), then the
operator evaluates to true if it finds an exact match with any member of
the set.
CONTAINS is supported for lists: When evaluating "
a CONTAINS b
", "a
" can be a list; however, "
b
" cannot be a set, a map, or a list.
NOT_CONTAINS
: Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is a String, then the operator checks for the
absence of a substring match. If the target attribute of the comparison
is Binary, then the operator checks for the absence of a subsequence of
the target that matches the input. If the target attribute of the
comparison is a set ("SS
", "NS
", or "
BS
"), then the operator evaluates to true if it does
not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating "
a NOT CONTAINS b
", "a
" can be a list; however, "b
" cannot be a set, a map, or a
list.
BEGINS_WITH
: Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN
: Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN
: Greater than or equal to the first value, and less
than or equal to the second value.
AttributeValueList must contain two AttributeValue elements
of the same type, either String, Number, or Binary (not a set type). A
target attribute matches if the target value is greater than, or equal
to, the first element and less than, or equal to, the second element. If
an item contains an AttributeValue element of a different type
than the one provided in the request, the value does not match. For
example, {"S":"6"}
does not compare to
{"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
String tableName
The name of the table that was affected by the operation.
Double capacityUnits
The total number of capacity units consumed by the operation.
Capacity table
The amount of throughput consumed on the table affected by the operation.
Map<K,V> localSecondaryIndexes
The amount of throughput consumed on each local index affected by the operation.
Map<K,V> globalSecondaryIndexes
The amount of throughput consumed on each global index affected by the operation.
String indexName
The name of the global secondary index to be created.
List<E> keySchema
The key schema for the global secondary index.
Projection projection
ProvisionedThroughput provisionedThroughput
List<E> attributeDefinitions
An array of attributes that describe the key schema for the table and indexes.
String tableName
The name of the table to create.
List<E> keySchema
Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.
Each KeySchemaElement in the array is composed of:
AttributeName - The name of this key attribute.
KeyType - Determines whether the key attribute is
HASH
or RANGE
.
For a primary key that consists of a hash attribute, you must provide
exactly one element with a KeyType of HASH
.
For a primary key that consists of hash and range attributes, you must
provide exactly two elements, in this order: The first element must have
a KeyType of HASH
, and the second element must have a
KeyType of RANGE
.
For more information, see Specifying the Primary Key in the Amazon DynamoDB Developer Guide.
List<E> localSecondaryIndexes
One or more local secondary indexes (the maximum is five) to be created on the table. Each index is scoped to a given hash key value. There is a 10 GB size limit per hash key; otherwise, the size of a local secondary index is unconstrained.
Each local secondary index in the array includes the following:
IndexName - The name of the local secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same 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 provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
List<E> globalSecondaryIndexes
One or more global secondary indexes (the maximum is five) to be created on the table. Each global secondary index in the array includes the following:
IndexName - The name of the global secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the global secondary index.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY
- Only the index and primary keys are projected
into the index.
INCLUDE
- Only the specified table attributes are projected
into the index. The list of projected attributes are in
NonKeyAttributes.
ALL
- All of the table attributes are projected into the
index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.
ProvisionedThroughput provisionedThroughput
StreamSpecification streamSpecification
The settings for DynamoDB Streams on the table. These settings consist of:
StreamEnabled - Indicates whether Streams is to be enabled (true) or disabled (false).
StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values for StreamViewType are:
KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
TableDescription tableDescription
String indexName
The name of the global secondary index to be deleted.
String tableName
The name of the table from which to delete the item.
Map<K,V> key
A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
Map<K,V> expected
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the DeleteItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based
on ASCII character code values. For example, a
is greater
than A
, and a
is greater than B
.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ
: Equal. EQ
is supported for all datatypes,
including lists and maps.
AttributeValueList can contain only one AttributeValue
element of type String, Number, Binary, String Set, Number Set, or Binary
Set. If an item contains an AttributeValue element of a different
type than the one provided in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not equal
{"NS":["6", "2", "1"]}
.
NE
: Not equal. NE
is supported for all
datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of
type String, Number, Binary, String Set, Number Set, or Binary Set. If an
item contains an AttributeValue of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2", "1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one AttributeValue of
type String, Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one provided
in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GE
: Greater than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
NOT_NULL
: The attribute exists. NOT_NULL
is
supported for all datatypes, including lists and maps.
This operator tests for the existence of an attribute, not its data type.
If the data type of attribute "a
" is null, and you evaluate
it using NOT_NULL
, the result is a Boolean true. This
result is because the attribute "a
" exists; its data type is
not relevant to the NOT_NULL
comparison operator.
NULL
: The attribute does not exist. NULL
is
supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data
type. If the data type of attribute "a
" is null, and you
evaluate it using NULL
, the result is a Boolean
false. This is because the attribute "a
" exists; its
data type is not relevant to the NULL
comparison operator.
CONTAINS
: Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is of type String, then the operator checks
for a substring match. If the target attribute of the comparison is of
type Binary, then the operator looks for a subsequence of the target that
matches the input. If the target attribute of the comparison is a set ("
SS
", "NS
", or "BS
"), then the
operator evaluates to true if it finds an exact match with any member of
the set.
CONTAINS is supported for lists: When evaluating "
a CONTAINS b
", "a
" can be a list; however, "
b
" cannot be a set, a map, or a list.
NOT_CONTAINS
: Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is a String, then the operator checks for the
absence of a substring match. If the target attribute of the comparison
is Binary, then the operator checks for the absence of a subsequence of
the target that matches the input. If the target attribute of the
comparison is a set ("SS
", "NS
", or "
BS
"), then the operator evaluates to true if it does
not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating "
a NOT CONTAINS b
", "a
" can be a list; however, "b
" cannot be a set, a map, or a
list.
BEGINS_WITH
: Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN
: Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN
: Greater than or equal to the first value, and less
than or equal to the second value.
AttributeValueList must contain two AttributeValue elements
of the same type, either String, Number, or Binary (not a set type). A
target attribute matches if the target value is greater than, or equal
to, the first element and less than, or equal to, the second element. If
an item contains an AttributeValue element of a different type
than the one provided in the request, the value does not match. For
example, {"S":"6"}
does not compare to
{"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true
, DynamoDB will check to see if that
attribute value already exists in the table. If it is found, then the
condition evaluates to true; otherwise the condition evaluate to false.
If Exists is false
, DynamoDB assumes that the
attribute value does not exist in the table. If in fact the value
does not exist, then the assumption is valid and the condition evaluates
to true. If the value is found, despite the assumption that it does not
exist, the condition evaluates to false.
Note that the default value for Exists is true
.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
String conditionalOperator
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND
- If all of the conditions evaluate to true, then the
entire map evaluates to true.
OR
- If at least one of the conditions evaluate to true,
then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is the
default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
String returnValues
Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:
NONE
- If ReturnValues is not specified, or if its
value is NONE
, then nothing is returned. (This setting is
the default for ReturnValues.)
ALL_OLD
- The content of the old item is returned.
String returnConsumedCapacity
String returnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item
collections, if any, that were modified during the operation are returned
in the response. If set to NONE
(the default), no statistics
are returned.
String conditionExpression
A condition that must be satisfied in order for a conditional DeleteItem to succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
Map<K,V> attributes
A map of attribute names to AttributeValue objects, representing
the item as it appeared before the DeleteItem operation. This map
appears in the response only if ReturnValues was specified as
ALL_OLD
in the request.
ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.
Each ItemCollectionMetrics element consists of:
ItemCollectionKey - The 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, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
String tableName
The name of the table to delete.
TableDescription tableDescription
String streamArn
The Amazon Resource Name (ARN) for the stream.
Integer limit
The maximum number of shard objects to return. The upper limit is 100.
String exclusiveStartShardId
The shard ID of the first item that this operation will evaluate. Use the
value that was returned for LastEvaluatedShardId
in the
previous operation.
StreamDescription streamDescription
A complete description of the stream, including its creation date and time, the DynamoDB table associated with the stream, the shard IDs within the stream, and the beginning and ending sequence numbers of stream records within the shards.
String tableName
The name of the table to describe.
TableDescription table
AttributeValue value
Boolean exists
Causes DynamoDB to evaluate the value before attempting a conditional operation:
If Exists is true
, DynamoDB will check to see if that
attribute value already exists in the table. If it is found, then the
operation succeeds. If it is not found, the operation fails with a
ConditionalCheckFailedException.
If Exists is false
, DynamoDB assumes that the
attribute value does not exist in the table. If in fact the value does
not exist, then the assumption is valid and the operation succeeds. If
the value is found, despite the assumption that it does not exist, the
operation fails with a ConditionalCheckFailedException.
The default setting for Exists is true
. If you supply
a Value all by itself, DynamoDB assumes the attribute exists: You
don't have to set Exists to true
, because it is
implied.
DynamoDB returns a ValidationException if:
Exists is true
but there is no Value to check.
(You expect a value to exist, but don't specify what that value is.)
Exists is false
but you also provide a Value.
(You cannot expect an attribute to have a value, while also expecting it
not to exist.)
String comparisonOperator
A comparator for evaluating attributes in the AttributeValueList. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ
: Equal. EQ
is supported for all datatypes,
including lists and maps.
AttributeValueList can contain only one AttributeValue
element of type String, Number, Binary, String Set, Number Set, or Binary
Set. If an item contains an AttributeValue element of a different
type than the one provided in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not equal
{"NS":["6", "2", "1"]}
.
NE
: Not equal. NE
is supported for all
datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of
type String, Number, Binary, String Set, Number Set, or Binary Set. If an
item contains an AttributeValue of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2", "1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one AttributeValue of
type String, Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one provided
in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GE
: Greater than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
NOT_NULL
: The attribute exists. NOT_NULL
is
supported for all datatypes, including lists and maps.
This operator tests for the existence of an attribute, not its data type.
If the data type of attribute "a
" is null, and you evaluate
it using NOT_NULL
, the result is a Boolean true. This
result is because the attribute "a
" exists; its data type is
not relevant to the NOT_NULL
comparison operator.
NULL
: The attribute does not exist. NULL
is
supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data
type. If the data type of attribute "a
" is null, and you
evaluate it using NULL
, the result is a Boolean
false. This is because the attribute "a
" exists; its
data type is not relevant to the NULL
comparison operator.
CONTAINS
: Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is of type String, then the operator checks
for a substring match. If the target attribute of the comparison is of
type Binary, then the operator looks for a subsequence of the target that
matches the input. If the target attribute of the comparison is a set ("
SS
", "NS
", or "BS
"), then the
operator evaluates to true if it finds an exact match with any member of
the set.
CONTAINS is supported for lists: When evaluating "
a CONTAINS b
", "a
" can be a list; however, "
b
" cannot be a set, a map, or a list.
NOT_CONTAINS
: Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is a String, then the operator checks for the
absence of a substring match. If the target attribute of the comparison
is Binary, then the operator checks for the absence of a subsequence of
the target that matches the input. If the target attribute of the
comparison is a set ("SS
", "NS
", or "
BS
"), then the operator evaluates to true if it does
not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating "
a NOT CONTAINS b
", "a
" can be a list; however, "b
" cannot be a set, a map, or a
list.
BEGINS_WITH
: Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN
: Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN
: Greater than or equal to the first value, and less
than or equal to the second value.
AttributeValueList must contain two AttributeValue elements
of the same type, either String, Number, or Binary (not a set type). A
target attribute matches if the target value is greater than, or equal
to, the first element and less than, or equal to, the second element. If
an item contains an AttributeValue element of a different type
than the one provided in the request, the value does not match. For
example, {"S":"6"}
does not compare to
{"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
List<E> attributeValueList
One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based
on ASCII character code values. For example, a
is greater
than A
, and a
is greater than B
.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
String tableName
The name of the table containing the requested item.
Map<K,V> key
A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve.
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
List<E> attributesToGet
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
Boolean consistentRead
Determines the read consistency model: If set to true
, then
the operation uses strongly consistent reads; otherwise, the operation
uses eventually consistent reads.
String returnConsumedCapacity
String projectionExpression
A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> item
A map of attribute names to AttributeValue objects, as specified by AttributesToGet.
ConsumedCapacity consumedCapacity
List<E> records
The stream records from the shard, which were retrieved using the shard iterator.
String nextShardIterator
The next position in the shard from which to start sequentially reading
stream records. If set to null
, the shard has been closed
and the requested iterator will not return any more data.
String streamArn
The Amazon Resource Name (ARN) for the stream.
String shardId
The identifier of the shard. The iterator will be returned for this shard ID.
String shardIteratorType
Determines how the shard iterator is used to start reading stream records from the shard:
AT_SEQUENCE_NUMBER
- Start reading exactly from the position
denoted by a specific sequence number.
AFTER_SEQUENCE_NUMBER
- Start reading right after the
position denoted by a specific sequence number.
TRIM_HORIZON
- Start reading at the last (untrimmed) stream
record, which is the oldest record in the shard. In DynamoDB Streams,
there is a 24 hour limit on data retention. Stream records whose age
exceeds this limit are subject to removal (trimming) from the stream.
LATEST
- Start reading just after the most recent stream
record in the shard, so that you always read the most recent data in the
shard.
String sequenceNumber
The sequence number of a stream record in the shard from which to start reading.
String shardIterator
The position in the shard from which to start reading stream records sequentially. A shard iterator specifies this position using the sequence number of a stream record in a shard.
String indexName
The name of the global secondary index. The name must be unique among all other indexes on this table.
List<E> keySchema
The complete key schema for a global secondary index, which consists of
one or more pairs of attribute names and key types (HASH
or
RANGE
).
Projection projection
ProvisionedThroughput provisionedThroughput
String indexName
The name of the global secondary index.
List<E> keySchema
The complete key schema for the global secondary index, consisting of one
or more pairs of attribute names and key types (HASH
or
RANGE
).
Projection projection
String indexStatus
The current state of the global secondary index:
CREATING - The index is being created.
UPDATING - The index is being updated.
DELETING - The index is being deleted.
ACTIVE - The index is ready for use.
Boolean backfilling
Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a hash key attribute cannot have any duplicates.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.
For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
ProvisionedThroughputDescription provisionedThroughput
Long indexSizeBytes
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
Long itemCount
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
String indexArn
The Amazon Resource Name (ARN) that uniquely identifies the index.
UpdateGlobalSecondaryIndexAction update
The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.
CreateGlobalSecondaryIndexAction create
The parameters required for creating a global secondary index on an existing table:
IndexName
KeySchema
AttributeDefinitions
Projection
ProvisionedThroughput
DeleteGlobalSecondaryIndexAction delete
The name of an existing global secondary index to be removed.
Map<K,V> itemCollectionKey
The hash key value of the item collection. This value is the same as the hash key of the item.
List<E> sizeEstimateRangeGB
An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
List<E> keys
The primary key attribute values that define the items and the attributes associated with the items.
List<E> attributesToGet
One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.
Boolean consistentRead
The consistency of a read operation. If set to true
, then a
strongly consistent read is used; otherwise, an eventually consistent
read is used.
String projectionExpression
A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
String tableName
If this parameter is provided, then only the streams associated with this table name are returned.
Integer limit
The maximum number of streams to return. The upper limit is 100.
String exclusiveStartStreamArn
The ARN (Amazon Resource Name) of the first item that this operation will
evaluate. Use the value that was returned for
LastEvaluatedStreamArn
in the previous operation.
List<E> streams
A list of stream descriptors associated with the current account and endpoint.
String lastEvaluatedStreamArn
The stream ARN of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedStreamArn
is empty, then the "last page" of
results has been processed and there is no more data to be retrieved.
If LastEvaluatedStreamArn
is not empty, it does not
necessarily mean that there is more data in the result set. The only way
to know when you have reached the end of the result set is when
LastEvaluatedStreamArn
is empty.
String exclusiveStartTableName
The first table name that this operation will evaluate. Use the value that was returned for LastEvaluatedTableName in a previous operation, so that you can obtain the next page of results.
Integer limit
A maximum number of table names to return. If this parameter is not specified, the limit is 100.
List<E> tableNames
The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100.
If LastEvaluatedTableName also appears in the output, you can use this value as the ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the next page of results.
String lastEvaluatedTableName
The name of the last table in the current page of results. Use this value as the ExclusiveStartTableName in a new request to obtain the next page of results, until all the table names are returned.
If you do not receive a LastEvaluatedTableName value in the response, this means that there are no more table names to be retrieved.
String indexName
The name of the local secondary index. The name must be unique among all other indexes on this table.
List<E> keySchema
The complete key schema for the local secondary index, consisting of one
or more pairs of attribute names and key types (HASH
or
RANGE
).
Projection projection
String indexName
Represents the name of the local secondary index.
List<E> keySchema
The complete index key schema, which consists of one or more pairs of
attribute names and key types (HASH
or RANGE
).
Projection projection
Long indexSizeBytes
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
Long itemCount
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
String indexArn
The Amazon Resource Name (ARN) that uniquely identifies the index.
String projectionType
The set of attributes that are projected into the index:
KEYS_ONLY
- Only the index and primary keys are projected
into the index.
INCLUDE
- Only the specified table attributes are projected
into the index. The list of projected attributes are in
NonKeyAttributes.
ALL
- All of the table attributes are projected into the
index.
List<E> nonKeyAttributes
Represents the non-key attribute names which will be projected into the index.
For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
Long readCapacityUnits
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
Long writeCapacityUnits
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
Date lastIncreaseDateTime
The date and time of the last provisioned throughput increase for this table.
Date lastDecreaseDateTime
The date and time of the last provisioned throughput decrease for this table.
Long numberOfDecreasesToday
The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.
Long readCapacityUnits
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
Long writeCapacityUnits
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
String tableName
The name of the table to contain the item.
Map<K,V> item
A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. For example, with a hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
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
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the PutItem operation.
This parameter does not support attributes of type List or Map.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based
on ASCII character code values. For example, a
is greater
than A
, and a
is greater than B
.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ
: Equal. EQ
is supported for all datatypes,
including lists and maps.
AttributeValueList can contain only one AttributeValue
element of type String, Number, Binary, String Set, Number Set, or Binary
Set. If an item contains an AttributeValue element of a different
type than the one provided in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not equal
{"NS":["6", "2", "1"]}
.
NE
: Not equal. NE
is supported for all
datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of
type String, Number, Binary, String Set, Number Set, or Binary Set. If an
item contains an AttributeValue of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2", "1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one AttributeValue of
type String, Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one provided
in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GE
: Greater than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
NOT_NULL
: The attribute exists. NOT_NULL
is
supported for all datatypes, including lists and maps.
This operator tests for the existence of an attribute, not its data type.
If the data type of attribute "a
" is null, and you evaluate
it using NOT_NULL
, the result is a Boolean true. This
result is because the attribute "a
" exists; its data type is
not relevant to the NOT_NULL
comparison operator.
NULL
: The attribute does not exist. NULL
is
supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data
type. If the data type of attribute "a
" is null, and you
evaluate it using NULL
, the result is a Boolean
false. This is because the attribute "a
" exists; its
data type is not relevant to the NULL
comparison operator.
CONTAINS
: Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is of type String, then the operator checks
for a substring match. If the target attribute of the comparison is of
type Binary, then the operator looks for a subsequence of the target that
matches the input. If the target attribute of the comparison is a set ("
SS
", "NS
", or "BS
"), then the
operator evaluates to true if it finds an exact match with any member of
the set.
CONTAINS is supported for lists: When evaluating "
a CONTAINS b
", "a
" can be a list; however, "
b
" cannot be a set, a map, or a list.
NOT_CONTAINS
: Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is a String, then the operator checks for the
absence of a substring match. If the target attribute of the comparison
is Binary, then the operator checks for the absence of a subsequence of
the target that matches the input. If the target attribute of the
comparison is a set ("SS
", "NS
", or "
BS
"), then the operator evaluates to true if it does
not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating "
a NOT CONTAINS b
", "a
" can be a list; however, "b
" cannot be a set, a map, or a
list.
BEGINS_WITH
: Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN
: Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN
: Greater than or equal to the first value, and less
than or equal to the second value.
AttributeValueList must contain two AttributeValue elements
of the same type, either String, Number, or Binary (not a set type). A
target attribute matches if the target value is greater than, or equal
to, the first element and less than, or equal to, the second element. If
an item contains an AttributeValue element of a different type
than the one provided in the request, the value does not match. For
example, {"S":"6"}
does not compare to
{"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true
, DynamoDB will check to see if that
attribute value already exists in the table. If it is found, then the
condition evaluates to true; otherwise the condition evaluate to false.
If Exists is false
, DynamoDB assumes that the
attribute value does not exist in the table. If in fact the value
does not exist, then the assumption is valid and the condition evaluates
to true. If the value is found, despite the assumption that it does not
exist, the condition evaluates to false.
Note that the default value for Exists is true
.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
String returnValues
Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are:
NONE
- If ReturnValues is not specified, or if its
value is NONE
, then nothing is returned. (This setting is
the default for ReturnValues.)
ALL_OLD
- If PutItem overwrote an attribute
name-value pair, then the content of the old item is returned.
Other "Valid Values" are not relevant to PutItem.
String returnConsumedCapacity
String returnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item
collections, if any, that were modified during the operation are returned
in the response. If set to NONE
(the default), no statistics
are returned.
String conditionalOperator
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND
- If all of the conditions evaluate to true, then the
entire map evaluates to true.
OR
- If at least one of the conditions evaluate to true,
then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is the
default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
String conditionExpression
A condition that must be satisfied in order for a conditional PutItem operation to succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
Map<K,V> attributes
The attribute values as they appeared before the PutItem
operation, but only if ReturnValues is specified as
ALL_OLD
in the request. Each element consists of an
attribute name and an attribute value.
ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.
Each ItemCollectionMetrics element consists of:
ItemCollectionKey - The 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, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
Map<K,V> item
A map of attribute name to attribute values, representing the primary key of an item to be processed by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item which are part of an index key schema for the table, their types must match the index key schema.
String tableName
The name of the table containing the requested items.
String indexName
The name of an index to query. This index can be any local secondary index or global secondary index on the table. Note that if you use the IndexName parameter, you must also provide TableName.
String select
The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
ALL_ATTRIBUTES
- Returns all of the item attributes from the
specified table or index. If you query a local secondary index, then for
each matching item in the index DynamoDB will fetch the entire item from
the parent table. If the index is configured to project all item
attributes, then all of the data can be obtained from the local secondary
index, and no fetching is required.
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an
index. Retrieves all attributes that have been projected into the index.
If the index is configured to project all attributes, this return value
is equivalent to specifying ALL_ATTRIBUTES
.
COUNT
- Returns the number of matching items, rather than
the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in
AttributesToGet. This return value is equivalent to specifying
AttributesToGet without specifying any value for Select.
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither Select nor AttributesToGet are specified,
DynamoDB defaults to ALL_ATTRIBUTES
when accessing a table,
and ALL_PROJECTED_ATTRIBUTES
when accessing an index. You
cannot use both Select and AttributesToGet together in a
single request, unless the value for Select is
SPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying
AttributesToGet without any value for Select.)
If you use the ProjectionExpression parameter, then the value for
Select can only be SPECIFIC_ATTRIBUTES
. Any other
value for Select will return an error.
List<E> attributesToGet
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both AttributesToGet and Select together in
a Query request, unless the value for Select is
SPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying
AttributesToGet without any value for Select.)
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
Integer limit
The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.
Boolean consistentRead
Determines the read consistency model: If set to true
, then
the operation uses strongly consistent reads; otherwise, the operation
uses eventually consistent reads.
Strongly consistent reads are not supported on global secondary indexes.
If you query a global secondary index with ConsistentRead set to
true
, you will receive a ValidationException.
Map<K,V> keyConditions
This is a legacy parameter, for backward compatibility. New applications should use KeyConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
The selection criteria for the query. For a query on a table, you can
have conditions only on the table primary key attributes. You must
provide the hash key attribute name and value as an EQ
condition. You can optionally provide a second condition, referring to
the range key attribute.
If you don't provide a range key condition, all of the items that match the hash key will be retrieved. If a FilterExpression or QueryFilter is present, it will be applied after the items are retrieved.
For a query on an index, you can have conditions only on the index key
attributes. You must provide the index hash attribute name and value as
an EQ
condition. You can optionally provide a second
condition, referring to the index key range attribute.
Each KeyConditions element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based
on ASCII character code values. For example, a
is greater
than A
, and a
is greater than B
.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on.
For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
The following are descriptions of these comparison operators.
EQ
: Equal.
AttributeValueList can contain only one AttributeValue of
type String, Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one specified
in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2", "1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one AttributeValue of
type String, Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one provided
in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GE
: Greater than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
BEGINS_WITH
: Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
BETWEEN
: Greater than or equal to the first value, and less
than or equal to the second value.
AttributeValueList must contain two AttributeValue elements
of the same type, either String, Number, or Binary (not a set type). A
target attribute matches if the target value is greater than, or equal
to, the first element and less than, or equal to, the second element. If
an item contains an AttributeValue element of a different type
than the one provided in the request, the value does not match. For
example, {"S":"6"}
does not compare to
{"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
Map<K,V> queryFilter
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A condition that evaluates the query results after the items are read and returns only the desired values.
This parameter does not support attributes of type List or Map.
A QueryFilter is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
If you provide more than one condition in the QueryFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Note that QueryFilter does not allow key attributes. You cannot define a filter condition on a hash key or range key.
Each QueryFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based
on ASCII character code values. For example, a
is greater
than A
, and a
is greater than B
.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For complete descriptions of all comparison operators, see the Condition data type.
String conditionalOperator
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a QueryFilter map:
AND
- If all of the conditions evaluate to true, then the
entire map evaluates to true.
OR
- If at least one of the conditions evaluate to true,
then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is the
default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
Boolean scanIndexForward
Specifies the order in which to return the query results - either
ascending (true
) or descending (false
).
Items with the same hash key are stored in sorted order by range key .If the range key data type is Number, the results are stored in numeric order. For type String, the results are returned in order of ASCII character code values. For type Binary, DynamoDB treats each byte of the binary data as unsigned.
If ScanIndexForward is true
, DynamoDB returns the
results in order, by range key. This is the default behavior.
If ScanIndexForward is false
, DynamoDB sorts the
results in descending order by range key, and then returns the results to
the client.
Map<K,V> exclusiveStartKey
The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
String returnConsumedCapacity
String projectionExpression
A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
String filterExpression
A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.
A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
FilterExpression replaces the legacy QueryFilter and ConditionalOperator parameters.
String keyConditionExpression
The condition that specifies the key value(s) for items to be retrieved by the Query action.
The condition must perform an equality test on a single hash key value. The condition can also perform one of several comparison tests on a single range key value. Query can use KeyConditionExpression to retrieve one item with a given hash and range key value, or several items that have the same hash key value but different range key values.
The hash key equality test is required, and must be specified in the following format:
hashAttributeName
= :hashval
If you also want to provide a range key condition, it must be combined using AND with the hash key condition. Following is an example, using the = comparison operator for the range key:
hashAttributeName
= :hashval
AND
rangeAttributeName
= :rangeval
Valid comparisons for the range key condition are as follows:
rangeAttributeName
= :rangeval
- true if
the range key is equal to :rangeval
.
rangeAttributeName
< :rangeval
-
true if the range key is less than :rangeval
.
rangeAttributeName
<= :rangeval
-
true if the range key is less than or equal to :rangeval
.
rangeAttributeName
> :rangeval
-
true if the range key is greater than :rangeval
.
rangeAttributeName
>= :rangeval
-
true if the range key is greater than or equal to :rangeval
.
rangeAttributeName
BETWEEN :rangeval1
AND :rangeval2
- true if the range key is greater
than or equal to :rangeval1
, and less than or equal to
:rangeval2
.
begins_with (rangeAttributeName
,
:rangeval
) - true if the range key begins with a
particular operand. (You cannot use this function with a range key that
is of type Number.) Note that the function name begins_with
is case-sensitive.
Use the ExpressionAttributeValues parameter to replace tokens such
as :hashval
and :rangeval
with actual values at
runtime.
You can optionally use the ExpressionAttributeNames parameter to replace the names of the hash and range attributes with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following KeyConditionExpression parameter causes an error because Size is a reserved word:
Size = :myval
To work around this, define a placeholder (such a #S
) to
represent the attribute name Size. KeyConditionExpression
then is as follows:
#S = :myval
For a list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.
For more information on ExpressionAttributeNames and ExpressionAttributeValues, see Using Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.
KeyConditionExpression replaces the legacy KeyConditions parameter.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
List<E> items
An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.
Integer count
The number of items in the response.
If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before> the filter was applied.
If you did not use a filter in the request, then Count and ScannedCount are the same.
Integer scannedCount
The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount is the same as Count.
Map<K,V> lastEvaluatedKey
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.
If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.
ConsumedCapacity consumedCapacity
String eventID
A globally unique identifier for the event that was recorded in this stream record.
String eventName
The type of data modification that was performed on the DynamoDB table:
INSERT
- a new item was added to the table.
MODIFY
- one or more of the item's attributes were updated.
REMOVE
- the item was deleted from the table
String eventVersion
The version number of the stream record format. Currently, this is 1.0.
String eventSource
The AWS service from which the stream record originated. For DynamoDB Streams, this is aws:dynamodb.
String awsRegion
The region in which the GetRecords request was received.
StreamRecord dynamodb
The main body of the stream record, containing all of the DynamoDB-specific fields.
String tableName
The name of the table containing the requested items; or, if you provide
IndexName
, the name of the table to which that index
belongs.
String indexName
The name of a secondary index to scan. This index can be any local
secondary index or global secondary index. Note that if you use the
IndexName
parameter, you must also provide
TableName
.
List<E> attributesToGet
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
Integer limit
The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.
String select
The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, or the count of matching items.
ALL_ATTRIBUTES
- Returns all of the item attributes.
COUNT
- Returns the number of matching items, rather than
the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in
AttributesToGet. This return value is equivalent to specifying
AttributesToGet without specifying any value for Select.
If neither Select nor AttributesToGet are specified,
DynamoDB defaults to ALL_ATTRIBUTES
. You cannot use both
AttributesToGet and Select together in a single request,
unless the value for Select is SPECIFIC_ATTRIBUTES
.
(This usage is equivalent to specifying AttributesToGet without
any value for Select.)
Map<K,V> scanFilter
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A condition that evaluates the scan results and returns only the desired values.
This parameter does not support attributes of type List or Map.
If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each ScanFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator .
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based
on ASCII character code values. For example, a
is greater
than A
, and a
is greater than B
.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For complete descriptions of all comparison operators, see Condition.
String conditionalOperator
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a ScanFilter map:
AND
- If all of the conditions evaluate to true, then the
entire map evaluates to true.
OR
- If at least one of the conditions evaluate to true,
then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is the
default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
Map<K,V> exclusiveStartKey
The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
String returnConsumedCapacity
Integer totalSegments
For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4.
The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
Integer segment
For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.
Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
If you provide Segment, you must also provide TotalSegments.
String projectionExpression
A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
String filterExpression
A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.
A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
FilterExpression replaces the legacy ScanFilter and ConditionalOperator parameters.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
Boolean consistentRead
A Boolean value that determines the read consistency model during the scan:
If ConsistentRead is false
, then Scan will use
eventually consistent reads. The data returned from Scan might not
contain the results of other recently completed write operations
(PutItem, UpdateItem or DeleteItem). The Scan response might
include some stale data.
If ConsistentRead is true
, then Scan will use
strongly consistent reads. All of the write operations that completed
before the Scan began are guaranteed to be contained in the
Scan response.
The default setting for ConsistentRead is false
,
meaning that eventually consistent reads will be used.
Strongly consistent reads are not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.
List<E> items
An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.
Integer count
The number of items in the response.
If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.
If you did not use a filter in the request, then Count is the same as ScannedCount.
Integer scannedCount
The number of items evaluated, before any ScanFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount is the same as Count.
Map<K,V> lastEvaluatedKey
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.
If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.
ConsumedCapacity consumedCapacity
String shardId
The system-generated identifier for this shard.
SequenceNumberRange sequenceNumberRange
The range of possible sequence numbers for the shard.
String parentShardId
The shard ID of the current shard's parent.
String streamArn
The Amazon Resource Name (ARN) for the stream.
String tableName
The DynamoDB table with which the stream is associated.
String streamLabel
A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:
the AWS customer ID.
the table name
the StreamLabel
String streamArn
The Amazon Resource Name (ARN) for the stream.
String streamLabel
A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:
the AWS customer ID.
the table name
the StreamLabel
String streamStatus
Indicates the current status of the stream:
ENABLING
- Streams is currently being enabled on the
DynamoDB table.
ENABLING
- the stream is enabled.
DISABLING
- Streams is currently being disabled on the
DynamoDB table.
DISABLED
- the stream is disabled.
String streamViewType
Indicates the format of the records within this stream:
KEYS_ONLY
- only the key attributes of items that were
modified in the DynamoDB table.
NEW_IMAGE
- entire item from the table, as it appeared after
they were modified.
OLD_IMAGE
- entire item from the table, as it appeared
before they were modified.
NEW_AND_OLD_IMAGES
- both the new and the old images of the
items from the table.
Date creationRequestDateTime
The date and time when the request to create this stream was issued.
String tableName
The DynamoDB table with which the stream is associated.
List<E> keySchema
The key attribute(s) of the stream's DynamoDB table.
List<E> shards
The shards that comprise the stream.
String lastEvaluatedShardId
The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedShardId
is empty, then the "last page" of
results has been processed and there is currently no more data to be
retrieved.
If LastEvaluatedShardId
is not empty, it does not
necessarily mean that there is more data in the result set. The only way
to know when you have reached the end of the result set is when
LastEvaluatedShardId
is empty.
Map<K,V> keys
The primary key attribute(s) for the DynamoDB item that was modified.
Map<K,V> newImage
The item in the DynamoDB table as it appeared after it was modified.
Map<K,V> oldImage
The item in the DynamoDB table as it appeared before it was modified.
String sequenceNumber
The sequence number of the stream record.
Long sizeBytes
The size of the stream record, in bytes.
String streamViewType
The type of data from the modified DynamoDB item that was captured in this stream record:
KEYS_ONLY
- only the key attributes of the modified item.
NEW_IMAGE
- the entire item, as it appears after it was
modified.
OLD_IMAGE
- the entire item, as it appeared before it was
modified.
NEW_AND_OLD_IMAGES
— both the new and the old item images of
the item.
Boolean streamEnabled
Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
String streamViewType
The DynamoDB Streams settings for the table. These settings consist of:
StreamEnabled - Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:
KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
List<E> attributeDefinitions
An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.
Each AttributeDefinition object in this array is composed of:
AttributeName - The name of the attribute.
AttributeType - The data type for the attribute.
String tableName
The name of the table.
List<E> keySchema
The primary key structure for the table. Each KeySchemaElement consists of:
AttributeName - The name of the attribute.
KeyType - The key type for the attribute. Can be either
HASH
or RANGE
.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
String tableStatus
The current state of the table:
CREATING - The table is being created.
UPDATING - The table is being updated.
DELETING - The table is being deleted.
ACTIVE - The table is ready for use.
Date creationDateTime
The date and time when the table was created, in UNIX epoch time format.
ProvisionedThroughputDescription provisionedThroughput
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
Long tableSizeBytes
The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
Long itemCount
The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
String tableArn
The Amazon Resource Name (ARN) that uniquely identifies the table.
List<E> localSecondaryIndexes
Represents one or more local secondary indexes on the table. Each index is scoped to a given hash key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
IndexName - The name of the 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 provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the DELETING
state, no information about
indexes will be returned.
List<E> globalSecondaryIndexes
The global secondary indexes, if any, on the table. Each index is scoped to a given hash key value. Each element is composed of:
Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)
IndexName - The name of the global secondary index.
IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexStatus - The current status of the global secondary index:
CREATING - The index is being created.
UPDATING - The index is being updated.
DELETING - The index is being deleted.
ACTIVE - The index is ready for use.
ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same 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 provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the DELETING
state, no information about
indexes will be returned.
StreamSpecification streamSpecification
The current DynamoDB Streams configuration for the table.
String latestStreamLabel
A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:
the AWS customer ID.
the table name.
the StreamLabel.
String latestStreamArn
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
String indexName
The name of the global secondary index to be updated.
ProvisionedThroughput provisionedThroughput
String tableName
The name of the table containing the item to update.
Map<K,V> key
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
Map<K,V> attributeUpdates
This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements.
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any nonkey attributes.
Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.
Each AttributeUpdates element consists of an attribute name to modify, along with the following:
Value - The new value, if applicable, for this attribute.
Action - A value that specifies how to perform the update. This
action is only valid for an existing attribute whose data type is Number
or is a set; do not use ADD
for other data types.
If an item with the specified primary key is found in the table, the following values perform the following actions:
PUT
- Adds the specified attribute to the item. If the
attribute already exists, it is replaced by the new value.
DELETE
- Removes the attribute and its value, if no value is
specified for DELETE
. The data type of the specified value
must match the existing value's data type.
If a set of values is specified, then those values are subtracted from
the old set. For example, if the attribute value was the set
[a,b,c]
and the DELETE
action specifies
[a,c]
, then the final attribute value is [b]
.
Specifying an empty set is an error.
ADD
- Adds the specified value to the item, if the attribute
does not already exist. If the attribute does exist, then the behavior of
ADD
depends on the data type of the attribute:
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD
to increment or decrement a number value for
an item that doesn't exist before the update, DynamoDB uses 0 as the
initial value.
Similarly, if you use ADD
for an existing item to increment
or decrement an attribute value that doesn't exist before the update,
DynamoDB uses 0
as the initial value. For example, suppose
that the item you want to update doesn't have an attribute named
itemcount, but you decide to ADD
the number
3
to this attribute anyway. DynamoDB will create the
itemcount attribute, set its initial value to 0
, and
finally add 3
to it. The result will be a new
itemcount attribute, with a value of 3
.
If the existing data type is a set, and if Value is also a set,
then Value is appended to the existing set. For example, if the
attribute value is the set [1,2]
, and the ADD
action specified [3]
, then the final attribute value is
[1,2,3]
. An error occurs if an ADD
action is
specified for a set attribute and the attribute type specified does not
match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, Value must also be a set of strings.
If no item with the specified key is found in the table, the following values perform the following actions:
PUT
- Causes DynamoDB to create a new item with the
specified primary key, and then adds the attribute.
DELETE
- Nothing happens, because attributes cannot be
deleted from a nonexistent item. The operation succeeds, but DynamoDB
does not create a new item.
ADD
- Causes DynamoDB to create an item with the supplied
primary key and number (or set of numbers) for the attribute value. The
only data types allowed are Number and Number Set.
If you provide any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
Map<K,V> expected
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based
on ASCII character code values. For example, a
is greater
than A
, and a
is greater than B
.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ
: Equal. EQ
is supported for all datatypes,
including lists and maps.
AttributeValueList can contain only one AttributeValue
element of type String, Number, Binary, String Set, Number Set, or Binary
Set. If an item contains an AttributeValue element of a different
type than the one provided in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not equal
{"NS":["6", "2", "1"]}
.
NE
: Not equal. NE
is supported for all
datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of
type String, Number, Binary, String Set, Number Set, or Binary Set. If an
item contains an AttributeValue of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not equal {"NS":["6", "2", "1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one AttributeValue of
type String, Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one provided
in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GE
: Greater than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"}
does not equal {"N":"6"}
. Also,
{"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
NOT_NULL
: The attribute exists. NOT_NULL
is
supported for all datatypes, including lists and maps.
This operator tests for the existence of an attribute, not its data type.
If the data type of attribute "a
" is null, and you evaluate
it using NOT_NULL
, the result is a Boolean true. This
result is because the attribute "a
" exists; its data type is
not relevant to the NOT_NULL
comparison operator.
NULL
: The attribute does not exist. NULL
is
supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data
type. If the data type of attribute "a
" is null, and you
evaluate it using NULL
, the result is a Boolean
false. This is because the attribute "a
" exists; its
data type is not relevant to the NULL
comparison operator.
CONTAINS
: Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is of type String, then the operator checks
for a substring match. If the target attribute of the comparison is of
type Binary, then the operator looks for a subsequence of the target that
matches the input. If the target attribute of the comparison is a set ("
SS
", "NS
", or "BS
"), then the
operator evaluates to true if it finds an exact match with any member of
the set.
CONTAINS is supported for lists: When evaluating "
a CONTAINS b
", "a
" can be a list; however, "
b
" cannot be a set, a map, or a list.
NOT_CONTAINS
: Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is a String, then the operator checks for the
absence of a substring match. If the target attribute of the comparison
is Binary, then the operator checks for the absence of a subsequence of
the target that matches the input. If the target attribute of the
comparison is a set ("SS
", "NS
", or "
BS
"), then the operator evaluates to true if it does
not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating "
a NOT CONTAINS b
", "a
" can be a list; however, "b
" cannot be a set, a map, or a
list.
BEGINS_WITH
: Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN
: Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN
: Greater than or equal to the first value, and less
than or equal to the second value.
AttributeValueList must contain two AttributeValue elements
of the same type, either String, Number, or Binary (not a set type). A
target attribute matches if the target value is greater than, or equal
to, the first element and less than, or equal to, the second element. If
an item contains an AttributeValue element of a different type
than the one provided in the request, the value does not match. For
example, {"S":"6"}
does not compare to
{"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true
, DynamoDB will check to see if that
attribute value already exists in the table. If it is found, then the
condition evaluates to true; otherwise the condition evaluate to false.
If Exists is false
, DynamoDB assumes that the
attribute value does not exist in the table. If in fact the value
does not exist, then the assumption is valid and the condition evaluates
to true. If the value is found, despite the assumption that it does not
exist, the condition evaluates to false.
Note that the default value for Exists is true
.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
String conditionalOperator
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND
- If all of the conditions evaluate to true, then the
entire map evaluates to true.
OR
- If at least one of the conditions evaluate to true,
then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is the
default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
String returnValues
Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:
NONE
- If ReturnValues is not specified, or if its
value is NONE
, then nothing is returned. (This setting is
the default for ReturnValues.)
ALL_OLD
- If UpdateItem overwrote an attribute
name-value pair, then the content of the old item is returned.
UPDATED_OLD
- The old versions of only the updated
attributes are returned.
ALL_NEW
- All of the attributes of the new version of the
item are returned.
UPDATED_NEW
- The new versions of only the updated
attributes are returned.
String returnConsumedCapacity
String returnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item
collections, if any, that were modified during the operation are returned
in the response. If set to NONE
(the default), no statistics
are returned.
String updateExpression
An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.
The following action values are available for UpdateExpression.
SET
- Adds one or more attributes and values to an item. If
any of these attribute already exist, they are replaced by the new
values. You can also use SET
to add or subtract from an
attribute that is of type Number. For example:
SET myNum = myNum + :val
SET
supports the following functions:
if_not_exists (path, operand)
- if the item does not contain
an attribute at the specified path, then if_not_exists
evaluates to operand; otherwise, it evaluates to path. You can use this
function to avoid overwriting an attribute that may already be present in
the item.
list_append (operand, operand)
- evaluates to a list with a
new element added to it. You can append the new element to the start or
the end of the list by reversing the order of the operands.
These function names are case-sensitive.
REMOVE
- Removes one or more attributes from an item.
ADD
- Adds the specified value to the item, if the attribute
does not already exist. If the attribute does exist, then the behavior of
ADD
depends on the data type of the attribute:
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD
to increment or decrement a number value for
an item that doesn't exist before the update, DynamoDB uses
0
as the initial value.
Similarly, if you use ADD
for an existing item to increment
or decrement an attribute value that doesn't exist before the update,
DynamoDB uses 0
as the initial value. For example, suppose
that the item you want to update doesn't have an attribute named
itemcount, but you decide to ADD
the number
3
to this attribute anyway. DynamoDB will create the
itemcount attribute, set its initial value to 0
, and
finally add 3
to it. The result will be a new
itemcount attribute in the item, with a value of 3
.
If the existing data type is a set and if Value is also a set,
then Value is added to the existing set. For example, if the
attribute value is the set [1,2]
, and the ADD
action specified [3]
, then the final attribute value is
[1,2,3]
. An error occurs if an ADD
action is
specified for a set attribute and the attribute type specified does not
match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
The ADD
action only supports Number and set data types. In
addition, ADD
can only be used on top-level attributes, not
nested attributes.
DELETE
- Deletes an element from a set.
If a set of values is specified, then those values are subtracted from
the old set. For example, if the attribute value was the set
[a,b,c]
and the DELETE
action specifies
[a,c]
, then the final attribute value is [b]
.
Specifying an empty set is an error.
The DELETE
action only supports set data types. In addition,
DELETE
can only be used on top-level attributes, not nested
attributes.
You can have many actions in a single expression, such as the following:
SET a=:value1, b=:value2 DELETE :value3, :value4, :value5
For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
UpdateExpression replaces the legacy AttributeUpdates parameter.
String conditionExpression
A condition that must be satisfied in order for a conditional update to succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
Map<K,V> attributes
A map of attribute values as they appeared before the UpdateItem
operation. This map only appears if ReturnValues was specified as
something other than NONE
in the request. Each element
represents one attribute.
ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
List<E> attributeDefinitions
An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.
String tableName
The name of the table to be updated.
ProvisionedThroughput provisionedThroughput
List<E> globalSecondaryIndexUpdates
An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:
Create - add a new global secondary index to the table.
Update - modify the provisioned throughput settings of an existing global secondary index.
Delete - remove a global secondary index from the table.
For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
StreamSpecification streamSpecification
Represents the DynamoDB Streams configuration for the table.
You will receive a ResourceInUseException if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream.
TableDescription tableDescription
PutRequest putRequest
A request to perform a PutItem operation.
DeleteRequest deleteRequest
A request to perform a DeleteItem operation.
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 instanceId
String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
Boolean returnValue
true
if the request succeeds; otherwise, it
returns an error.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
tcp
, udp
,
icmp
) or number (see Protocol
Numbers). (VPC only) Use -1
to specify all.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, information, impaired, unavailable
String regionName
com.amazonaws.internal.ListWithAutoConstructFlag<T> messages
String message
String virtualName
ephemeral
N). Instance store
volumes are numbered starting from 0. An instance type with 2
available instance store volumes can specify mappings for
ephemeral0
and ephemeral1
.The number of
available instance store volumes depends on the instance type. After
you connect to the instance, you must mount the volume.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
String deviceName
/dev/sdh
or xvdh
).EbsBlockDevice ebs
String noDevice
String instanceId
Type: String
Default: None
Required: Yes
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
String spotFleetRequestId
CancelSpotFleetRequestsError error
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotFleetRequestIds
Boolean terminateInstances
com.amazonaws.internal.ListWithAutoConstructFlag<T> unsuccessfulFleetRequests
com.amazonaws.internal.ListWithAutoConstructFlag<T> successfulFleetRequests
String spotFleetRequestId
String currentSpotFleetRequestState
Constraints:
Allowed Values: submitted, active, cancelled, failed, cancelled_running, cancelled_terminating, modifying
String previousSpotFleetRequestState
Constraints:
Allowed Values: submitted, active, cancelled, failed, cancelled_running, cancelled_terminating, modifying
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotInstanceRequestIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> cancelledSpotInstanceRequests
String instanceId
String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String ownerId
Boolean returnValue
true
if the
specified product code is owned by the requester and associated with
the specified instance.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
parameter of a snapshot copy operation. This parameter is only valid
for specifying the destination region in a PresignedUrl
parameter, where it is required. CopySnapshot
sends the snapshot copy to the regional endpoint that you send the
HTTP request to, such as ec2.us-east-1.amazonaws.com
(in
the AWS CLI, this is specified with the --region
parameter or the default region in your AWS configuration file).
String presignedUrl
PresignedUrl
should use
the snapshot source endpoint, the CopySnapshot
action,
and include the SourceRegion
,
SourceSnapshotId
, and DestinationRegion
parameters. The PresignedUrl
must be signed using AWS
Signature Version 4. Because EBS snapshots are stored in Amazon S3,
the signing algorithm for this parameter uses the same logic that is
described in Authenticating
Requests by Using Query Parameters (AWS Signature Version 4) in
the Amazon Simple Storage Service API Reference. An invalid or
improperly signed PresignedUrl
will cause the copy
operation to fail asynchronously, and the snapshot will move to an
error
state.Boolean encrypted
KmsKeyId
. For more information, see Amazon
EBS Encryption in the Amazon Elastic Compute Cloud User
Guide.String kmsKeyId
arn:aws:kms
namespace, followed by the region of the CMK,
the AWS account ID of the CMK owner, the key
namespace,
and then the CMK ID. For example,
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
The specified CMK must exist in the region that the snapshot is being
copied to. If a KmsKeyId
is specified, the
Encrypted
flag must also be set.String snapshotId
String type
ipsec.1
).
Constraints:
Allowed Values: ipsec.1
String publicIp
Integer bgpAsn
Default: 65000
CustomerGateway customerGateway
com.amazonaws.internal.ListWithAutoConstructFlag<T> dhcpConfigurations
DhcpOptions dhcpOptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceIds
String resourceType
Constraints:
Allowed Values: VPC, Subnet, NetworkInterface
String trafficType
Constraints:
Allowed Values: ACCEPT, REJECT, ALL
String logGroupName
String deliverLogsPermissionArn
String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> flowLogIds
String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> unsuccessful
String instanceId
String name
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), 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
Constraints: Up to 255 ASCII characters
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
172.16.0.0/24
).IcmpTypeCode icmpTypeCode
PortRange portRange
String vpcId
NetworkAcl networkAcl
String subnetId
String description
String privateIpAddress
privateIpAddresses
as primary
(only one IP address can be designated as primary).com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
Integer secondaryPrivateIpAddressCount
privateIpAddresses
. The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide.
NetworkInterface networkInterface
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
Boolean returnValue
true
if the request succeeds; otherwise, it
returns an error.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
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 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: 1-1024
for standard
volumes, 1-16384
for
gp2
volumes, and 4-16384
for
io1
volumes. If you specify a snapshot, the volume size
must be equal to or larger than the snapshot size.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
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
Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes
Boolean encrypted
String kmsKeyId
arn:aws:kms
namespace, followed by the
region of the CMK, the AWS account ID of the CMK owner, the
key
namespace, and then the CMK ID. For example,
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
If a KmsKeyId
is specified, the Encrypted
flag must also be set.Volume volume
String vpcId
String serviceName
com.amazonaws.region.service
. To get a list
of available services, use the DescribeVpcEndpointServices
request.String policyDocument
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeTableIds
String clientToken
VpcEndpoint vpcEndpoint
String clientToken
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 run on single-tenant hardware.
Default: default
Constraints:
Allowed Values: default, dedicated
Vpc vpc
String type
ipsec.1
).String customerGatewayId
String vpnGatewayId
VpnConnectionOptionsSpecification options
true
. Default: false
VpnConnection vpnConnection
VpnGateway vpnGateway
String customerGatewayId
String state
pending | available |
deleting | deleted
).String type
ipsec.1
).String ipAddress
String bgpAsn
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String customerGatewayId
String dhcpOptionsId
com.amazonaws.internal.ListWithAutoConstructFlag<T> flowLogIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> unsuccessful
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcEndpointIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> unsuccessful
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
|
information
| impaired
|
unavailable
).
zone-name
- The
name of the Availability Zone (for example, us-east-1a
).
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> bundleIds
Default: Describes all your bundle tasks.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
bundle-id
- The ID of
the bundle task.
error-code
- If the task
failed, the error code returned.
error-message
- If the task failed, the error message
returned.
instance-id
- The ID of the
instance.
progress
- The level of task
completion, as a percentage (for example, 20%).
s3-bucket
- The Amazon S3 bucket to store the AMI.
s3-prefix
- The beginning of the AMI name.
start-time
- The time the task started (for
example, 2013-09-15T17:15:20.000Z).
state
-
The state of the task (pending
|
waiting-for-shutdown
| bundling
|
storing
| cancelling
| complete
| failed
).
update-time
- The
time of the most recent update for the task.
com.amazonaws.internal.ListWithAutoConstructFlag<T> bundleTasks
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
group-id
- The ID of a
VPC security group that's associated with the instance.
instance-id
- The ID of the instance.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id
- The ID of the VPC that the
instance is linked to.
String nextToken
Integer maxResults
NextToken
value. This value can be between 5 and 1000; if
MaxResults
is given a value larger than 1000, only 1000
results are returned. You cannot specify this parameter and the
instance IDs parameter in the same request. Constraint: If the value is greater than 1000, we return only 1000 items.
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
String nextToken
null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> conversionTaskIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> conversionTasks
com.amazonaws.internal.ListWithAutoConstructFlag<T> customerGatewayIds
Default: Describes all your customer gateways.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
bgp-asn
- The customer
gateway's Border Gateway Protocol (BGP) Autonomous System Number
(ASN).
customer-gateway-id
- The ID of the
customer gateway.
ip-address
- The IP
address of the customer gateway's Internet-routable external
interface.
state
- The state of the
customer gateway (pending
| available
|
deleting
| deleted
).
type
- The type of customer gateway. Currently, the
only supported type is ipsec.1
.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
com.amazonaws.internal.ListWithAutoConstructFlag<T> customerGateways
com.amazonaws.internal.ListWithAutoConstructFlag<T> dhcpOptionsIds
Default: Describes all your DHCP options sets.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
dhcp-options-id
- The
ID of a set of DHCP options.
key
- The key
for one of the options (for example, domain-name
).
value
- The value for one of the options.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
com.amazonaws.internal.ListWithAutoConstructFlag<T> dhcpOptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> exportTaskIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> exportTasks
com.amazonaws.internal.ListWithAutoConstructFlag<T> flowLogIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filter
deliver-log-status
- The
status of the logs delivery (SUCCESS
|
FAILED
).
flow-log-id
- The ID of
the flow log.
log-group-name
- The name of
the log group.
resource-id
- The ID of the
VPC, subnet, or network interface.
traffic-type
- The type of traffic
(ACCEPT
| REJECT
| ALL
)
String nextToken
Integer maxResults
NextToken
value. This value can be
between 5 and 1000; if MaxResults
is given a value larger
than 1000, only 1000 results are returned. You cannot specify this
parameter and the flow log IDs parameter in the same request.com.amazonaws.internal.ListWithAutoConstructFlag<T> flowLogs
String nextToken
null
when there are no more results to return.String imageId
String attribute
Note: Depending on your account
privileges, the blockDeviceMapping
attribute may return a
Client.AuthFailure
error. If this happens, use
DescribeImages to get information about the block device
mapping for the AMI.
Constraints:
Allowed Values: description, kernel, ramdisk, launchPermission, productCodes, blockDeviceMapping, sriovNetSupport
ImageAttribute imageAttribute
com.amazonaws.internal.ListWithAutoConstructFlag<T> imageIds
Default: Describes all images available to you.
com.amazonaws.internal.ListWithAutoConstructFlag<T> owners
amazon
(owner is Amazon), aws-marketplace
(owner is AWS Marketplace), self
(owner is the sender of
the request). Omitting this option returns all images for which you
have launch permissions, regardless of ownership.com.amazonaws.internal.ListWithAutoConstructFlag<T> executableUsers
self
(the sender of the request), or
all
(public AMIs).com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
architecture
- The
image architecture (i386
| x86_64
).
block-device-mapping.delete-on-termination
- A
Boolean value that indicates whether the Amazon EBS volume is deleted
on instance termination.
block-device-mapping.device-name
- The device name for
the EBS volume (for example, /dev/sdh
).
block-device-mapping.snapshot-id
- The ID of the
snapshot used for the EBS volume.
block-device-mapping.volume-size
- The volume size of
the EBS volume, in GiB.
block-device-mapping.volume-type
- The volume type of
the EBS volume (gp2
| 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
com.amazonaws.internal.ListWithAutoConstructFlag<T> importTaskIds
String nextToken
Integer maxResults
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> importImageTasks
String nextToken
null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> importTaskIds
String nextToken
Integer maxResults
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> importSnapshotTasks
String nextToken
null
when there are no more results to return.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 EBS volume mapped to the instance, for
example, 2010-09-15T17:15:20.000Z
.
block-device-mapping.delete-on-termination
- A Boolean
that indicates whether the EBS volume is deleted on instance
termination.
block-device-mapping.device-name
- The device name for
the EBS volume (for example, /dev/sdh
or
xvdh
).
block-device-mapping.status
- The status for the EBS
volume (attaching
| attached
|
detaching
| detached
).
block-device-mapping.volume-id
- The volume ID of the
EBS volume.
client-token
- The idempotency
token you provided when you launched the instance.
dns-name
- The public DNS name of the instance.
group-id
- The ID of the security group for the
instance. EC2-Classic only.
group-name
-
The name of the security group for the instance. EC2-Classic only.
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,
t2.micro
).
instance.group-id
-
The ID of the security group for the instance.
instance.group-name
- The name of the security group
for the instance.
ip-address
- The public
IP address of the instance.
kernel-id
- The
kernel ID.
key-name
- The name of the key
pair used when the instance was launched.
launch-index
- When launching multiple instances, this
is the index for the instance in the launch group (for example, 0, 1,
2, and so on).
launch-time
- The time when
the instance was launched.
monitoring-state
- Indicates whether monitoring is enabled for the instance
(disabled
| enabled
).
owner-id
- The AWS account ID of the instance owner.
placement-group-name
- The name of the
placement group for the instance.
platform
- The platform. Use windows
if you have Windows
instances; otherwise, leave blank.
private-dns-name
- The private DNS name of the
instance.
private-ip-address
- The private
IP address of the instance.
product-code
-
The product code associated with the AMI used to launch the instance.
product-code.type
- The type of product
code (devpay
| marketplace
).
ramdisk-id
- The RAM disk ID.
reason
- The reason for the current state of the
instance (for example, shows "User Initiated [date]" when you stop or
terminate the instance). Similar to the state-reason-code filter.
requester-id
- The ID of the entity that
launched the instance on your behalf (for example, AWS Management
Console, Auto Scaling, and so on).
reservation-id
- The ID of the instance's reservation.
A reservation ID is created any time you launch an instance. A
reservation ID has a one-to-one relationship with an instance launch
request, but can be associated with more than one instance if you
launch multiple instances using the same launch request. For example,
if you launch one instance, you'll get one reservation ID. If you
launch ten instances using the same launch request, you'll also get
one reservation ID.
root-device-name
- The
name of the root device for the instance (for example,
/dev/sda1
or /dev/xvda
).
root-device-type
- The type of root device that the
instance uses (ebs
| instance-store
).
source-dest-check
- Indicates whether the
instance performs source/destination checking. A value of
true
means that checking is enabled, and
false
means checking is disabled. The value must be
false
for the instance to perform network address
translation (NAT) in your VPC.
spot-instance-request-id
- The ID of the Spot Instance
request.
state-reason-code
- The reason
code for the state change.
state-reason-message
- A message that describes the
state change.
subnet-id
- The ID of the
subnet for the instance.
tag
:key=value - The key/value
combination of a tag assigned to the resource, where
tag
:key is the tag's key.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
tenancy
- The tenancy of an
instance (dedicated
| default
).
virtualization-type
- The virtualization type of the
instance (paravirtual
| hvm
).
vpc-id
- The ID of the VPC that the instance is
running in.
network-interface.description
-
The description of the network interface.
network-interface.subnet-id
- The ID of the subnet for
the network interface.
network-interface.vpc-id
- The ID of the VPC for the
network interface.
network-interface.network-interface.id
- The ID of the
network interface.
network-interface.owner-id
- The ID of the owner of
the network interface.
network-interface.availability-zone
- The Availability
Zone for the network interface.
network-interface.requester-id
- The requester ID for
the network interface.
network-interface.requester-managed
- Indicates
whether the network interface is being managed by AWS.
network-interface.status
- The status of the network
interface (available
) | in-use
).
network-interface.mac-address
- The MAC address of the
network interface.
network-interface-private-dns-name
- The private DNS
name of the network interface.
network-interface.source-dest-check
- Whether the
network interface performs source/destination checking. A value of
true
means checking is enabled, and false
means checking is disabled. The value must be false
for
the network interface to perform network address translation (NAT) in
your VPC.
network-interface.group-id
- The
ID of a security group associated with the network interface.
network-interface.group-name
- The name of a
security group associated with the network interface.
network-interface.attachment.attachment-id
- The ID of
the interface attachment.
network-interface.attachment.instance-id
- The ID of
the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id
- The
owner ID of the instance to which the network interface is attached.
network-interface.addresses.private-ip-address
- The
private IP address associated with the network interface.
network-interface.attachment.device-index
- The device
index to which the network interface is attached.
network-interface.attachment.status
- The status of
the attachment (attaching
| attached
|
detaching
| detached
).
network-interface.attachment.attach-time
- The time
that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination
-
Specifies whether the attachment is deleted when an instance is
terminated.
network-interface.addresses.primary
- Specifies
whether the IP address of the network interface is the primary private
IP address.
network-interface.addresses.association.public-ip
-
The ID of the association of an Elastic IP address with a network
interface.
network-interface.addresses.association.ip-owner-id
-
The owner ID of the private IP address associated with the network
interface.
association.public-ip
- The
address of the Elastic IP address bound to the network interface.
association.ip-owner-id
- The owner of the
Elastic IP address associated with the network interface.
association.allocation-id
- The allocation ID returned
when you allocated the Elastic IP address for your network interface.
association.association-id
- The
association ID returned when the network interface was associated with
an IP address.
String nextToken
Integer maxResults
NextToken
value. This value can be between 5 and 1000; if
MaxResults
is given a value larger than 1000, only 1000
results are returned. You cannot specify this parameter and the
instance IDs parameter in the same request.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservations
String nextToken
null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone
- The
Availability Zone of the instance.
event.code
- The code for the scheduled event
(instance-reboot
| system-reboot
|
system-maintenance
| instance-retirement
|
instance-stop
).
event.description
- A description of the event.
event.not-after
- The latest end time for the
scheduled event (for example, 2014-09-15T17:15:20.000Z
).
event.not-before
- The earliest start time
for the scheduled event (for example,
2014-09-15T17:15:20.000Z
).
instance-state-code
- The code for the instance state,
as a 16-bit unsigned integer. The high byte is an opaque internal
value and should be ignored. The low byte is set based on the state
represented. The valid values are 0 (pending), 16 (running), 32
(shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name
- The state of the
instance (pending
| running
|
shutting-down
| terminated
|
stopping
| stopped
).
instance-status.reachability
- Filters on instance
status where the name is reachability
(passed
| failed
| initializing
| insufficient-data
).
instance-status.status
- The status of the instance
(ok
| impaired
| initializing
|
insufficient-data
| not-applicable
).
system-status.reachability
- Filters on system
status where the name is reachability
(passed
| failed
| initializing
| insufficient-data
).
system-status.status
- The system status of the
instance (ok
| impaired
|
initializing
| insufficient-data
|
not-applicable
).
String nextToken
Integer maxResults
NextToken
value. This value can be between 5 and 1000; if
MaxResults
is given a value larger than 1000, only 1000
results are returned. You cannot specify this parameter and the
instance IDs parameter in the same request.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
null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> internetGatewayIds
Default: Describes all your Internet gateways.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
attachment.state
- The
current state of the attachment between the gateway and the VPC
(available
). Present only if a VPC is attached.
attachment.vpc-id
- The ID of an attached VPC.
internet-gateway-id
- The ID of the
Internet gateway.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
com.amazonaws.internal.ListWithAutoConstructFlag<T> internetGateways
com.amazonaws.internal.ListWithAutoConstructFlag<T> keyNames
Default: Describes all your key pairs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
fingerprint
- The
fingerprint of the key pair.
key-name
- The
name of the key pair.
com.amazonaws.internal.ListWithAutoConstructFlag<T> keyPairs
com.amazonaws.internal.ListWithAutoConstructFlag<T> publicIps
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
moving-status
- The
status of the Elastic IP address (MovingToVpc
|
RestoringToClassic
).
Integer maxResults
NextToken
value. This value can be between 5 and 1000; if
MaxResults
is given a value outside of this range, an
error is returned. Default: If no value is provided, the default is 1000.
com.amazonaws.internal.ListWithAutoConstructFlag<T> movingAddressStatuses
String nextToken
null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> networkAclIds
Default: Describes all your network ACLs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
association.association-id
- The ID of an association
ID for the ACL.
association.network-acl-id
- The ID of the network ACL involved in the association.
association.subnet-id
- The ID of the subnet involved
in the association.
default
- Indicates
whether the ACL is the default network ACL for the VPC.
entry.cidr
- The CIDR range specified in the entry.
entry.egress
- Indicates whether the entry
applies to egress traffic.
entry.icmp.code
- The ICMP code specified in the entry, if any.
entry.icmp.type
- The ICMP type specified in the
entry, if any.
entry.port-range.from
- The
start of the port range specified in the entry.
entry.port-range.to
- The end of the port range
specified in the entry.
entry.protocol
-
The protocol specified in the entry (tcp
|
udp
| icmp
or a protocol number).
entry.rule-action
- Allows or denies the matching
traffic (allow
| deny
).
entry.rule-number
- The number of an entry (in other
words, rule) in the ACL's set of entries.
network-acl-id
- The ID of the network ACL.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id
- The ID of the VPC for the
network ACL.
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkAcls
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> prefixListIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
prefix-list-id
: The ID
of a prefix list.
prefix-list-name
: The
name of a prefix list.
Integer maxResults
Constraint: If the value specified is greater than 1000, we return only 1000 items.
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> prefixLists
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> regionNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
endpoint
- The endpoint
of the region (for example, ec2.us-east-1.amazonaws.com
).
region-name
- The name of the region (for
example, us-east-1
).
com.amazonaws.internal.ListWithAutoConstructFlag<T> regions
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
null
when there are no more results to return.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, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, t2.micro, t2.small, t2.medium, t2.large, 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, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.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 (31536000
|
94608000
).
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 Reserved
Instance product platform description. Instances that include
(Amazon VPC)
in the product platform description will
only be displayed to EC2-Classic account holders and are for use with
Amazon VPC. (Linux/UNIX
| Linux/UNIX (Amazon
VPC)
| SUSE Linux
| SUSE Linux (Amazon
VPC)
| Red Hat Enterprise Linux
| Red Hat
Enterprise Linux (Amazon VPC)
| Windows
|
Windows (Amazon VPC)
| Windows with SQL Server
Standard
| Windows with SQL Server Standard (Amazon
VPC)
| Windows with SQL Server Web
|
Windows with SQL Server Web (Amazon VPC)
| Windows with
SQL Server Enterprise
| Windows with SQL Server
Enterprise (Amazon VPC)
)
reserved-instances-offering-id
- The Reserved
Instances offering ID.
usage-price
- The
usage price of the Reserved Instance, per hour (for example, 0.84).
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
Medium Utilization
Reserved Instance offering type.
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront
String nextToken
Integer maxResults
NextToken
value. The maximum is 100. Default: 100
Boolean includeMarketplace
Long minDuration
Default: 2592000 (1 month)
Long maxDuration
Default: 94608000 (3 years)
Integer maxInstanceCount
Default: 20
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesOfferings
String nextToken
null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesIds
Default: Describes all your Reserved Instances, or only those otherwise specified.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone
- The
Availability Zone where the Reserved Instance can be used.
duration
- The duration of the Reserved Instance (one
year or three years), in seconds (31536000
|
94608000
).
end
- The time when
the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
fixed-price
- The purchase price of the
Reserved Instance (for example, 9800.0).
instance-type
- The instance type on which the
Reserved Instance can be used.
product-description
- The Reserved Instance product
platform description. Instances that include (Amazon VPC)
in the product platform description will only be displayed to
EC2-Classic account holders and are for use with Amazon VPC.
(Linux/UNIX
| Linux/UNIX (Amazon VPC)
|
SUSE Linux
| SUSE Linux (Amazon VPC)
|
Red Hat Enterprise Linux
| Red Hat Enterprise Linux
(Amazon VPC)
| Windows
| Windows (Amazon
VPC)
| Windows with SQL Server Standard
|
Windows with SQL Server Standard (Amazon VPC)
|
Windows with SQL Server Web
| Windows with SQL
Server Web (Amazon VPC)
| Windows with SQL Server
Enterprise
| Windows with SQL Server Enterprise (Amazon
VPC)
).
reserved-instances-id
- The
ID of the Reserved Instance.
start
- The
time at which the Reserved Instance purchase request was placed (for
example, 2014-08-07T11:54:42.000Z).
state
-
The state of the Reserved Instance (payment-pending
|
active
| payment-failed
|
retired
).
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
usage-price
- The usage price of
the Reserved Instance, per hour (for example, 0.84).
String offeringType
Medium Utilization
Reserved Instance offering type.
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstances
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeTableIds
Default: Describes all your route tables.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
association.route-table-association-id
- The ID of an
association ID for the route table.
association.route-table-id
- The ID of the route table
involved in the association.
association.subnet-id
- The ID of the subnet involved
in the association.
association.main
-
Indicates whether the route table is the main route table for the VPC.
route-table-id
- The ID of the route table.
route.destination-cidr-block
- The CIDR
range specified in a route in the table.
route.destination-prefix-list-id
- The ID (prefix) of
the AWS service specified in a route in the table.
route.gateway-id
- The ID of a gateway specified in a
route in the table.
route.instance-id
- The
ID of an instance specified in a route in the table.
route.origin
- Describes how the route was created.
CreateRouteTable
indicates that the route was
automatically created when the route table was created;
CreateRoute
indicates that the route was manually added
to the route table; EnableVgwRoutePropagation
indicates
that the route was propagated by route propagation.
route.state
- The state of a route in the route table
(active
| blackhole
). The blackhole state
indicates that the route's target isn't available (for example, the
specified gateway isn't attached to the VPC, the specified NAT
instance has been terminated, and so on).
route.vpc-peering-connection-id
- The ID of a VPC
peering connection specified in a route in the table.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id
- The ID of the VPC for the
route table.
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeTables
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
group-name
filter to describe security groups by name.
Default: Describes all your security groups.
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupIds
Default: Describes all your security groups.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
description
- The description of the security group.
egress.ip-permission.prefix-list-id
- The
ID (prefix) of the AWS service to which the security group allows
access.
group-id
- The ID of the security
group.
group-name
- The name of the
security group.
ip-permission.cidr
- A CIDR
range that has been granted permission.
ip-permission.from-port
- The start of port range for
the TCP and UDP protocols, or an ICMP type number.
ip-permission.group-id
- The ID of a security group
that has been granted permission.
ip-permission.group-name
- The name of a security
group that has been granted permission.
ip-permission.protocol
- The IP protocol for the
permission (tcp
| udp
| icmp
or
a protocol number).
ip-permission.to-port
-
The end of port range for the TCP and UDP protocols, or an ICMP code.
ip-permission.user-id
- The ID of an AWS
account that has been granted permission.
owner-id
- The AWS account ID of the owner of the
security group.
tag-key
- The key of a tag
assigned to the security group.
tag-value
-
The value of a tag assigned to the security group.
vpc-id
- The ID of the VPC specified when the security
group was created.
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
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.
String nextToken
NextToken
value returned from a previous paginated
DescribeSnapshots
request where MaxResults
was used and the results exceeded the value of that parameter.
Pagination continues from the end of the previous results that
returned the NextToken
value. This value is
null
when there are no more results to return.Integer maxResults
DescribeSnapshots
in paginated output. When this
parameter is used, DescribeSnapshots
only returns
MaxResults
results in a single page along with a
NextToken
response element. The remaining results of the
initial request can be seen by sending another
DescribeSnapshots
request with the returned
NextToken
value. This value can be between 5 and 1000; if
MaxResults
is given a value larger than 1000, only 1000
results are returned. If this parameter is not used, then
DescribeSnapshots
returns all results. You cannot specify
this parameter and the snapshot IDs parameter in the same request.com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshots
String nextToken
NextToken
value to include in a future
DescribeSnapshots
request. When the results of a
DescribeSnapshots
request exceed MaxResults
,
this value can be used to retrieve the next page of results. This
value is null
when there are no more results to return.SpotDatafeedSubscription spotDatafeedSubscription
String spotFleetRequestId
String nextToken
Integer maxResults
NextToken
value.String spotFleetRequestId
com.amazonaws.internal.ListWithAutoConstructFlag<T> activeInstances
String nextToken
null
when there are no more results to return.String spotFleetRequestId
String eventType
Constraints:
Allowed Values: instanceChange, fleetRequestChange, error
Date startTime
String nextToken
Integer maxResults
NextToken
value.String spotFleetRequestId
Date startTime
Date lastEvaluatedTime
If nextToken
indicates that there are more results, this value is not present.
com.amazonaws.internal.ListWithAutoConstructFlag<T> historyRecords
String nextToken
null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> spotFleetRequestIds
String nextToken
Integer maxResults
NextToken
value.com.amazonaws.internal.ListWithAutoConstructFlag<T> spotFleetRequestConfigs
String nextToken
null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> spotInstanceRequestIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone-group
- The Availability Zone group.
create-time
- The time stamp when the Spot instance request was created.
fault-code
- The fault code related to the
request.
fault-message
- The fault message
related to the request.
instance-id
- The
ID of the instance that fulfilled the request.
launch-group
- The Spot instance launch group.
launch.block-device-mapping.delete-on-termination
- Indicates whether the Amazon EBS volume is deleted on instance
termination.
launch.block-device-mapping.device-name
- The device
name for the Amazon EBS volume (for example, /dev/sdh
).
launch.block-device-mapping.snapshot-id
-
The ID of the snapshot used for the Amazon EBS volume.
launch.block-device-mapping.volume-size
- The size of
the Amazon EBS volume, in GiB.
launch.block-device-mapping.volume-type
- The type of
the Amazon EBS volume (gp2
| 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.
network-interface.network-interface-id
- The ID of the
network interface.
network-interface.device-index
- The index of the
device for the network interface attachment on the instance.
network-interface.subnet-id
- The ID of the
subnet for the instance.
network-interface.description
- A description of the
network interface.
network-interface.private-ip-address
- The primary
private IP address of the network interface.
network-interface.delete-on-termination
- Indicates
whether the network interface is deleted when the instance is
terminated.
network-interface.group-id
-
The ID of the security group associated with the network interface.
network-interface.group-name
- The name of
the security group associated with the network interface.
network-interface.addresses.primary
- Indicates
whether the IP address is the primary private IP address.
product-description
- The product description
associated with the instance (Linux/UNIX
|
Windows
).
spot-instance-request-id
- The Spot instance request
ID.
spot-price
- The maximum hourly price
for any Spot instance launched to fulfill the request.
state
- The state of the Spot instance request
(open
| active
| closed
|
cancelled
| failed
). Spot bid status
information can help you track your Amazon EC2 Spot instance requests.
For more information, see Spot
Bid Status in the Amazon Elastic Compute Cloud User Guide.
status-code
- The short code describing the most
recent evaluation of your Spot instance request.
status-message
- The message explaining the status of
the Spot instance request.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
type
- The type of Spot instance
request (one-time
| persistent
).
launched-availability-zone
- The Availability Zone in
which the bid is launched.
valid-from
- The
start date of the request.
valid-until
-
The end date of the request.
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotInstanceRequests
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, in UTC format (for example,
YYYY-MM-DDTHH:MM:SSZ). You
can use wildcards (* and ?). Greater than or less than comparison is
not supported.
String availabilityZone
Integer maxResults
NextToken
value.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotPriceHistory
String nextToken
null
when there are no more results to return.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
NextToken
value. This value can be between 5 and 1000; if
MaxResults
is given a value larger than 1000, only 1000
results are returned.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String nextToken
null
when there are no more results to return..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.
String nextToken
NextToken
value returned from a previous paginated
DescribeVolumes
request where MaxResults
was
used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the
NextToken
value. This value is null
when
there are no more results to return.Integer maxResults
DescribeVolumes
in paginated output. When this parameter
is used, DescribeVolumes
only returns
MaxResults
results in a single page along with a
NextToken
response element. The remaining results of the
initial request can be seen by sending another
DescribeVolumes
request with the returned
NextToken
value. This value can be between 5 and 1000; if
MaxResults
is given a value larger than 1000, only 1000
results are returned. If this parameter is not used, then
DescribeVolumes
returns all results. You cannot specify
this parameter and the volume IDs parameter in the same request.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumes
String nextToken
NextToken
value to include in a future
DescribeVolumes
request. When the results of a
DescribeVolumes
request exceed MaxResults
,
this value can be used to retrieve the next page of results. This
value is null
when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeIds
Default: Describes all your volumes.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
action.code
- The
action code for the event (for example,
enable-volume-io
).
action.description
- A description of the action.
action.event-id
- The event ID associated
with the action.
availability-zone
- The
Availability Zone of the instance.
event.description
- A description of the event.
event.event-id
- The event ID.
event.event-type
- The event type (for
io-enabled
: passed
| failed
;
for io-performance
: io-performance:degraded
| io-performance:severely-degraded
|
io-performance:stalled
).
event.not-after
- The latest end time for the event.
event.not-before
- The earliest start time
for the event.
volume-status.details-name
-
The cause for volume-status.status
(io-enabled
| io-performance
).
volume-status.details-status
- The status of
volume-status.details-name
(for io-enabled
:
passed
| failed
; for
io-performance
: normal
|
degraded
| severely-degraded
|
stalled
).
volume-status.status
- The status of the volume (ok
| impaired
|
warning
| insufficient-data
).
String nextToken
NextToken
value to include in a future
DescribeVolumeStatus
request. When the results of the
request exceed MaxResults
, this value can be used to
retrieve the next page of results. This value is null
when there are no more results to return.Integer maxResults
DescribeVolumeStatus
in paginated output. When this
parameter is used, the request only returns MaxResults
results in a single page along with a NextToken
response
element. The remaining results of the initial request can be seen by
sending another request with the returned NextToken
value. This value can be between 5 and 1000; if
MaxResults
is given a value larger than 1000, only 1000
results are returned. If this parameter is not used, then
DescribeVolumeStatus
returns all results. You cannot
specify this parameter and the volume IDs parameter in the same
request.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeStatuses
String nextToken
null
when there are no more results to return.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> vpcIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
is-classic-link-enabled
- Whether the VPC is enabled for ClassicLink (true
|
false
).
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcs
Integer maxResults
Constraint: If the value is greater than 1000, we return only 1000 items.
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> serviceNames
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcEndpointIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
service-name
: The name
of the AWS service.
vpc-id
: The ID of the
VPC in which the endpoint resides.
vpc-endpoint-id
: The ID of the endpoint.
vpc-endpoint-state
: The state of the endpoint.
(pending
| available
| deleting
| deleted
)
Integer maxResults
Constraint: If the value is greater than 1000, we return only 1000 items.
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcEndpoints
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcPeeringConnectionIds
Default: Describes all your VPC peering connections.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
accepter-vpc-info.cidr-block
- The CIDR block of the
peer VPC.
accepter-vpc-info.owner-id
- The
AWS account ID of the owner of the peer VPC.
accepter-vpc-info.vpc-id
- The ID of the peer VPC.
expiration-time
- The expiration date and
time for the VPC peering connection.
requester-vpc-info.cidr-block
- The CIDR block of the
requester's VPC.
requester-vpc-info.owner-id
- The AWS account ID of
the owner of the requester VPC.
requester-vpc-info.vpc-id
- The ID of the requester
VPC.
status-code
- The status of the VPC
peering connection (pending-acceptance
|
failed
| expired
| provisioning
| active
| deleted
| rejected
).
status-message
- A message that provides
more information about the status of the VPC peering connection, if
applicable.
tag
:key=value -
The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the
resource. This filter is independent of the tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and
the filter "tag-value=X", you get any resources assigned both the tag
key Purpose (regardless of what the tag's value is), and the tag value
X (regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-peering-connection-id
- The ID
of the VPC peering connection.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcPeeringConnections
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcIds
Default: Describes all your VPCs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
cidr
- The CIDR block
of the VPC. The CIDR block you specify must exactly match the VPC's
CIDR block for information to be returned for the VPC. Must contain
the slash followed by one or two digits (for example,
/28
).
dhcp-options-id
- The ID
of a set of DHCP options.
isDefault
-
Indicates whether the VPC is the default VPC.
state
- The state of the VPC (pending
|
available
).
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id
- The ID of the VPC.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcs
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpnConnectionIds
Default: Describes your VPN connections.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
customer-gateway-configuration
- The configuration
information for the customer gateway.
customer-gateway-id
- The ID of a customer gateway
associated with the VPN connection.
state
-
The state of the VPN connection (pending
|
available
| deleting
|
deleted
).
option.static-routes-only
- Indicates whether the
connection has static routes only. Used for devices that do not
support Border Gateway Protocol (BGP).
route.destination-cidr-block
- The destination CIDR
block. This corresponds to the subnet used in a customer data center.
bgp-asn
- The BGP Autonomous System Number
(ASN) associated with a BGP device.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
type
- The type of VPN connection.
Currently the only supported type is ipsec.1
.
vpn-connection-id
- The ID of the VPN connection.
vpn-gateway-id
- The ID of a virtual
private gateway associated with the VPN connection.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpnConnections
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpnGatewayIds
Default: Describes all your virtual private gateways.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
attachment.state
- The
current state of the attachment between the gateway and the VPC
(attaching
| attached
|
detaching
| detached
).
attachment.vpc-id
- The ID of an attached VPC.
availability-zone
- The Availability Zone for the
virtual private gateway.
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
Boolean returnValue
true
if the request succeeds; otherwise, it
returns an error.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 vpcId
Boolean returnValue
true
if the request succeeds; otherwise, it
returns an error.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: 1-1024
for standard
volumes, 1-16384
for
gp2
volumes, and 4-16384
for
io1
volumes. If you specify a snapshot, the volume size
must be equal to or larger than the snapshot size.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
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 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 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 vpcId
Boolean returnValue
true
if the request succeeds; otherwise, it
returns an error.String instanceId
instanceChange
events.String eventSubType
The following are the error
events.
iamFleetRoleInvalid
- The Spot fleet did not have
the required permissions either to launch or terminate an instance.
launchSpecTemporarilyBlacklisted
- The
configuration is not valid and several attempts to launch instances
have failed. For more information, see the description of the event.
spotFleetRequestConfigurationInvalid
- The
configuration is not valid. For more information, see the description
of the event.
spotInstanceCountLimitExceeded
- You've reached the
limit on the number of Spot instances that you can launch.
The following are the fleetRequestChange
events.
active
- The Spot fleet has been validated and
Amazon EC2 is attempting to maintain the target number of running Spot
instances.
cancelled
- The Spot fleet is
canceled and has no running Spot instances. The Spot fleet will be
deleted two days after its instances were terminated.
cancelled_running
- The Spot fleet is canceled and
will not launch additional Spot instances, but its existing Spot
instances continue to run until they are interrupted or terminated.
cancelled_terminating
- The Spot fleet is
canceled and its Spot instances are terminating.
expired
- The Spot fleet request has expired. A
subsequent event indicates that the instances were terminated, if the
request was created with TerminateInstancesWithExpiration
set.
modify_in_progress
- A request to
modify the Spot fleet request was accepted and is in progress.
modify_successful
- The Spot fleet request was
modified.
price_update
- The bid price for
a launch configuration was adjusted because it was too high. This
change is permanent.
submitted
- The Spot
fleet request is being evaluated and Amazon EC2 is preparing to launch
the target number of Spot instances.
The following are
the instanceChange
events.
launched
- A bid was fulfilled and a new instance was
launched.
terminated
- An instance was
terminated by the user.
String eventDescription
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
[email protected]
.String s3Prefix
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
Date creationTime
String flowLogId
String flowLogStatus
ACTIVE
).String resourceId
String trafficType
Constraints:
Allowed Values: ACCEPT, REJECT, ALL
String logGroupName
String deliverLogsStatus
SUCCESS
|
FAILED
).String deliverLogsErrorMessage
Rate limited
indicates that CloudWatch logs throttling has been applied for one or
more network interfaces. Access error
indicates that the
IAM role associated with the flow log does not have sufficient
permissions to publish to CloudWatch Logs. Unknown error
indicates an internal error.String deliverLogsPermissionArn
String instanceId
String instanceId
Date timestamp
String eventType
error
- Indicates an error
with the Spot fleet request.
fleetRequestChange
- Indicates a change in the status
or configuration of the Spot fleet request.
instanceChange
- Indicates that an instance was
launched or terminated.
Constraints:
Allowed Values: instanceChange, fleetRequestChange, error
EventInformation eventInformation
String imageId
String imageLocation
String state
available
,
the image is successfully registered and can be used to launch an
instance.
Constraints:
Allowed Values: pending, available, invalid, deregistered, transient, failed, error
String ownerId
String creationDate
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
/dev/sda1
or /dev/xvda
).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 description
String format
Valid values:
RAW
| VHD
| VMDK
|
OVA
String url
UserBucket userBucket
String deviceName
String snapshotId
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskContainers
String licenseType
Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see VM Import/Export Prerequisites in the Amazon Elastic Compute Cloud User Guide.
Valid values: AWS
| BYOL
String hypervisor
Valid values: xen
String architecture
Valid values:
i386
| x86_64
String platform
Valid values:
Windows
| Linux
ClientData clientData
String clientToken
String roleName
String importTaskId
String architecture
String licenseType
String platform
String hypervisor
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotDetails
String imageId
String progress
String statusMessage
String status
String importTaskId
String architecture
Valid values:
i386
| x86_64
String licenseType
String platform
String hypervisor
Valid values:
xen
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotDetails
String imageId
String progress
String statusMessage
String status
String architecture
Constraints:
Allowed Values: i386, x86_64
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupIds
String additionalInfo
UserData userData
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, t2.micro, t2.small, t2.medium, t2.large, 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, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.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 description
SnapshotDiskContainer diskContainer
ClientData clientData
String clientToken
String roleName
String importTaskId
SnapshotTaskDetail snapshotTaskDetail
String description
String importTaskId
SnapshotTaskDetail snapshotTaskDetail
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, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, t2.micro, t2.small, t2.medium, t2.large, 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, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.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
or
/dev/xvda
).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
or
/dev/xvda
).com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
Boolean ebsOptimized
String sriovNetSupport
Boolean sourceDestCheck
true
means checking is enabled, and false
means checking is disabled. This value must be false
for
a NAT instance to perform NAT.com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
String deviceName
/dev/sdh
or xvdh
).EbsInstanceBlockDevice ebs
String deviceName
/dev/sdh
or xvdh
).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 macAddress
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
true
.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, initializing
Date impairedSince
String code
Constraints:
Allowed Values: instance-reboot, system-reboot, system-maintenance, instance-retirement, instance-stop
String description
After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].
Date notBefore
Date notAfter
String status
Constraints:
Allowed Values: ok, impaired, insufficient-data, not-applicable, initializing
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. (VPC only) When you call
AuthorizeSecurityGroupIngress, you can use -1
to
specify all.
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> prefixListIds
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, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, t2.micro, t2.small, t2.medium, t2.large, 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, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.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
Constraints:
Allowed Values: add, remove
com.amazonaws.internal.ListWithAutoConstructFlag<T> userIds
launchPermission
attribute.com.amazonaws.internal.ListWithAutoConstructFlag<T> userGroups
launchPermission
attribute.com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
productCodes
attribute.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
instanceInitiatedShutdownBehavior
attribute.com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
DeleteOnTermination
attribute for volumes
that are currently attached. The volume must be owned by the caller.
If no value is specified for DeleteOnTermination
, the
default is true
and the volume is deleted when the
instance is terminated. To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.
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
true
, you can't terminate the instance
using the Amazon EC2 console, CLI, or API; otherwise, you can. You
cannot use this paramater for Spot Instances.String instanceType
InvalidInstanceAttributeValue
.String kernel
String ramdisk
String userData
String instanceInitiatedShutdownBehavior
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
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
Only volume creation permissions may be modified at the customer level.
Constraints:
Allowed Values: productCodes, createVolumePermission
String operationType
Constraints:
Allowed Values: add, remove
com.amazonaws.internal.ListWithAutoConstructFlag<T> userIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
CreateVolumePermissionModifications createVolumePermission
String spotFleetRequestId
Integer targetCapacity
String excessCapacityTerminationPolicy
Constraints:
Allowed Values: noTermination, default
Boolean returnValue
true
if the request succeeds, and an error otherwise.String vpcId
Boolean enableDnsSupport
Boolean enableDnsHostnames
You can only enable DNS hostnames if you also enable DNS support.
String vpcEndpointId
Boolean resetPolicy
true
to reset the policy document to the default
policy. The default policy allows access to the service.String policyDocument
com.amazonaws.internal.ListWithAutoConstructFlag<T> addRouteTableIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> removeRouteTableIds
Boolean returnValue
true
if the request succeeds; otherwise, it
returns an error.String state
Constraints:
Allowed Values: disabled, disabling, enabled, pending
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceMonitorings
String publicIp
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
String prefixListId
String prefixListName
com.amazonaws.internal.ListWithAutoConstructFlag<T> cidrs
String prefixListId
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, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), 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
/dev/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
SpotFleetRequestConfigData spotFleetRequestConfig
String spotFleetRequestId
String spotPrice
String clientToken
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, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, t2.micro, t2.small, t2.medium, t2.large, 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, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.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, No Upfront, Partial Upfront, All Upfront
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, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, t2.micro, t2.small, t2.medium, t2.large, 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, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.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, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, t2.micro, t2.small, t2.medium, t2.large, 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, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.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, No Upfront, Partial Upfront, All Upfront
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 publicIp
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 destinationPrefixListId
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 routeTableAssociationId
String routeTableId
String subnetId
Boolean main
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 do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
Default: Amazon EC2 uses the default security group.
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
Default: Amazon EC2 uses the default security group.
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, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, t2.micro, t2.small, t2.medium, t2.large, 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, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge
Placement placement
String kernelId
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.
String ramdiskId
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
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
String stateMessage
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 kmsKeyId
String dataEncryptionKeyId
Double diskImageSize
String description
String format
String url
UserBucketDetails userBucket
String deviceName
String snapshotId
String progress
String statusMessage
String status
String description
String format
Valid values:
RAW
| VHD
| VMDK
|
OVA
String url
UserBucket userBucket
Double diskImageSize
String description
String format
String url
UserBucketDetails userBucket
String snapshotId
String progress
String statusMessage
String status
String ownerId
String bucket
String prefix
String state
Constraints:
Allowed Values: Active, Inactive
SpotInstanceStateFault fault
String imageId
String keyName
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, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, t2.micro, t2.small, t2.medium, t2.large, 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, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge
SpotPlacement placement
String kernelId
String ramdiskId
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
SpotFleetMonitoring monitoring
String subnetId
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfileSpecification iamInstanceProfile
Boolean ebsOptimized
Default:
false
Double weightedCapacity
If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1.
String spotPrice
WeightedCapacity
.Boolean enabled
Default: false
String spotFleetRequestId
String spotFleetRequestState
Constraints:
Allowed Values: submitted, active, cancelled, failed, cancelled_running, cancelled_terminating, modifying
SpotFleetRequestConfigData spotFleetRequestConfig
Date createTime
String clientToken
String spotPrice
Integer targetCapacity
Date validFrom
Date validUntil
Boolean terminateInstancesWithExpiration
String iamFleetRole
terminateInstancesWithExpiration
.com.amazonaws.internal.ListWithAutoConstructFlag<T> launchSpecifications
Constraints:
Length: 1 -
String excessCapacityTerminationPolicy
Constraints:
Allowed Values: noTermination, default
String allocationStrategy
lowestPrice
.
Constraints:
Allowed Values: lowestPrice, diversified
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, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, t2.micro, t2.small, t2.medium, t2.large, 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, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.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 resourceId
UnsuccessfulItemError error
String data
String userId
String groupName
GroupId
.String groupId
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 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 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 kmsKeyId
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
String vpcId
Boolean classicLinkEnabled
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String vpcEndpointId
String vpcId
String serviceName
String state
Constraints:
Allowed Values: Pending, Available, Deleting, Deleted
String policyDocument
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeTableIds
Date creationTimestamp
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 clusterArn
arn:aws:ecs
namespace, followed by the
region of the cluster, the AWS account ID of the cluster owner, the
cluster
namespace, and then the cluster name. For
example,
arn:aws:ecs:region:012345678910:cluster/test.String clusterName
String status
ACTIVE
or
INACTIVE
. ACTIVE
indicates that you can
register container instances with the cluster and the associated
instances can accept tasks.Integer registeredContainerInstancesCount
Integer runningTasksCount
RUNNING
state.Integer pendingTasksCount
PENDING
state.Integer activeServicesCount
ACTIVE
state. You can view these services with
ListServices.String containerArn
String taskArn
String name
String lastStatus
Integer exitCode
String reason
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkBindings
String name
name
of one container
can be entered in the links
of another container to
connect the containers.String image
repository-url/image:tag
.Integer cpu
cpu
units reserved for the container. A
container instance has 1,024 cpu
units for every CPU
core. This parameter specifies the minimum amount of CPU to reserve
for a container, and containers share unallocated CPU units with other
containers on the instance with the same ratio as their allocated
amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel will allow is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
Integer memory
com.amazonaws.internal.ListWithAutoConstructFlag<T> links
link
parameter allows containers to communicate with
each other without the need for port mappings, using the
name
parameter. The name:internalName
construct is analogous to name:alias
in Docker links. For
more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
com.amazonaws.internal.ListWithAutoConstructFlag<T> portMappings
Boolean essential
essential
parameter of a container is marked as
true
, the failure of that container will stop the task.
If the essential
parameter of a container is marked as
false
, then its failure will not affect the rest of the
containers in a task. If this parameter is omitted, a container is
assumed to be essential. All tasks must have at least one essential container.
com.amazonaws.internal.ListWithAutoConstructFlag<T> entryPoint
Early versions of the Amazon ECS container agent do not
properly handle entryPoint
parameters. If you have
problems using entryPoint
, update your container agent or
enter your commands and arguments as command
array items
instead.
The ENTRYPOINT
that is passed to
the container. For more information on the Docker
ENTRYPOINT
parameter, see https://docs.docker.com/reference/builder/#entrypoint.
com.amazonaws.internal.ListWithAutoConstructFlag<T> command
CMD
that is passed to the container. For more
information on the Docker CMD
parameter, see https://docs.docker.com/reference/builder/#cmd.com.amazonaws.internal.ListWithAutoConstructFlag<T> environment
com.amazonaws.internal.ListWithAutoConstructFlag<T> mountPoints
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumesFrom
String containerInstanceArn
arn:aws:ecs
namespace, followed by the
region of the container instance, the AWS account ID of the container
instance owner, the container-instance
namespace, and
then the container instance UUID. For example,
arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.String ec2InstanceId
VersionInfo versionInfo
com.amazonaws.internal.ListWithAutoConstructFlag<T> remainingResources
com.amazonaws.internal.ListWithAutoConstructFlag<T> registeredResources
String status
ACTIVE
or INACTIVE
. ACTIVE
indicates that the container instance can accept tasks.Boolean agentConnected
true
if the agent is actually
connected to Amazon ECS. Registered instances with an agent that may
be unhealthy or stopped will return false
, and instances
without a connected agent cannot accept placement request.Integer runningTasksCount
RUNNING
status.Integer pendingTasksCount
PENDING
status.String agentUpdateStatus
NULL
.
Constraints:
Allowed Values: PENDING, STAGING, STAGED, UPDATING, UPDATED, FAILED
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> command
com.amazonaws.internal.ListWithAutoConstructFlag<T> environment
String clusterName
default
. Up to
255 letters (uppercase and lowercase), numbers, hyphens, and
underscores are allowed.Cluster cluster
String cluster
String serviceName
String taskDefinition
family
and revision
(family:revision
) or full Amazon Resource Name (ARN) of
the task definition that you want to run in your service. If a
revision
is not specified, the latest ACTIVE
revision is used.com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancers
Integer desiredCount
String clientToken
String role
Service service
String cluster
Cluster cluster
Service service
String id
String status
PRIMARY
(for the most recent deployment), ACTIVE
(for previous
deployments that still have tasks running, but are being replaced with
the PRIMARY
deployment), and INACTIVE
(for
deployments that have been completely replaced).String taskDefinition
Integer desiredCount
Integer pendingCount
PENDING
status.Integer runningCount
RUNNING
status.Date createdAt
Date updatedAt
String cluster
String containerInstance
arn:aws:ecs
namespace, followed by the region of the
container instance, the AWS account ID of the container instance
owner, the container-instance
namespace, and then the
container instance UUID. For example,
arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.Boolean force
force
option, these tasks remain running and they will
continue to pass Elastic Load Balancing load balancer health checks
until you terminate the instance or the tasks stop through some other
means, but they are orphaned (no longer monitored or accounted for by
Amazon ECS). If an orphaned task on your container instance is part of
an Amazon ECS service, then the service scheduler will start another
copy of that task on a different container instance if possible.ContainerInstance containerInstance
String taskDefinition
family
and revision
(family:revision
) or full Amazon Resource Name (ARN) of
the task definition that you want to deregister. You must specify a
revision
.TaskDefinition taskDefinition
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusters
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusters
com.amazonaws.internal.ListWithAutoConstructFlag<T> failures
String cluster
com.amazonaws.internal.ListWithAutoConstructFlag<T> containerInstances
com.amazonaws.internal.ListWithAutoConstructFlag<T> containerInstances
com.amazonaws.internal.ListWithAutoConstructFlag<T> failures
String cluster
com.amazonaws.internal.ListWithAutoConstructFlag<T> services
com.amazonaws.internal.ListWithAutoConstructFlag<T> services
com.amazonaws.internal.ListWithAutoConstructFlag<T> failures
String taskDefinition
family
for the latest ACTIVE
revision,
family
and revision
(family:revision
) for a specific revision in the family,
or full Amazon Resource Name (ARN) of the task definition that you
want to describe.TaskDefinition taskDefinition
String cluster
com.amazonaws.internal.ListWithAutoConstructFlag<T> tasks
com.amazonaws.internal.ListWithAutoConstructFlag<T> tasks
com.amazonaws.internal.ListWithAutoConstructFlag<T> failures
String containerInstance
arn:aws:ecs
namespace, followed by the region of the container instance, the AWS
account ID of the container instance owner, the
container-instance
namespace, and then the container
instance UUID. For example,
arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.String cluster
String sourcePath
String nextToken
nextToken
value returned from a previous paginated
ListClusters
request where maxResults
was
used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the
nextToken
value. This value is null
when
there are no more results to return.Integer maxResults
ListClusters
in paginated output. When this parameter is
used, ListClusters
only returns maxResults
results in a single page along with a nextToken
response
element. The remaining results of the initial request can be seen by
sending another ListClusters
request with the returned
nextToken
value. This value can be between 1 and 100. If
this parameter is not used, then ListClusters
returns up
to 100 results and a nextToken
value if applicable.com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterArns
String nextToken
nextToken
value to include in a future
ListClusters
request. When the results of a
ListClusters
request exceed maxResults
, this
value can be used to retrieve the next page of results. This value is
null
when there are no more results to return.String cluster
String nextToken
nextToken
value returned from a previous paginated
ListContainerInstances
request where
maxResults
was used and the results exceeded the value of
that parameter. Pagination continues from the end of the previous
results that returned the nextToken
value. This value is
null
when there are no more results to return.Integer maxResults
ListContainerInstances
in paginated output. When this
parameter is used, ListContainerInstances
only returns
maxResults
results in a single page along with a
nextToken
response element. The remaining results of the
initial request can be seen by sending another
ListContainerInstances
request with the returned
nextToken
value. This value can be between 1 and 100. If
this parameter is not used, then ListContainerInstances
returns up to 100 results and a nextToken
value if
applicable.com.amazonaws.internal.ListWithAutoConstructFlag<T> containerInstanceArns
String nextToken
nextToken
value to include in a future
ListContainerInstances
request. When the results of a
ListContainerInstances
request exceed
maxResults
, this value can be used to retrieve the next
page of results. This value is null
when there are no
more results to return.String cluster
String nextToken
nextToken
value returned from a previous paginated
ListServices
request where maxResults
was
used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the
nextToken
value. This value is null
when
there are no more results to return.Integer maxResults
ListServices
in paginated output. When this parameter is
used, ListServices
only returns maxResults
results in a single page along with a nextToken
response
element. The remaining results of the initial request can be seen by
sending another ListServices
request with the returned
nextToken
value. This value can be between 1 and 100. If
this parameter is not used, then ListServices
returns up
to 100 results and a nextToken
value if applicable.com.amazonaws.internal.ListWithAutoConstructFlag<T> serviceArns
String nextToken
nextToken
value to include in a future
ListServices
request. When the results of a
ListServices
request exceed maxResults
, this
value can be used to retrieve the next page of results. This value is
null
when there are no more results to return.String familyPrefix
familyPrefix
is a string that is used to filter the
results of ListTaskDefinitionFamilies
. If you specify a
familyPrefix
, only task definition family names that
begin with the familyPrefix
string are returned.String nextToken
nextToken
value returned from a previous paginated
ListTaskDefinitionFamilies
request where
maxResults
was used and the results exceeded the value of
that parameter. Pagination continues from the end of the previous
results that returned the nextToken
value. This value is
null
when there are no more results to return.Integer maxResults
ListTaskDefinitionFamilies
in paginated output. When this
parameter is used, ListTaskDefinitions
only returns
maxResults
results in a single page along with a
nextToken
response element. The remaining results of the
initial request can be seen by sending another
ListTaskDefinitionFamilies
request with the returned
nextToken
value. This value can be between 1 and 100. If
this parameter is not used, then
ListTaskDefinitionFamilies
returns up to 100 results and
a nextToken
value if applicable.com.amazonaws.internal.ListWithAutoConstructFlag<T> families
ListTaskDefinitionFamilies
request.String nextToken
nextToken
value to include in a future
ListTaskDefinitionFamilies
request. When the results of a
ListTaskDefinitionFamilies
request exceed
maxResults
, this value can be used to retrieve the next
page of results. This value is null
when there are no
more results to return.String familyPrefix
ListTaskDefinitions
results with. Specifying a
familyPrefix
will limit the listed task definitions to
task definition revisions that belong to that family.String status
ListTaskDefinitions
results with. By default, only
ACTIVE
task definitions are listed. By setting this
parameter to INACTIVE
, you can view task definitions that
are INACTIVE
as long as an active task or service still
references them. If you paginate the resulting output, be sure to keep
the status
value constant in each subsequent request.
Constraints:
Allowed Values: ACTIVE, INACTIVE
String sort
ASC
and DESC
. By default (ASC
),
task definitions are listed lexicographically by family name and in
ascending numerical order by revision so that the newest task
definitions in a family are listed last. Setting this parameter to
DESC
reverses the sort order on family name and revision
so that the newest task definitions in a family are listed first.
Constraints:
Allowed Values: ASC, DESC
String nextToken
nextToken
value returned from a previous paginated
ListTaskDefinitions
request where maxResults
was used and the results exceeded the value of that parameter.
Pagination continues from the end of the previous results that
returned the nextToken
value. This value is
null
when there are no more results to return.Integer maxResults
ListTaskDefinitions
in paginated output. When this
parameter is used, ListTaskDefinitions
only returns
maxResults
results in a single page along with a
nextToken
response element. The remaining results of the
initial request can be seen by sending another
ListTaskDefinitions
request with the returned
nextToken
value. This value can be between 1 and 100. If
this parameter is not used, then ListTaskDefinitions
returns up to 100 results and a nextToken
value if
applicable.com.amazonaws.internal.ListWithAutoConstructFlag<T> taskDefinitionArns
ListTaskDefintions
request.String nextToken
nextToken
value to include in a future
ListTaskDefinitions
request. When the results of a
ListTaskDefinitions
request exceed
maxResults
, this value can be used to retrieve the next
page of results. This value is null
when there are no
more results to return.String cluster
String containerInstance
ListTasks
results with. Specifying a containerInstance
will limit
the results to tasks that belong to that container instance.String family
ListTasks
results with. Specifying a family
will limit the results to tasks that belong to that family.String nextToken
nextToken
value returned from a previous paginated
ListTasks
request where maxResults
was used
and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the
nextToken
value. This value is null
when
there are no more results to return.Integer maxResults
ListTasks
in paginated output. When this parameter is used,
ListTasks
only returns maxResults
results in
a single page along with a nextToken
response element.
The remaining results of the initial request can be seen by sending
another ListTasks
request with the returned
nextToken
value. This value can be between 1 and 100. If
this parameter is not used, then ListTasks
returns up to
100 results and a nextToken
value if applicable.String startedBy
startedBy
value that you want to filter the task
results with. Specifying a startedBy
value will limit the
results to tasks that were started with that value.String serviceName
ListTasks
results with. Specifying a
serviceName
will limit the results to tasks that belong
to that service.String desiredStatus
ListTasks
results with. Specifying a desiredStatus
of
STOPPED
will limit the results to tasks that are in the
STOPPED
status, which can be useful for debugging tasks
that are not starting properly or have died or finished. The default
status filter is RUNNING
.
Constraints:
Allowed Values: RUNNING, PENDING, STOPPED
com.amazonaws.internal.ListWithAutoConstructFlag<T> taskArns
ListTasks
request.String nextToken
nextToken
value to include in a future
ListTasks
request. When the results of a
ListTasks
request exceed maxResults
, this
value can be used to retrieve the next page of results. This value is
null
when there are no more results to return.String loadBalancerName
String containerName
Integer containerPort
containerPort
in the service's
task definition. Your container instances must allow ingress traffic
on the hostPort
of the port mapping.String sourceVolume
String containerPath
Boolean readOnly
true
, the container has read-only access
to the volume. If this value is false
, then the container
can write to the volume. The default value is false
.String bindIP
Integer containerPort
Integer hostPort
String protocol
Constraints:
Allowed Values: tcp, udp
Integer containerPort
hostPort
).Integer hostPort
hostPort
(or set it to
0
) while specifying a containerPort
and your
container will automatically receive a port in the ephemeral port
range for your container instance operating system and Docker version.
The default ephemeral port range is 49153 to 65535, and this range
is used for Docker versions prior to 1.6.0. For Docker version 1.6.0
and later, the Docker daemon tries to read the ephemeral port range
from /proc/sys/net/ipv4/ip_local_port_range
; if this
kernel parameter is unavailable, the default ephemeral port range is
used. You should not attempt to specify a host port in the ephemeral
port range, since these are reserved for automatic assignment. In
general, ports below 32768 are outside of the ephemeral port range.
The default reserved ports are 22 for SSH, the Docker ports 2375
and 2376, and the Amazon ECS Container Agent port 51678. Any host port
that was previously specified in a running task is also reserved while
the task is running (once a task stops, the host port is released).The
current reserved ports are displayed in the
remainingResources
of DescribeContainerInstances
output, and a container instance may have up to 50 reserved ports at a
time, including the default reserved ports (automatically assigned
ports do not count toward this limit).
String protocol
tcp
and udp
. The default is
tcp
.
Constraints:
Allowed Values: tcp, udp
String cluster
String instanceIdentityDocument
curl
http://169.254.169.254/latest/dynamic/instance-identity/document/
String instanceIdentityDocumentSignature
curl
http://169.254.169.254/latest/dynamic/instance-identity/signature/
com.amazonaws.internal.ListWithAutoConstructFlag<T> totalResources
VersionInfo versionInfo
String containerInstanceArn
ContainerInstance containerInstance
String family
family
for a task definition, which
allows you to track multiple versions of the same task definition. You
can think of the family
as a name for your task
definition. Up to 255 letters (uppercase and lowercase), numbers,
hyphens, and underscores are allowed.com.amazonaws.internal.ListWithAutoConstructFlag<T> containerDefinitions
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumes
TaskDefinition taskDefinition
String name
CPU
,
MEMORY
, PORTS
, or a user-defined resource.String type
INTEGER
,
DOUBLE
, LONG
, or STRINGSET
.Double doubleValue
doubleValue
type is set, the value of the
resource must be a double precision floating-point type.Long longValue
longValue
type is set, the value of the resource
must be an extended precision floating-point type.Integer integerValue
integerValue
type is set, the value of the
resource must be an integer.com.amazonaws.internal.ListWithAutoConstructFlag<T> stringSetValue
stringSetValue
type is set, the value of the
resource must be a string type.String cluster
String taskDefinition
family
and revision
(family:revision
) or full Amazon Resource Name (ARN) of
the task definition that you want to run. If a revision
is not specified, the latest ACTIVE
revision is used.TaskOverride overrides
command
override. You can also override existing
environment variables (that are specified in the task definition or
Docker image) on a container or add new environment variables to it
with an environment
override. A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
Integer count
The count
parameter is limited to 10 tasks per call.
String startedBy
startedBy
parameter. You can then identify which tasks
belong to that job by filtering the results of a ListTasks call
with the startedBy
value. If a task is started by an
Amazon ECS service, then the startedBy
parameter contains
the deployment ID of the service that starts it.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tasks
com.amazonaws.internal.ListWithAutoConstructFlag<T> failures
RunTask
action are listed
here.String serviceArn
arn:aws:ecs
namespace, followed by the
region of the service, the AWS account ID of the service owner, the
service
namespace, and then the service name. For
example,
arn:aws:ecs:region:012345678910:service/my-service.String serviceName
String clusterArn
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancers
String status
ACTIVE
,
DRAINING
, or INACTIVE
.Integer desiredCount
Integer runningCount
RUNNING
state.Integer pendingCount
PENDING
state.String taskDefinition
com.amazonaws.internal.ListWithAutoConstructFlag<T> deployments
String roleArn
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String cluster
String taskDefinition
family
and revision
(family:revision
) or full Amazon Resource Name (ARN) of
the task definition that you want to start. If a revision
is not specified, the latest ACTIVE
revision is used.TaskOverride overrides
command
override. You can also override existing
environment variables (that are specified in the task definition or
Docker image) on a container or add new environment variables to it
with an environment
override. A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
com.amazonaws.internal.ListWithAutoConstructFlag<T> containerInstances
The list of container instances to start tasks on is limited to 10.
String startedBy
startedBy
parameter. You can then identify which tasks
belong to that job by filtering the results of a ListTasks call
with the startedBy
value. If a task is started by an
Amazon ECS service, then the startedBy
parameter contains
the deployment ID of the service that starts it.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tasks
com.amazonaws.internal.ListWithAutoConstructFlag<T> failures
StartTask
action are listed
here.String cluster
String task
Task task
String cluster
String task
String containerName
String status
Integer exitCode
String reason
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkBindings
String acknowledgment
String cluster
String task
String status
String reason
String acknowledgment
String taskArn
String clusterArn
String taskDefinitionArn
String containerInstanceArn
TaskOverride overrides
String lastStatus
String desiredStatus
com.amazonaws.internal.ListWithAutoConstructFlag<T> containers
String startedBy
startedBy
parameter contains
the deployment ID of the service that starts it.String taskDefinitionArn
com.amazonaws.internal.ListWithAutoConstructFlag<T> containerDefinitions
String family
family
as the name of your task definition.Integer revision
1
, and each time you register a new revision of a task
definition in the same family, the revision value always increases by
one (even if you have deregistered previous revisions in this family).com.amazonaws.internal.ListWithAutoConstructFlag<T> volumes
String status
Constraints:
Allowed Values: ACTIVE, INACTIVE
com.amazonaws.internal.ListWithAutoConstructFlag<T> containerOverrides
String cluster
String containerInstance
ContainerInstance containerInstance
String cluster
String service
Integer desiredCount
String taskDefinition
family
and revision
(family:revision
) or full Amazon Resource Name (ARN) of
the task definition that you want to run in your service. If a
revision
is not specified, the latest ACTIVE
revision is used. If you modify the task definition with
UpdateService
, Amazon ECS spawns a task with the new
version of the task definition and then stops an old task after the
new version is running.Service service
String agentVersion
String agentHash
String dockerVersion
String name
sourceVolume
parameter of container definition
mountPoints
.HostVolumeProperties host
String resourceName
arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
.com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
String cacheSecurityGroupName
String eC2SecurityGroupName
String eC2SecurityGroupOwnerId
String name
String cacheClusterId
Endpoint configurationEndpoint
String clientDownloadLandingPage
String cacheNodeType
Valid node types are as follows:
cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
cache.t1.micro
,
cache.m1.small
, 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
Notes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
String engine
String engineVersion
String cacheClusterStatus
Integer numCacheNodes
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
String preferredAvailabilityZone
Date cacheClusterCreateTime
String preferredMaintenanceWindow
ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
PendingModifiedValues pendingModifiedValues
NotificationConfiguration notificationConfiguration
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroups
CacheParameterGroupStatus cacheParameterGroup
String cacheSubnetGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodes
Boolean autoMinorVersionUpgrade
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
If the specified replication group is Multi-AZ enabled and the availability zone is not specified, the cache cluster will be created in availability zones that provide the best spread of read replicas across availability zones.
Note: This
parameter is only valid if the Engine
parameter is
redis
.
String aZMode
This parameter is only supported for Memcached cache clusters.
If the AZMode
and
PreferredAvailabilityZones
are not specified, ElastiCache
assumes single-az
mode.
Constraints:
Allowed Values: single-az, cross-az
String preferredAvailabilityZone
All nodes belonging to this Memcached cache cluster are placed in
the preferred Availability Zone. If you want to create your 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. 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 the 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 different Availability Zones:
PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2b&PreferredAvailabilityZones.member.3=us-west-2c
Example: All three Memcached nodes in one Availability Zone:
PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a
Integer numCacheNodes
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
String cacheNodeType
Valid node types are as follows:
cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
cache.t1.micro
,
cache.m1.small
, 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
Notes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
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 cache cluster in an Amazon Virtual Private Cloud (VPC).
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroupNames
Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC).
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotArns
Note: This parameter is only valid if the
Engine
parameter is redis
.
Example of an
Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
String snapshotName
restoring
while the
new node group is being created. Note: This parameter is
only valid if the Engine
parameter is redis
.
String preferredMaintenanceWindow
ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
Integer port
String notificationTopicArn
Boolean autoMinorVersionUpgrade
Integer snapshotRetentionLimit
SnapshotRetentionLimit
to 5, then a snapshot that was
taken today will be retained for 5 days before being deleted.
Note: This parameter is only valid if the
Engine
parameter is redis
.
Default: 0 (i.e., automatic backups are 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.
Note: This parameter is only valid if the
Engine
parameter is redis
.
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. Cannot 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 replicationGroupDescription
String primaryClusterId
This parameter is not required if NumCacheClusters is specified.
Boolean automaticFailoverEnabled
If
true
, Multi-AZ is enabled for this replication group. If
false
, Multi-AZ is disabled for this replication group.
Default: false ElastiCache Multi-AZ replication groups is
not supported on:
Integer numCacheClusters
If Multi-AZ is enabled
, the value of this
parameter must be at least 2.
The maximum permitted value for NumCacheClusters is 6 (primary plus 5 replicas). If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request.
com.amazonaws.internal.ListWithAutoConstructFlag<T> preferredCacheClusterAZs
The number of availability zones listed must equal the value of NumCacheClusters.
Default: system chosen availability zones.
Example: One Redis cache cluster in each of three availability zones. PreferredAvailabilityZones.member.1=us-west-2a PreferredAvailabilityZones.member.2=us-west-2c PreferredAvailabilityZones.member.3=us-west-2c
String cacheNodeType
Valid node types are as follows:
cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
cache.t1.micro
,
cache.m1.small
, 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
Notes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
String engine
Default: redis
String engineVersion
String cacheParameterGroupName
String cacheSubnetGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroupNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (VPC).
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotArns
Note: This parameter is only valid if the
Engine
parameter is redis
.
Example of an
Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
String snapshotName
restoring
while the
new node group is being created. Note: This parameter is
only valid if the Engine
parameter is redis
.
String preferredMaintenanceWindow
ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
Integer port
String notificationTopicArn
Boolean autoMinorVersionUpgrade
Integer snapshotRetentionLimit
SnapshotRetentionLimit
to 5, then a snapshot that was
taken today will be retained for 5 days before being deleted.
Note: This parameter is only valid if the
Engine
parameter is redis
.
Default: 0 (i.e., automatic backups are 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.
Note: This parameter is only valid if the
Engine
parameter is redis
.
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
Valid node types are as follows:
cache.t2.micro
, cache.t2.small
,
cache.t2.medium
, cache.m3.medium
,
cache.m3.large
, cache.m3.xlarge
,
cache.m3.2xlarge
cache.t1.micro
, cache.m1.small
,
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
Notes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
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
Valid node types are as follows:
cache.t2.micro
, cache.t2.small
,
cache.t2.medium
, cache.m3.medium
,
cache.m3.large
, cache.m3.xlarge
,
cache.m3.2xlarge
cache.t1.micro
, cache.m1.small
,
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
Notes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
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 resourceName
arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
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 clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
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.
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.
Constraints:
Allowed Values: single-az, cross-az
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 optionally specify two Availability Zones for the two new
nodes.NumCacheNodes=6
((3 + 2) + 1)NumCacheNodes=3
to cancel all pending
actions.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.
Impact of new add/remove requests upon pending requests
Scenarios | Pending action | New Request | Results |
---|---|---|---|
Scenario-1 | Delete | Delete | The new delete, pending or immediate, replaces the pending delete. |
Scenario-2 | Delete | Create | The new create, pending or immediate, replaces the pending delete. |
Scenario-3 | Create | Delete | The new delete, pending or immediate, replaces the pending create. |
Scenario-4 | Create | Create | The new
create is added to the pending create. Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending. |
Example:
NewAvailabilityZones.member.1=us-west-2a&NewAvailabilityZones.member.2=us-west-2b&NewAvailabilityZones.member.3=us-west-2c
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
ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
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
Integer snapshotRetentionLimit
Important
If the value of SnapshotRetentionLimit is set
to zero (0), backups are turned off.
String snapshotWindow
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
String primaryClusterId
String snapshottingClusterId
Boolean automaticFailoverEnabled
Valid values:
ElastiCache Multi-AZ
replication groups are not supported on: true
| false
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroupNames
This parameter can be used only with replication group 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 group containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
String preferredMaintenanceWindow
ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
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
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 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
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
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 resourceName
arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
TagKeys
identifying the tags you want removed
from the named resource. For example,
TagKeys.member.1=Region
removes the cost allocation tag
with the key name Region
from the resource named by the
ResourceName parameter.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
String replicationGroupId
String description
String status
ReplicationGroupPendingModifiedValues pendingModifiedValues
com.amazonaws.internal.ListWithAutoConstructFlag<T> memberClusters
com.amazonaws.internal.ListWithAutoConstructFlag<T> nodeGroups
String snapshottingClusterId
String automaticFailover
ElastiCache Multi-AZ replication groups are not supported on:
Constraints:
Allowed Values: enabled, disabled, enabling, disabling
String primaryClusterId
--apply-immediately
was specified), or during the next
maintenance window.String automaticFailoverStatus
ElastiCache Multi-AZ replication groups are not supported on:
Constraints:
Allowed Values: enabled, disabled
String reservedCacheNodeId
String reservedCacheNodesOfferingId
String cacheNodeType
Valid node types are as follows:
cache.t2.micro
, cache.t2.small
,
cache.t2.medium
, cache.m3.medium
,
cache.m3.large
, cache.m3.xlarge
,
cache.m3.2xlarge
cache.t1.micro
, cache.m1.small
,
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
Notes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
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
Valid node types are as follows:
cache.t2.micro
, cache.t2.small
,
cache.t2.medium
, cache.m3.medium
,
cache.m3.large
, cache.m3.xlarge
,
cache.m3.2xlarge
cache.t1.micro
, cache.m1.small
,
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
Notes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
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
Valid node types are as follows:
cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
cache.t1.micro
,
cache.m1.small
, 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
Notes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
String engine
String engineVersion
Integer numCacheNodes
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
String preferredAvailabilityZone
Date cacheClusterCreateTime
String preferredMaintenanceWindow
ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
String topicArn
Integer port
String cacheParameterGroupName
String cacheSubnetGroupName
String vpcId
Boolean autoMinorVersionUpgrade
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
The name of the application.
String description
User-defined description of the application.
Date dateCreated
The date when the application was created.
Date dateUpdated
The date when the application was last modified.
com.amazonaws.internal.SdkInternalList<T> versions
The names of the versions for this application.
com.amazonaws.internal.SdkInternalList<T> configurationTemplates
The names of the configuration templates associated with this application.
Integer duration
The amount of time that the metrics cover (usually 10 seconds). For
example, you might have 5 requests (request_count
) within
the most recent time slice of 10 seconds (duration
).
Integer requestCount
Average number of requests handled by the web server per second over the last 10 seconds.
StatusCodes statusCodes
Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response.
Latency latency
Represents the average latency for the slowest X percent of requests over the last 10 seconds. Latencies are in seconds with one milisecond resolution.
String applicationName
The name of the application associated with this release.
String description
The description of this application version.
String versionLabel
A label uniquely identifying the version for the associated application.
S3Location sourceBundle
The location where the source bundle is located for this version.
Date dateCreated
The creation date of the application version.
Date dateUpdated
The last modified date of the application version.
String name
The name of the AutoScalingGroup
.
String cNAMEPrefix
The prefix used when this CNAME is reserved.
Boolean available
Indicates if the specified CNAME is available:
true
: The CNAME is available.
true
: The CNAME is not available.
true
: The CNAME is available.false
: The CNAME is not available.String fullyQualifiedCNAME
The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix.
String namespace
A unique namespace identifying the option's associated AWS resource.
String name
The name of the configuration option.
String defaultValue
The default value for this configuration option.
String changeSeverity
An indication of which action is required if the value for this configuration option changes:
NoInterruption - There is no interruption to the environment or application availability.
RestartEnvironment - The environment is restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.
RestartApplicationServer - The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.
NoInterruption
: There is no interruption to the
environment or application availability.RestartEnvironment
: The environment is entirely
restarted, all AWS resources are deleted and recreated, and the
environment is unavailable during the process.RestartApplicationServer
: The environment is available
the entire time. However, a short application outage occurs when the
application servers on the running Amazon EC2 instances are restarted.Boolean userDefined
An indication of whether the user defined this configuration option:
true
: This configuration option was defined by the user. It
is a valid choice for specifying this as an Option to Remove when
updating configuration settings.
false
: This configuration was not defined by the user.
true
: This configuration option was defined by the user. It
is a valid choice for specifying if this as an
Option to Remove
when updating configuration settings.
false
: This configuration was not defined by the user.
Constraint: You can remove only UserDefined
options from a
configuration.
Valid Values: true
| false
String valueType
An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:
Scalar
: Values for this option are a single selection from
the possible values, or a unformatted string or numeric value governed by
the MIN/MAX/Regex constraints:
List
: Values for this option are multiple selections of the
possible values.
Boolean
: Values for this option are either
true
or false
.
Json
: Values for this option are a JSON representation of a
ConfigDocument
.
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
.Json
: Values for this option are a JSON representation
of a ConfigDocument
.com.amazonaws.internal.SdkInternalList<T> valueOptions
If specified, values for the configuration option are selected from this list.
Integer minValue
If specified, the configuration option must be a numeric value greater than this value.
Integer maxValue
If specified, the configuration option must be a numeric value less than this value.
Integer maxLength
If specified, the configuration option must be a string value no longer than this value.
OptionRestrictionRegex regex
If specified, the configuration option must be a string value that satisfies this regular expression.
String resourceName
A unique resource name for a time-based scaling configuration option.
String namespace
A unique namespace identifying the option's associated AWS resource.
String optionName
The name of the configuration option.
String value
The current value for the configuration option.
String solutionStackName
The name of the solution stack this configuration set uses.
String applicationName
The name of the application associated with this configuration set.
String templateName
If not null
, the name of the configuration template for this
configuration set.
String description
Describes this configuration set.
String environmentName
If not null
, the name of the environment for this
configuration set.
String deploymentStatus
If this configuration set is associated with an environment, the
DeploymentStatus
parameter indicates the deployment status
of this configuration set:
null
: This configuration is not associated with a running
environment.
pending
: This is a draft configuration that is not deployed
to the associated environment but is in the process of deploying.
deployed
: This is the configuration that is currently
deployed to the associated running environment.
failed
: This is a draft configuration, that failed to
successfully deploy.
null
: This configuration is not associated with a
running environment.pending
: This is a draft configuration that is not
deployed to the associated environment but is in the process of
deploying.deployed
: This is the configuration that is currently
deployed to the associated running environment.failed
: This is a draft configuration that failed to
successfully deploy.Date dateCreated
The date (in UTC time) when this configuration set was created.
Date dateUpdated
The date (in UTC time) when this configuration set was last modified.
com.amazonaws.internal.SdkInternalList<T> optionSettings
A list of the configuration options and their values in this configuration set.
Double user
Percentage of time that the CPU has spent in the User
state
over the last 10 seconds.
Double nice
Percentage of time that the CPU has spent in the Nice
state
over the last 10 seconds.
Double system
Percentage of time that the CPU has spent in the System
state over the last 10 seconds.
Double idle
Percentage of time that the CPU has spent in the Idle
state
over the last 10 seconds.
Double iOWait
Percentage of time that the CPU has spent in the I/O Wait
state over the last 10 seconds.
Double iRQ
Percentage of time that the CPU has spent in the IRQ
state
over the last 10 seconds.
Double softIRQ
Percentage of time that the CPU has spent in the SoftIRQ
state over the last 10 seconds.
ApplicationDescription application
The ApplicationDescription of the application.
String applicationName
The name of the application. If no application is found with this name,
and AutoCreateApplication
is false
, returns an
InvalidParameterValue
error.
String versionLabel
A label identifying this version.
Constraint: Must be unique per application. If an application version
already exists with this label for the specified application, AWS Elastic
Beanstalk returns an InvalidParameterValue
error.
String description
Describes this version.
S3Location sourceBundle
The Amazon S3 bucket and key that identify the location of the source bundle for this version.
If data found at the Amazon S3 location exceeds the maximum allowed
source bundle size, AWS Elastic Beanstalk returns an
InvalidParameterValue
error. 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
Determines how the system behaves if the specified application for this version does not already exist:
true
: Automatically creates the specified application for
this version if it does not already exist.
false
: Returns an InvalidParameterValue
if the
specified application for this version does not already exist.
true
: Automatically creates the specified application
for this release if it does not already exist.false
: Throws an InvalidParameterValue
if
the specified application for this release does not already exist.
Default: false
Valid Values: true
| false
ApplicationVersionDescription applicationVersion
The ApplicationVersionDescription of the application version.
String applicationName
The name of the application to associate with this configuration
template. If no application is found with this name, AWS Elastic
Beanstalk returns an InvalidParameterValue
error.
String templateName
The name of the configuration template.
Constraint: This name must be unique per application.
Default: If a configuration template already exists with this name, AWS
Elastic Beanstalk returns an InvalidParameterValue
error.
String solutionStackName
The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values.
Use ListAvailableSolutionStacks to obtain a list of available solution stacks.
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.
SourceConfiguration sourceConfiguration
If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
Values specified in the OptionSettings
parameter of this
call overrides any values obtained from the
SourceConfiguration
.
If no configuration template is found, returns an
InvalidParameterValue
error.
Constraint: If both the solution stack name parameter and the source
configuration parameters are specified, the solution stack of the source
configuration template must match the specified solution stack name or
else AWS Elastic Beanstalk returns an
InvalidParameterCombination
error.
String environmentId
The ID of the environment used with this configuration template.
String description
Describes this configuration.
com.amazonaws.internal.SdkInternalList<T> optionSettings
If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template.
String solutionStackName
The name of the solution stack this configuration set uses.
String applicationName
The name of the application associated with this configuration set.
String templateName
If not null
, the name of the configuration template for this
configuration set.
String description
Describes this configuration set.
String environmentName
If not null
, the name of the environment for this
configuration set.
String deploymentStatus
If this configuration set is associated with an environment, the
DeploymentStatus
parameter indicates the deployment status
of this configuration set:
null
: This configuration is not associated with a running
environment.
pending
: This is a draft configuration that is not deployed
to the associated environment but is in the process of deploying.
deployed
: This is the configuration that is currently
deployed to the associated running environment.
failed
: This is a draft configuration, that failed to
successfully deploy.
null
: This configuration is not associated with a
running environment.pending
: This is a draft configuration that is not
deployed to the associated environment but is in the process of
deploying.deployed
: This is the configuration that is currently
deployed to the associated running environment.failed
: This is a draft configuration that failed to
successfully deploy.Date dateCreated
The date (in UTC time) when this configuration set was created.
Date dateUpdated
The date (in UTC time) when this configuration set was last modified.
com.amazonaws.internal.SdkInternalList<T> optionSettings
A list of the configuration options and their values in this configuration set.
String applicationName
The name of the application that contains the version to be deployed.
If no application is found with this name, CreateEnvironment
returns an InvalidParameterValue
error.
String environmentName
A unique name for the deployment environment. Used in the application URL.
Constraint: Must be from 4 to 23 characters in length. The name can
contain only letters, numbers, and hyphens. It cannot start or end with a
hyphen. This name must be unique in your account. If the specified name
already exists, AWS Elastic Beanstalk returns an
InvalidParameterValue
error.
Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
String description
Describes this environment.
String cNAMEPrefix
If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
EnvironmentTier tier
This specifies the tier to use for creating this environment.
com.amazonaws.internal.SdkInternalList<T> tags
This specifies the tags applied to resources in the environment.
String versionLabel
The name of the application version to deploy.
If the specified application has no associated application versions, AWS
Elastic Beanstalk UpdateEnvironment
returns an
InvalidParameterValue
error.
Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.
String templateName
The name of the configuration template to use in deployment. If no
configuration template is found with this name, AWS Elastic Beanstalk
returns an InvalidParameterValue
error.
Condition: You must specify either this parameter or a
SolutionStackName
, but not both. If you specify both, AWS
Elastic Beanstalk returns an InvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns a
MissingRequiredParameter
error.
String solutionStackName
This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.
Condition: You must specify either this or a TemplateName
,
but not both. If you specify both, AWS Elastic Beanstalk returns an
InvalidParameterCombination
error. If you do not specify
either, AWS Elastic Beanstalk returns a
MissingRequiredParameter
error.
com.amazonaws.internal.SdkInternalList<T> optionSettings
If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.
com.amazonaws.internal.SdkInternalList<T> optionsToRemove
A list of custom user-defined configuration options to remove from the configuration set for this new environment.
String environmentName
The name of this environment.
String environmentId
The ID of this environment.
String applicationName
The name of the application associated with this environment.
String versionLabel
The application version deployed in this environment.
String solutionStackName
The name of the SolutionStack
deployed with this
environment.
String templateName
The name of the configuration template used to originally launch this environment.
String description
Describes this environment.
String endpointURL
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
String cNAME
The URL to the CNAME for this environment.
Date dateCreated
The creation date for this environment.
Date dateUpdated
The last modified date for this environment.
String status
The current operational status of the environment:
Launching
: Environment is in the process of initial
deployment.Updating
: Environment is in the process of updating its
configuration settings or application version.Ready
: Environment is available to have an action
performed on it, such as update or terminate.Terminating
: Environment is in the shut-down process.Terminated
: Environment is not running.Boolean abortableOperationInProgress
Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
true:
There is an update in progress.
false:
There are no updates currently in progress.
String health
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red
: Indicates the environment is not working.
Yellow
: Indicates that something is wrong, the application
might not be available, but the instances appear running.
Green
: Indicates the environment is healthy and fully
functional.
Red
: Indicates the environment is not responsive. Occurs
when three or more consecutive failures occur for an environment.Yellow
: Indicates that something is wrong. Occurs when
two consecutive failures occur for an environment.Green
: Indicates the environment is healthy and fully
functional.Grey
: Default health for a new environment. The
environment is not fully launched and health checks have not started or
health checks are suspended during an UpdateEnvironment
or
RestartEnvironement
request.
Default: Grey
String healthStatus
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
EnvironmentResourcesDescription resources
The description of the AWS resources used by this environment.
EnvironmentTier tier
Describes the current tier of this environment.
String s3Bucket
The name of the Amazon S3 bucket created.
String applicationName
The name of the application to delete releases from.
String versionLabel
The label of the version to delete.
Boolean deleteSourceBundle
Indicates whether to delete the associated source bundle from Amazon S3:
true
: An attempt is made to delete the associated Amazon
S3 source bundle specified at time of creation.false
: No action is taken on the Amazon S3 source bundle
specified at time of creation.
Valid Values: true
| false
com.amazonaws.internal.SdkInternalList<T> applicationNames
If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.
com.amazonaws.internal.SdkInternalList<T> applications
This parameter contains a list of ApplicationDescription.
String applicationName
If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include ones that are associated with the specified application.
com.amazonaws.internal.SdkInternalList<T> versionLabels
If specified, restricts the returned descriptions to only include ones that have the specified version labels.
com.amazonaws.internal.SdkInternalList<T> applicationVersions
A list of ApplicationVersionDescription .
String applicationName
The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.
String templateName
The name of the configuration template whose configuration options you want to describe.
String environmentName
The name of the environment whose configuration options you want to describe.
String solutionStackName
The name of the solution stack whose configuration options you want to describe.
com.amazonaws.internal.SdkInternalList<T> options
If specified, restricts the descriptions to only the specified options.
String solutionStackName
The name of the solution stack these configuration options belong to.
com.amazonaws.internal.SdkInternalList<T> options
A list of ConfigurationOptionDescription.
String applicationName
The application for the environment or configuration template.
String templateName
The name of the configuration template to describe.
Conditional: You must specify either this parameter or an
EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk
returns an InvalidParameterCombination
error. If you do not
specify either, AWS Elastic Beanstalk returns a
MissingRequiredParameter
error.
String environmentName
The name of the environment to describe.
Condition: You must specify either this or a TemplateName, but not both.
If you specify both, AWS Elastic Beanstalk returns an
InvalidParameterCombination
error. If you do not specify
either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
com.amazonaws.internal.SdkInternalList<T> configurationSettings
A list of ConfigurationSettingsDescription.
String environmentName
Specifies the AWS Elastic Beanstalk environment name.
String environmentId
Specifies the AWS Elastic Beanstalk environment ID.
com.amazonaws.internal.SdkInternalList<T> attributeNames
Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk returns all response elements.
String environmentName
The AWS Elastic Beanstalk environment name.
String healthStatus
Contains the response body with information about the health of the environment.
String status
Returns the health status value of the environment. For more information, see Health Colors and Statuses.
String color
Returns the color indicator that tells you information about the health of the environment. For more information, see Health Colors and Statuses.
com.amazonaws.internal.SdkInternalList<T> causes
Returns potential causes for the reported status.
ApplicationMetrics applicationMetrics
InstanceHealthSummary instancesHealth
Date refreshedAt
The date and time the information was last refreshed.
String environmentId
The ID of the environment to retrieve AWS resource usage data.
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
String environmentName
The name of the environment to retrieve AWS resource usage data.
Condition: You must specify either this or an EnvironmentId, or both. If
you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
EnvironmentResourceDescription environmentResources
A list of EnvironmentResourceDescription.
String applicationName
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
String versionLabel
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
com.amazonaws.internal.SdkInternalList<T> environmentIds
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
com.amazonaws.internal.SdkInternalList<T> environmentNames
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
Boolean includeDeleted
Indicates whether to include deleted environments:
true
: Environments that have been deleted after
IncludedDeletedBackTo
are displayed.
false
: Do not include deleted environments.
Date includedDeletedBackTo
If specified when IncludeDeleted
is set to true
, then environments deleted after this date are displayed.
com.amazonaws.internal.SdkInternalList<T> environments
Returns an EnvironmentDescription list.
String applicationName
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.
String versionLabel
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.
String templateName
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.
String environmentId
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
String environmentName
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
String requestId
If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.
String severity
If specified, limits the events returned from this call to include only those with the specified severity or higher.
Date startTime
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.
Date endTime
If specified, AWS Elastic Beanstalk restricts the returned descriptions
to those that occur up to, but not including, the EndTime
.
Integer maxRecords
Specifies the maximum number of events that can be returned, beginning with the most recent event.
String nextToken
Pagination token. If specified, the events return the next batch of results.
com.amazonaws.internal.SdkInternalList<T> events
A list of EventDescription.
String nextToken
If returned, this indicates that there are more results to obtain. Use this token in the next DescribeEvents call to get the next batch of events.
String environmentName
Specifies the AWS Elastic Beanstalk environment name.
String environmentId
Specifies the AWS Elastic Beanstalk environment ID.
com.amazonaws.internal.SdkInternalList<T> attributeNames
Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk returns all response elements.
String nextToken
Specifies the next token of the request.
com.amazonaws.internal.SdkInternalList<T> instanceHealthList
Contains the response body with information about the health of the instance.
Date refreshedAt
The date and time the information was last refreshed.
String nextToken
The next token.
String environmentName
The name of this environment.
String environmentId
The ID of this environment.
String applicationName
The name of the application associated with this environment.
String versionLabel
The application version deployed in this environment.
String solutionStackName
The name of the SolutionStack
deployed with this
environment.
String templateName
The name of the configuration template used to originally launch this environment.
String description
Describes this environment.
String endpointURL
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
String cNAME
The URL to the CNAME for this environment.
Date dateCreated
The creation date for this environment.
Date dateUpdated
The last modified date for this environment.
String status
The current operational status of the environment:
Launching
: Environment is in the process of initial
deployment.Updating
: Environment is in the process of updating its
configuration settings or application version.Ready
: Environment is available to have an action
performed on it, such as update or terminate.Terminating
: Environment is in the shut-down process.Terminated
: Environment is not running.Boolean abortableOperationInProgress
Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
true:
There is an update in progress.
false:
There are no updates currently in progress.
String health
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red
: Indicates the environment is not working.
Yellow
: Indicates that something is wrong, the application
might not be available, but the instances appear running.
Green
: Indicates the environment is healthy and fully
functional.
Red
: Indicates the environment is not responsive. Occurs
when three or more consecutive failures occur for an environment.Yellow
: Indicates that something is wrong. Occurs when
two consecutive failures occur for an environment.Green
: Indicates the environment is healthy and fully
functional.Grey
: Default health for a new environment. The
environment is not fully launched and health checks have not started or
health checks are suspended during an UpdateEnvironment
or
RestartEnvironement
request.
Default: Grey
String healthStatus
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
EnvironmentResourcesDescription resources
The description of the AWS resources used by this environment.
EnvironmentTier tier
Describes the current tier of this environment.
String environmentName
The name of the environment.
com.amazonaws.internal.SdkInternalList<T> autoScalingGroups
The AutoScalingGroups
used by this environment.
com.amazonaws.internal.SdkInternalList<T> instances
The Amazon EC2 instances used by this environment.
com.amazonaws.internal.SdkInternalList<T> launchConfigurations
The Auto Scaling launch configurations in use by this environment.
com.amazonaws.internal.SdkInternalList<T> loadBalancers
The LoadBalancers in use by this environment.
com.amazonaws.internal.SdkInternalList<T> triggers
The AutoScaling
triggers in use by this environment.
com.amazonaws.internal.SdkInternalList<T> queues
The queues used by this environment.
LoadBalancerDescription loadBalancer
Describes the LoadBalancer.
Date eventDate
The date when the event occurred.
String message
The event message.
String applicationName
The application associated with the event.
String versionLabel
The release label for the application version associated with this event.
String templateName
The name of the configuration associated with this event.
String environmentName
The name of the environment associated with this event.
String requestId
The web service request ID for the activity of this event.
String severity
The severity level of this event.
String id
The ID of the Amazon EC2 instance.
Integer noData
Grey. AWS Elastic Beanstalk and the health agent are reporting no data on an instance.
Integer unknown
Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient amount of data on an instance.
Integer pending
Grey. An operation is in progress on an instance within the command timeout.
Integer ok
Green. An instance is passing health checks and the health agent is not reporting any problems.
Integer info
Green. An operation is in progress on an instance.
Integer warning
Yellow. The health agent is reporting a moderate number of request failures or other issues for an instance or environment.
Integer degraded
Red. The health agent is reporting a high number of request failures or other issues for an instance or environment.
Integer severe
Red. The health agent is reporting a very high number of request failures or other issues for an instance or environment.
Double p999
The average latency for the slowest 0.1 percent of requests over the last 10 seconds.
Double p99
The average latency for the slowest 1 percent of requests over the last 10 seconds.
Double p95
The average latency for the slowest 5 percent of requests over the last 10 seconds.
Double p90
The average latency for the slowest 10 percent of requests over the last 10 seconds.
Double p85
The average latency for the slowest 15 percent of requests over the last 10 seconds.
Double p75
The average latency for the slowest 25 percent of requests over the last 10 seconds.
Double p50
The average latency for the slowest 50 percent of requests over the last 10 seconds.
Double p10
The average latency for the slowest 90 percent of requests over the last 10 seconds.
String name
The name of the launch configuration.
com.amazonaws.internal.SdkInternalList<T> solutionStacks
A list of available solution stacks.
com.amazonaws.internal.SdkInternalList<T> solutionStackDetails
A list of available solution stacks and their SolutionStackDescription.
String name
The name of the LoadBalancer.
String loadBalancerName
The name of the LoadBalancer.
String domain
The domain name of the LoadBalancer.
com.amazonaws.internal.SdkInternalList<T> listeners
A list of Listeners used by the LoadBalancer.
String environmentId
The ID of the environment to rebuild.
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
String environmentName
The name of the environment to rebuild.
Condition: You must specify either this or an EnvironmentId, or both. If
you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
String environmentId
The ID of the environment of the requested data.
If no such environment is found, RequestEnvironmentInfo
returns an InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
String environmentName
The name of the environment of the requested data.
If no such environment is found, RequestEnvironmentInfo
returns an InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentId, or both. If
you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
String infoType
The type of information to request.
String environmentId
The ID of the environment to restart the server for.
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
String environmentName
The name of the environment to restart the server for.
Condition: You must specify either this or an EnvironmentId, or both. If
you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
String environmentId
The ID of the data's environment.
If no such environment is found, returns an
InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
String environmentName
The name of the data's environment.
If no such environment is found, returns an
InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentId, or both. If
you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
String infoType
The type of information to retrieve.
com.amazonaws.internal.SdkInternalList<T> environmentInfo
The EnvironmentInfoDescription of the environment.
String instanceId
The ID of the Amazon EC2 instance.
String healthStatus
Returns the health status of the specified instance. For more information, see Health Colors and Statuses.
String color
Represents the color indicator that gives you information about the health of the EC2 instance. For more information, see Health Colors and Statuses.
com.amazonaws.internal.SdkInternalList<T> causes
Represents the causes, which provide more information about the current health status.
Date launchedAt
The time at which the EC2 instance was launched.
ApplicationMetrics applicationMetrics
SystemStatus system
String solutionStackName
The name of the solution stack.
com.amazonaws.internal.SdkInternalList<T> permittedFileTypes
The permitted file types allowed for a solution stack.
Integer status2xx
The percentage of requests over the last 10 seconds that resulted in a 2xx (200, 201, etc.) status code.
Integer status3xx
The percentage of requests over the last 10 seconds that resulted in a 3xx (300, 301, etc.) status code.
Integer status4xx
The percentage of requests over the last 10 seconds that resulted in a 4xx (400, 401, etc.) status code.
Integer status5xx
The percentage of requests over the last 10 seconds that resulted in a 5xx (500, 501, etc.) status code.
String sourceEnvironmentId
The ID of the source environment.
Condition: You must specify at least the SourceEnvironmentID
or the SourceEnvironmentName
. You may also specify both. If
you specify the SourceEnvironmentId
, you must specify the
DestinationEnvironmentId
.
String sourceEnvironmentName
The name of the source environment.
Condition: You must specify at least the SourceEnvironmentID
or the SourceEnvironmentName
. You may also specify both. If
you specify the SourceEnvironmentName
, you must specify the
DestinationEnvironmentName
.
String destinationEnvironmentId
The ID of the destination environment.
Condition: You must specify at least the
DestinationEnvironmentID
or the
DestinationEnvironmentName
. You may also specify both. You
must specify the SourceEnvironmentId
with the
DestinationEnvironmentId
.
String destinationEnvironmentName
The name of the destination environment.
Condition: You must specify at least the
DestinationEnvironmentID
or the
DestinationEnvironmentName
. You may also specify both. You
must specify the SourceEnvironmentName
with the
DestinationEnvironmentName
.
CPUUtilization cPUUtilization
com.amazonaws.internal.SdkInternalList<T> loadAverage
Load average in the last 1-minute and 5-minute periods. For more information, see Operating System Metrics.
String environmentId
The ID of the environment to terminate.
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
String environmentName
The name of the environment to terminate.
Condition: You must specify either this or an EnvironmentId, or both. If
you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
Boolean terminateResources
Indicates whether the associated AWS resources should shut down when the environment is terminated:
true
: (default) The user AWS resources (for example, the
Auto Scaling group, LoadBalancer, etc.) are terminated along with the
environment.
false
: The environment is removed from the AWS Elastic
Beanstalk but the AWS resources continue to operate.
true
: The specified environment as well as the
associated AWS resources, such as Auto Scaling group and LoadBalancer,
are terminated.false
: AWS Elastic Beanstalk resource management is
removed from the environment, but the AWS resources continue to operate.For more information, see the AWS Elastic Beanstalk User Guide.
Default: true
Valid Values: true
| false
String environmentName
The name of this environment.
String environmentId
The ID of this environment.
String applicationName
The name of the application associated with this environment.
String versionLabel
The application version deployed in this environment.
String solutionStackName
The name of the SolutionStack
deployed with this
environment.
String templateName
The name of the configuration template used to originally launch this environment.
String description
Describes this environment.
String endpointURL
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
String cNAME
The URL to the CNAME for this environment.
Date dateCreated
The creation date for this environment.
Date dateUpdated
The last modified date for this environment.
String status
The current operational status of the environment:
Launching
: Environment is in the process of initial
deployment.Updating
: Environment is in the process of updating its
configuration settings or application version.Ready
: Environment is available to have an action
performed on it, such as update or terminate.Terminating
: Environment is in the shut-down process.Terminated
: Environment is not running.Boolean abortableOperationInProgress
Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
true:
There is an update in progress.
false:
There are no updates currently in progress.
String health
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red
: Indicates the environment is not working.
Yellow
: Indicates that something is wrong, the application
might not be available, but the instances appear running.
Green
: Indicates the environment is healthy and fully
functional.
Red
: Indicates the environment is not responsive. Occurs
when three or more consecutive failures occur for an environment.Yellow
: Indicates that something is wrong. Occurs when
two consecutive failures occur for an environment.Green
: Indicates the environment is healthy and fully
functional.Grey
: Default health for a new environment. The
environment is not fully launched and health checks have not started or
health checks are suspended during an UpdateEnvironment
or
RestartEnvironement
request.
Default: Grey
String healthStatus
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
EnvironmentResourcesDescription resources
The description of the AWS resources used by this environment.
EnvironmentTier tier
Describes the current tier of this environment.
String name
The name of the trigger.
String applicationName
The name of the application to update. If no such application is found,
UpdateApplication
returns an
InvalidParameterValue
error.
String description
A new description for the application.
Default: If not specified, AWS Elastic Beanstalk does not update the description.
ApplicationDescription application
The ApplicationDescription of the application.
String applicationName
The name of the application associated with this version.
If no application is found with this name, UpdateApplication
returns an InvalidParameterValue
error.
String versionLabel
The name of the version to update.
If no application version is found with this label,
UpdateApplication
returns an
InvalidParameterValue
error.
String description
A new description for this release.
ApplicationVersionDescription applicationVersion
The ApplicationVersionDescription of the application version.
String applicationName
The name of the application associated with the configuration template to update.
If no application is found with this name,
UpdateConfigurationTemplate
returns an
InvalidParameterValue
error.
String templateName
The name of the configuration template to update.
If no configuration template is found with this name,
UpdateConfigurationTemplate
returns an
InvalidParameterValue
error.
String description
A new description for the configuration.
com.amazonaws.internal.SdkInternalList<T> optionSettings
A list of configuration option settings to update with the new specified option value.
com.amazonaws.internal.SdkInternalList<T> optionsToRemove
A list of configuration options to remove from the configuration set.
Constraint: You can remove only UserDefined
configuration
options.
String solutionStackName
The name of the solution stack this configuration set uses.
String applicationName
The name of the application associated with this configuration set.
String templateName
If not null
, the name of the configuration template for this
configuration set.
String description
Describes this configuration set.
String environmentName
If not null
, the name of the environment for this
configuration set.
String deploymentStatus
If this configuration set is associated with an environment, the
DeploymentStatus
parameter indicates the deployment status
of this configuration set:
null
: This configuration is not associated with a running
environment.
pending
: This is a draft configuration that is not deployed
to the associated environment but is in the process of deploying.
deployed
: This is the configuration that is currently
deployed to the associated running environment.
failed
: This is a draft configuration, that failed to
successfully deploy.
null
: This configuration is not associated with a
running environment.pending
: This is a draft configuration that is not
deployed to the associated environment but is in the process of
deploying.deployed
: This is the configuration that is currently
deployed to the associated running environment.failed
: This is a draft configuration that failed to
successfully deploy.Date dateCreated
The date (in UTC time) when this configuration set was created.
Date dateUpdated
The date (in UTC time) when this configuration set was last modified.
com.amazonaws.internal.SdkInternalList<T> optionSettings
A list of the configuration options and their values in this configuration set.
String environmentId
The ID of the environment to update.
If no environment with this ID exists, AWS Elastic Beanstalk returns an
InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
String environmentName
The name of the environment to update. If no environment with this name
exists, AWS Elastic Beanstalk returns an
InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentId, or both. If
you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
String description
If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
EnvironmentTier tier
This specifies the tier to use to update the environment.
Condition: At this time, if you change the tier version, name, or type,
AWS Elastic Beanstalk returns InvalidParameterValue
error.
String versionLabel
If this parameter is specified, AWS Elastic Beanstalk deploys the named
application version to the environment. If no such application version is
found, returns an InvalidParameterValue
error.
String templateName
If this parameter is specified, AWS Elastic Beanstalk deploys this
configuration template to the environment. If no such configuration
template is found, AWS Elastic Beanstalk returns an
InvalidParameterValue
error.
String solutionStackName
This specifies the platform version that the environment will run after the environment is updated.
com.amazonaws.internal.SdkInternalList<T> optionSettings
If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
com.amazonaws.internal.SdkInternalList<T> optionsToRemove
A list of custom user-defined configuration options to remove from the configuration set for this environment.
String environmentName
The name of this environment.
String environmentId
The ID of this environment.
String applicationName
The name of the application associated with this environment.
String versionLabel
The application version deployed in this environment.
String solutionStackName
The name of the SolutionStack
deployed with this
environment.
String templateName
The name of the configuration template used to originally launch this environment.
String description
Describes this environment.
String endpointURL
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
String cNAME
The URL to the CNAME for this environment.
Date dateCreated
The creation date for this environment.
Date dateUpdated
The last modified date for this environment.
String status
The current operational status of the environment:
Launching
: Environment is in the process of initial
deployment.Updating
: Environment is in the process of updating its
configuration settings or application version.Ready
: Environment is available to have an action
performed on it, such as update or terminate.Terminating
: Environment is in the shut-down process.Terminated
: Environment is not running.Boolean abortableOperationInProgress
Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
true:
There is an update in progress.
false:
There are no updates currently in progress.
String health
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red
: Indicates the environment is not working.
Yellow
: Indicates that something is wrong, the application
might not be available, but the instances appear running.
Green
: Indicates the environment is healthy and fully
functional.
Red
: Indicates the environment is not responsive. Occurs
when three or more consecutive failures occur for an environment.Yellow
: Indicates that something is wrong. Occurs when
two consecutive failures occur for an environment.Green
: Indicates the environment is healthy and fully
functional.Grey
: Default health for a new environment. The
environment is not fully launched and health checks have not started or
health checks are suspended during an UpdateEnvironment
or
RestartEnvironement
request.
Default: Grey
String healthStatus
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
EnvironmentResourcesDescription resources
The description of the AWS resources used by this environment.
EnvironmentTier tier
Describes the current tier of this environment.
String applicationName
The name of the application that the configuration template or environment belongs to.
String templateName
The name of the configuration template to validate the settings against.
Condition: You cannot specify both this and an environment name.
String environmentName
The name of the environment to validate the settings against.
Condition: You cannot specify both this and a configuration template name.
com.amazonaws.internal.SdkInternalList<T> optionSettings
A list of the options and desired values to evaluate.
com.amazonaws.internal.SdkInternalList<T> messages
A list of ValidationMessage.
String message
A message describing the error or warning.
String severity
An indication of the severity of this message:
error: This message indicates that this is not a valid setting for an option.
warning: This message is providing information you should take into account.
String namespace
String optionName
String errorCode
String creationToken
String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
String ownerId
The AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
String creationToken
Opaque string specified in the request.
String fileSystemId
The file system ID assigned by Amazon EFS.
Date creationTime
The time at which the file system was created, in seconds, since 1970-01-01T00:00:00Z.
String lifeCycleState
A predefined string value that indicates the lifecycle phase of the file system.
String name
You can add tags to a file system (see CreateTags) including a "Name" tag. If the file system has a "Name" tag, Amazon EFS returns the value in this field.
Integer numberOfMountTargets
The current number of mount targets (see CreateMountTarget) the file system has.
FileSystemSize sizeInBytes
This object provides the latest known metered size of data stored in the
file system, in bytes, in its Value
field, and the time at
which that size was determined in its Timestamp
field. The
Timestamp
value is the integer number of seconds since
1970-01-01T00:00:00Z. Note that the value does not represent the size of
a consistent snapshot of the file system, but it is eventually consistent
when there are no writes to the file system. That is, the value will
represent actual size only if the file system is not modified for a
period longer than a couple of hours. Otherwise, the value is not the
exact size the file system was at any instant in time.
String fileSystemId
The ID of the file system for which to create the mount target.
String subnetId
The ID of the subnet to add the mount target in.
String ipAddress
A valid IPv4 address within the address range of the specified subnet.
com.amazonaws.internal.SdkInternalList<T> securityGroups
Up to 5 VPC security group IDs, of the form "sg-xxxxxxxx". These must be for the same VPC as subnet specified.
String ownerId
The AWS account ID that owns the resource.
String mountTargetId
The system-assigned mount target ID.
String fileSystemId
The ID of the file system for which the mount target is intended.
String subnetId
The ID of the subnet that the mount target is in.
String lifeCycleState
The lifecycle state the mount target is in.
String ipAddress
The address at which the file system may be mounted via the mount target.
String networkInterfaceId
The ID of the network interface that Amazon EFS created when it created the mount target.
String fileSystemId
String. The ID of the file system whose tags you want to modify. This operation modifies only the tags and not the file system.
com.amazonaws.internal.SdkInternalList<T> tags
An array of Tag
objects to add. Each Tag
object
is a key-value pair.
String fileSystemId
The ID of the file system you want to delete.
String mountTargetId
String. The ID of the mount target to delete.
String fileSystemId
String. The ID of the file system whose tags you want to delete.
com.amazonaws.internal.SdkInternalList<T> tagKeys
A list of tag keys to delete.
String errorCode
Integer maxItems
Optional integer. Specifies the maximum number of file systems to return
in the response. This parameter value must be greater than 0. The number
of items Amazon EFS returns will be the minimum of the
MaxItems
parameter specified in the request and the
service's internal maximum number of items per page.
String marker
Optional string. Opaque pagination token returned from a previous
DescribeFileSystems
operation. If present, specifies to
continue the list from where the returning call had left off.
String creationToken
Optional string. Restricts the list to the file system with this creation token (you specify a creation token at the time of creating an Amazon EFS file system).
String fileSystemId
Optional string. File system ID whose description you want to retrieve.
String marker
A string, present if provided by caller in the request.
com.amazonaws.internal.SdkInternalList<T> fileSystems
An array of file system descriptions.
String nextMarker
A string, present if there are more file systems than returned in the
response. You can use the NextMarker
in the subsequent
request to fetch the descriptions.
String mountTargetId
The ID of the mount target whose security groups you want to retrieve.
com.amazonaws.internal.SdkInternalList<T> securityGroups
An array of security groups.
Integer maxItems
Optional. Maximum number of mount targets to return in the response. It must be an integer with a value greater than zero.
String marker
Optional. String. Opaque pagination token returned from a previous
DescribeMountTargets
operation. If present, it specifies to
continue the list from where the previous returning call left off.
String fileSystemId
Optional. String. The ID of the file system whose mount targets you want
to list. It must be included in your request if
MountTargetId
is not included.
String mountTargetId
Optional. String. The ID of the mount target that you want to have
described. It must be included in your request if
FileSystemId
is not included.
String marker
If the request included the Marker
, the response returns
that value in this field.
com.amazonaws.internal.SdkInternalList<T> mountTargets
Returns the file system's mount targets as an array of
MountTargetDescription
objects.
String nextMarker
If a value is present, there are more mount targets to return. In a
subsequent request, you can provide Marker
in your request
with this value to retrieve the next set of mount targets.
Integer maxItems
Optional. Maximum number of file system tags to return in the response. It must be an integer with a value greater than zero.
String marker
Optional. String. Opaque pagination token returned from a previous
DescribeTags
operation. If present, it specifies to continue
the list from where the previous call left off.
String fileSystemId
The ID of the file system whose tag set you want to retrieve.
String marker
If the request included a Marker
, the response returns that
value in this field.
com.amazonaws.internal.SdkInternalList<T> tags
Returns tags associated with the file system as an array of
Tag
objects.
String nextMarker
If a value is present, there are more tags to return. In a subsequent
request, you can provide the value of NextMarker
as the
value of the Marker
parameter in your next request to
retrieve the next set of tags.
String ownerId
The AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
String creationToken
Opaque string specified in the request.
String fileSystemId
The file system ID assigned by Amazon EFS.
Date creationTime
The time at which the file system was created, in seconds, since 1970-01-01T00:00:00Z.
String lifeCycleState
A predefined string value that indicates the lifecycle phase of the file system.
String name
You can add tags to a file system (see CreateTags) including a "Name" tag. If the file system has a "Name" tag, Amazon EFS returns the value in this field.
Integer numberOfMountTargets
The current number of mount targets (see CreateMountTarget) the file system has.
FileSystemSize sizeInBytes
This object provides the latest known metered size of data stored in the
file system, in bytes, in its Value
field, and the time at
which that size was determined in its Timestamp
field. The
Timestamp
value is the integer number of seconds since
1970-01-01T00:00:00Z. Note that the value does not represent the size of
a consistent snapshot of the file system, but it is eventually consistent
when there are no writes to the file system. That is, the value will
represent actual size only if the file system is not modified for a
period longer than a couple of hours. Otherwise, the value is not the
exact size the file system was at any instant in time.
String errorCode
String errorCode
String errorCode
String errorCode
String errorCode
String errorCode
String errorCode
String mountTargetId
The ID of the mount target whose security groups you want to modify.
com.amazonaws.internal.SdkInternalList<T> securityGroups
An array of up to five VPC security group IDs.
String errorCode
String ownerId
The AWS account ID that owns the resource.
String mountTargetId
The system-assigned mount target ID.
String fileSystemId
The ID of the file system for which the mount target is intended.
String subnetId
The ID of the subnet that the mount target is in.
String lifeCycleState
The lifecycle state the mount target is in.
String ipAddress
The address at which the file system may be mounted via the mount target.
String networkInterfaceId
The ID of the network interface that Amazon EFS created when it created the mount target.
String errorCode
String errorCode
String errorCode
String errorCode
String errorCode
String errorCode
String errorCode
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
String loadBalancerName
String policyName
String policyTypeName
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyAttributes
String loadBalancerName
This name must be unique within your AWS account, must have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and cannot begin or end with a hyphen.
com.amazonaws.internal.ListWithAutoConstructFlag<T> listeners
For more information, see Listener Configurations for Elastic Load Balancing in the Elastic Load Balancing Developer Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
You must specify at least one Availability Zone.
You can add more Availability Zones after you create the load balancer using EnableAvailabilityZonesForLoadBalancer.
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
AvailabilityZones
.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 in the Elastic Load Balancing Developer Guide.
Specify internal
to create an
internal load balancer with a DNS name that resolves to private IP
addresses.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
For more information about tagging your load balancer, see Tagging in the Elastic Load Balancing Developer Guide.
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 health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.
Integer interval
Constraints:
Range: 1 - 300
Integer timeout
This value must be less than the
Interval
value.
Constraints:
Range: 1 - 300
Integer unhealthyThreshold
Unhealthy
state.
Constraints:
Range: 2 - 10
Integer healthyThreshold
Healthy
state.
Constraints:
Range: 2 - 10
String instanceId
String instanceId
String state
Valid values:
InService
| OutOfService
|
Unknown
String reasonCode
OutOfService
instances.
Specifically, whether the cause is Elastic Load Balancing or the
instance. Valid values: ELB
| Instance
|
N/A
String description
N/A
A transient error occurred. Please try again
later.
Instance has failed at least the
UnhealthyThreshold number of health checks consecutively.
Instance has not passed the configured HealthyThreshold
number of health checks consecutively.
Instance registration is still in progress.
Instance is in the EC2 Availability Zone for which
LoadBalancer is not configured to route traffic to.
Instance is not currently registered with the
LoadBalancer.
Instance deregistration
currently in progress.
Disable Availability
Zone is currently in progress.
Instance is
in pending state.
Instance is in stopped
state.
Instance is in terminated
state.
String policyName
Long cookieExpirationPeriod
String protocol
Integer loadBalancerPort
String instanceProtocol
If the front-end protocol is HTTP, HTTPS, TCP,
or SSL, InstanceProtocol
must be at the same protocol.
If there is another listener with the same
InstancePort
whose InstanceProtocol
is
secure, (HTTPS or SSL), the listener's InstanceProtocol
must also be secure.
If there is another listener with the same
InstancePort
whose InstanceProtocol
is HTTP
or TCP, the listener's InstanceProtocol
must be HTTP or
TCP.
Integer instancePort
Constraints:
Range: 1 - 65535
String sSLCertificateId
Listener listener
For information about the protocols and the ports supported by Elastic Load Balancing, see Listener Configurations for Elastic Load Balancing in the Elastic Load Balancing Developer Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
CrossZoneLoadBalancing crossZoneLoadBalancing
For more information, see Enable Cross-Zone Load Balancing in the Elastic Load Balancing Developer Guide.
AccessLog accessLog
For more information, see Enable Access Logs in the Elastic Load Balancing Developer Guide.
ConnectionDraining connectionDraining
For more information, see Enable Connection Draining in the Elastic Load Balancing Developer Guide.
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. For more information, see Configure Idle Connection Timeout in the Elastic Load Balancing Developer Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> additionalAttributes
String loadBalancerName
String dNSName
String canonicalHostedZoneName
For more information, see Using Domain Names With Elastic Load Balancing in the Elastic Load Balancing Developer Guide.
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 Scheme
is internet-facing
, the load
balancer has a public DNS name that resolves to a public IP address.
If Scheme
is internal
, the load balancer
has a public DNS name that resolves to a private IP address.
String loadBalancerName
LoadBalancerAttributes loadBalancerAttributes
String loadBalancerName
LoadBalancerAttributes loadBalancerAttributes
com.amazonaws.internal.ListWithAutoConstructFlag<T> appCookieStickinessPolicies
com.amazonaws.internal.ListWithAutoConstructFlag<T> lBCookieStickinessPolicies
com.amazonaws.internal.ListWithAutoConstructFlag<T> otherPolicies
String attributeName
String attributeType
Boolean
or
Integer
.String description
String defaultValue
String cardinality
Valid values:
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 instancePort
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
String loadBalancerName
Integer loadBalancerPort
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
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
String releaseLabel
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
Integer normalizedInstanceHours
String masterPublicDnsName
com.amazonaws.internal.ListWithAutoConstructFlag<T> configurations
Amazon EMR releases 4.x or later.
The list of Configurations supplied to the EMR cluster.
String state
Constraints:
Allowed Values: STARTING, BOOTSTRAPPING, RUNNING, WAITING, TERMINATING, TERMINATED, TERMINATED_WITH_ERRORS
ClusterStateChangeReason stateChangeReason
ClusterTimeline timeline
String id
String name
ClusterStatus status
Integer normalizedInstanceHours
String name
String scriptPath
com.amazonaws.internal.ListWithAutoConstructFlag<T> args
String classification
com.amazonaws.internal.ListWithAutoConstructFlag<T> configurations
Map<K,V> properties
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
String emrManagedMasterSecurityGroup
String emrManagedSlaveSecurityGroup
com.amazonaws.internal.ListWithAutoConstructFlag<T> additionalMasterSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> additionalSlaveSecurityGroups
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> configurations
Amazon EMR releases 4.x or later.
The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> configurations
Amazon EMR releases 4.x or later.
The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
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 emrManagedMasterSecurityGroup
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String emrManagedSlaveSecurityGroup
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> additionalMasterSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> additionalSlaveSecurityGroups
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> stepIds
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
For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use ReleaseLabel.
The version of the Amazon Machine Image (AMI) to use when launching Amazon EC2 instances in the job flow. The following values are valid:
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]*
String releaseLabel
Amazon EMR releases 4.x or later.
The release label for the Amazon EMR release. For Amazon EMR 3.x and 2.x AMIs, use amiVersion instead instead of ReleaseLabel.
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
For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use Applications.
A list of strings that indicates third-party software to use with the job flow. For more information, go to Use Third Party Applications with Amazon EMR. Currently supported values are:
com.amazonaws.internal.ListWithAutoConstructFlag<T> newSupportedProducts
For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use Applications.
A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see Launch a Job Flow on the MapR Distribution for Hadoop. Currently supported values are:
com.amazonaws.internal.ListWithAutoConstructFlag<T> applications
Amazon EMR releases 4.x or later.
A list of applications for the cluster. Valid values are: "Hadoop", "Hive", "Mahout", "Pig", and "Spark." They are case insensitive.
com.amazonaws.internal.ListWithAutoConstructFlag<T> configurations
Amazon EMR releases 4.x or later.
The list of configurations supplied for the EMR cluster you are creating.
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
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]*
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$)
Encryption encryption
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 bit rates larger than 64 kbps.HE-AAC
: Not supported on some older players and
devices. Use for bit rates between 40 and 80 kbps.HE-AACv2
: Not supported on some players and devices.
Use for bit rates less than 48 kbps.All outputs in a
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.Smooth
playlist must have the same value for
Profile
.
Constraints:
Pattern: (^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)
String bitDepth
flac
or pcm
for the value of Audio:Codec.
The bit depth of a sample is how many bits of information are included in the audio samples. The higher the bit depth, the better the audio, but the larger the file.
Valid values are
16
and 24
.
The most common bit depth is
24
.
Constraints:
Pattern: (^16$)|(^24$)
String bitOrder
pcm
for the value of Audio:Codec. The order the bits of a PCM sample are stored in.
The supported value is
LittleEndian
.
Constraints:
Pattern: (^LittleEndian$)
String signed
pcm
for the value of Audio:Codec. Whether audio samples are represented with negative and positive numbers (signed) or only positive numbers (unsigned).
The supported value is
Signed
.
Constraints:
Pattern: (^Signed$)
String codec
aac
, flac
, mp2
,
mp3
, pcm
, and vorbis
.
Constraints:
Pattern: (^AAC$)|(^vorbis$)|(^mp3$)|(^mp2$)|(^pcm$)|(^flac$)
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$)|(^192000$)
String bitRate
Constraints:
Pattern: ^\d{1,3}$
String channels
auto
, 0
, 1
,
2
One channel carries the information played by a
single speaker. For example, a stereo track with two channels sends
one channel to the left speaker, and the other channel to the right
speaker. The output channels are organized into tracks. If you want
Elastic Transcoder to automatically detect the number of audio
channels in the input file and use that value for the output file,
select auto
.
The output of a specific channel value and inputs are as follows:
auto
channel
specified, with any input: Pass through up to eight input
channels.0
channels specified, with any
input: Audio omitted from the output.1
channel specified, with at least one input channel: Mono
sound.2
channels specified, with any
input: Two identical mono channels or stereo. For more information
about tracks, see Audio:AudioPackingMode.
For more information about how Elastic Transcoder organizes channels
and tracks, see Audio:AudioPackingMode
.
Constraints:
Pattern: (^auto$)|(^0$)|(^1$)|(^2$)
String audioPackingMode
Audio:Channels
to specify the number of channels in your
output, and Audio:AudioPackingMode
to specify the number
of tracks and their relation to the channels. If you do not specify an
Audio:AudioPackingMode
, Elastic Transcoder uses
SingleTrack
. The following values are valid:
SingleTrack
, OneChannelPerTrack
, and
OneChannelPerTrackWithMosTo8Tracks
When you specify
SingleTrack
, Elastic Transcoder creates a single track
for your output. The track can have up to eight channels. Use
SingleTrack
for all non-mxf
containers.
The outputs of SingleTrack
for a specific channel
value and inputs are as follows:
0
channels
with any input: Audio omitted from the output1, 2,
or auto
channels with no audio input: Audio omitted
from the output1
channel with any input
with audio: One track with one channel, downmixed if
necessary2
channels with one track with one
channel: One track with two identical channels2 or
auto
channels with two tracks with one channel each:
One track with two channels2 or auto
channels with one track with two channels: One track with two
channels2
channels with one track with
multiple channels: One track with two channelsauto
channels with one track with one channel: One track
with one channelauto
channels with one
track with multiple channels: One track with multiple
channelsWhen you specify
OneChannelPerTrack
, Elastic Transcoder creates a new
track for every channel in your output. Your output can have up to
eight single-channel tracks.
The outputs of
OneChannelPerTrack
for a specific channel value and
inputs are as follows:
0
channels with any
input: Audio omitted from the output1, 2, or auto
channels with no audio input: Audio omitted from the
output1
channel with any input with
audio: One track with one channel, downmixed if necessary2
channels with one track with one channel:
Two tracks with one identical channel each2 or auto
channels with two tracks with one channel each: Two
tracks with one channel each2 or auto
channels with one track with two channels: Two tracks with one
channel each2
channels with one track with
multiple channels: Two tracks with one channel eachauto
channels with one track with one
channel: One track with one channelauto
channels with one track with multiple channels: Up to eight
tracks with one channel eachWhen you specify
OneChannelPerTrackWithMosTo8Tracks
, Elastic Transcoder
creates eight single-channel tracks for your output. All tracks that
do not contain audio data from an input channel are MOS, or Mit Out
Sound, tracks.
The outputs of
OneChannelPerTrackWithMosTo8Tracks
for a specific channel
value and inputs are as follows:
0
channels
with any input: Audio omitted from the output1, 2,
or auto
channels with no audio input: Audio omitted
from the output1
channel with any input
with audio: One track with one channel, downmixed if necessary,
plus six MOS tracks2
channels with one
track with one channel: Two tracks with one identical channel
each, plus six MOS tracks2 or auto
channels
with two tracks with one channel each: Two tracks with one channel
each, plus six MOS tracks2 or auto
channels
with one track with two channels: Two tracks with one channel
each, plus six MOS tracks2
channels with
one track with multiple channels: Two tracks with one channel
each, plus six MOS tracksauto
channels with
one track with one channel: One track with one channel, plus seven
MOS tracksauto
channels with one track with
multiple channels: Up to eight tracks with one channel each, plus
MOS tracks until there are eight tracks in all
Constraints:
Pattern: (^SingleTrack$)|(^OneChannelPerTrack$)|(^OneChannelPerTrackWithMosTo8Tracks$)
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 FLAC: None
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. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
For FMP4: dfxp
Non-FMP4 outputs: All sidecar types
fmp4
captions have an
extension of .ismt
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\}.*$)
Encryption encryption
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 CaptionSources
is empty, Elastic
Transcoder omits all sidecar captions from the output files.
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
Encryption encryption
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\}.*$)
Encryption thumbnailEncryption
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 fmp4
(Fragmented MP4) or ts
(MPEG-TS),
SegmentDuration
is the target maximum duration of each
segment in seconds. For HLSv3
format playlists, each
media segment is stored in a separate .ts
file. For
HLSv4
and Smooth
playlists, all media
segments for an output are stored in a single file. Each segment is
approximately the length of the SegmentDuration
, though
individual segments might be shorter or longer. 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
HLS
output that you specify in OutputKeys. To add an
output to the master playlist for this job, include it in the
OutputKeys
of the associated playlist.
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.
Encryption encryption
String name
/
character, the section of the name before the last
/
must be identical for all Name
objects. If
you create more than one master playlist, the values of all
Name
objects must be unique. Note: Elastic
Transcoder automatically appends the relevant file extension to the
file name (.m3u8
for HLSv3
and
HLSv4
playlists, and .ism
and
.ismc
for Smooth
playlists). If you include
a file extension in Name
, the file name will have two
extensions.
Constraints:
Length: 1 - 255
String format
HLSv3
, HLSv4
, and Smooth
.
Constraints:
Pattern: (^HLSv3$)|(^HLSv4$)|(^Smooth$)
com.amazonaws.internal.ListWithAutoConstructFlag<T> outputKeys
Outputs:Key
object. If your output is not HLS
or does not have a segment
duration set, the name of the output file is a concatenation of
OutputKeyPrefix
and Outputs:Key
:
OutputKeyPrefixOutputs:Key
If your
output is HLSv3
and has a segment duration set, or is not
included in a playlist, Elastic Transcoder creates an output playlist
file with a file extension of .m3u8
, and a series of
.ts
files that include a five-digit sequential counter
beginning with 00000:
OutputKeyPrefixOutputs:Key
.m3u8
OutputKeyPrefixOutputs:Key
00000.ts
If
your output is HLSv4
, has a segment duration set, and is
included in an HLSv4
playlist, Elastic Transcoder creates
an output playlist file with a file extension of
_v4.m3u8
. If the output is video, Elastic Transcoder also
creates an output file with an extension of _iframe.m3u8
:
OutputKeyPrefixOutputs:Key
_v4.m3u8
OutputKeyPrefixOutputs:Key
_iframe.m3u8
OutputKeyPrefixOutputs:Key
.ts
Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.
If you include more than one output
in a playlist, any segment duration settings, clip settings, or
caption settings must be the same for all outputs in the playlist. For
Smooth
playlists, the Audio:Profile
,
Video:Profile
, and Video:FrameRate
to
Video:KeyframesMaxDist
ratio must be the same for all
outputs.
Constraints:
Length: 0 - 30
HlsContentProtection hlsContentProtection
PlayReadyDrm playReadyDrm
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 fmp4 (Fragmented MP4) or ts (MPEG-TS),
Playlists contains information about the master playlists that you
want Elastic Transcoder to create. The maximum number of master playlists in a job is 30.
Constraints:
Length: 0 - 30
Map<K,V> userMetadata
key/value
pairs,
and you can add up to 10 key/value
pairs per job. Elastic
Transcoder does not guarantee that key/value
pairs will
be returned in the same order in which you specify them.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/.+$
String awsKmsKeyArn
If you use either S3
or
S3-AWS-KMS
as your Encryption:Mode
, you
don't need to provide a key with your job because a default key, known
as an AWS-KMS key, is created for you automatically. You need to
provide an AWS-KMS key only if you want to use a non-default AWS-KMS
key, or if you are using an Encryption:Mode
of
AES-PKCS7
, AES-CTR
, or AES-GCM
.
Constraints:
Length: 0 - 255
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> warnings
Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.
String name
Constraints:
Length: 1 - 40
String description
Constraints:
Length: 0 - 255
String container
flac
, flv
, fmp4
,
gif
, mp3
, mp4
,
mpg
, mxf
, oga
,
ogg
, ts
, and webm
.
Constraints:
Pattern: (^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^flac$)|(^oga$)|(^ogg$)|(^fmp4$)|(^mpg$)|(^flv$)|(^gif$)|(^mxf$)
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}$
Integer width
Integer height
String frameRate
Constraints:
Pattern: ^\d{1,5}(\.\d{0,5})?$
Long fileSize
Long durationMillis
String mode
S3: Amazon S3 creates and manages the keys used for encrypting your files.
S3-AWS-KMS: Amazon S3 calls
the Amazon Key Management Service, which creates and manages the keys
that are used for encrypting your files. If you specify
S3-AWS-KMS
and you don't want to use the default key, you
must add the AWS-KMS key that you want to use to your pipeline.
AES-CBC-PKCS7: A padded cipher-block mode of operation originally used for HLS files.
AES-CTR: AES Counter Mode.
AES-GCM: AES Galois Counter Mode, a mode of operation that is an authenticated encryption format, meaning that a file, key, or initialization vector that has been tampered with will fail the decryption process.
For all three AES options, you must provide the following settings, which must be base64-encoded:
Key
Key MD5
Initialization Vector
For the AES modes, your private encryption keys and your unencrypted data are never stored by AWS; therefore, it is important that you safely manage your encryption keys. If you lose them, you won't be able to unencrypt your data.
Constraints:
Pattern: (^s3$)|(^s3-aws-kms$)|(^aes-cbc-pkcs7$)|(^aes-ctr$)|(^aes-gcm$)
String key
128
,
192
, or 256
.
The key must also be encrypted by using the Amazon Key Management Service.
Constraints:
Pattern: ^$|(^(?:[A-Za-z0-9\+/]{4})*(?:[A-Za-z0-9\+/]{2}==|[A-Za-z0-9\+/]{3}=)?$)
String keyMd5
Constraints:
Pattern: ^$|(^(?:[A-Za-z0-9\+/]{4})*(?:[A-Za-z0-9\+/]{2}==|[A-Za-z0-9\+/]{3}=)?$)
String initializationVector
Constraints:
Length: 0 - 255
String method
aes-128
. This value will be written into the
method attribute of the EXT-X-KEY
metadata tag in the
output playlist.
Constraints:
Pattern: (^aes-128$)
String key
If you choose to supply your own key, you must encrypt the key by using AWS KMS. The key must be base64-encoded, and it must be one of the following bit lengths before being base64-encoded:
128
, 192
, or 256
.
Constraints:
Pattern: ^$|(^(?:[A-Za-z0-9\+/]{4})*(?:[A-Za-z0-9\+/]{2}==|[A-Za-z0-9\+/]{3}=)?$)
String keyMd5
The MD5 digest of the key that you want Elastic Transcoder to use to encrypt your output file, and that you want Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes before being base64- encoded.
Constraints:
Pattern: ^$|(^(?:[A-Za-z0-9\+/]{4})*(?:[A-Za-z0-9\+/]{2}==|[A-Za-z0-9\+/]{3}=)?$)
String initializationVector
The series of random bits created by a random bit generator, unique for every encryption operation, that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes before being base64-encoded.
Constraints:
Length: 0 - 255
String licenseAcquisitionUrl
Constraints:
Length: 0 - 512
String keyStoragePolicy
WithVariantPlaylists
, LicenseAcquisitionUrl
must be left blank and Elastic Transcoder writes your data key into
the same bucket as the associated playlist.
Constraints:
Pattern: (^NoStore$)|(^WithVariantPlaylists$)
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 fmp4 (Fragmented MP4) or
ts (MPEG-TS), Playlists
contains information about the
master playlists that you want Elastic Transcoder to create. 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$)
Map<K,V> userMetadata
key/value
pairs,
and you can add up to 10 key/value
pairs per job. Elastic
Transcoder does not guarantee that key/value
pairs will
be returned in the same order in which you specify them. Metadata
keys
and values
must use characters from the
following list:
0-9
A-Z
and a-z
Space
The following symbols:
_.:/=+-%@
Timing timing
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$)
Encryption encryption
DetectedProperties detectedProperties
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\}.*$)
Encryption thumbnailEncryption
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 fmp4
(Fragmented MP4) or ts
(MPEG-TS),
SegmentDuration
is the target maximum duration of each
segment in seconds. For HLSv3
format playlists, each
media segment is stored in a separate .ts
file. For
HLSv4
and Smooth
playlists, all media
segments for an output are stored in a single file. Each segment is
approximately the length of the SegmentDuration
, though
individual segments might be shorter or longer. 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
HLS
output that you specify in OutputKeys. To add an
output to the master playlist for this job, include it in the
OutputKeys
of the associated playlist.
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
String frameRate
Constraints:
Pattern: ^\d{1,5}(\.\d{0,5})?$
Long fileSize
Long durationMillis
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.
Encryption encryption
String appliedColorSpaceConversion
ColorSpaceConversionMode
to transcode the output file,
the AppliedColorSpaceConversion
parameter shows the
conversion used. If no ColorSpaceConversionMode
was
defined in the preset, this parameter will not be included in the job
response.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$)
Encryption encryption
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/.+$
String awsKmsKeyArn
If you use either S3
or
S3-AWS-KMS
as your Encryption:Mode
, you
don't need to provide a key with your job because a default key, known
as an AWS-KMS key, is created for you automatically. You need to
provide an AWS-KMS key only if you want to use a non-default AWS-KMS
key, or if you are using an Encryption:Mode
of
AES-PKCS7
, AES-CTR
, or AES-GCM
.
Constraints:
Length: 0 - 255
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
/
character, the section of the name before the last
/
must be identical for all Name
objects. If
you create more than one master playlist, the values of all
Name
objects must be unique. Note: Elastic
Transcoder automatically appends the relevant file extension to the
file name (.m3u8
for HLSv3
and
HLSv4
playlists, and .ism
and
.ismc
for Smooth
playlists). If you include
a file extension in Name
, the file name will have two
extensions.
Constraints:
Length: 1 - 255
String format
HLSv3
, HLSv4
, and Smooth
.
Constraints:
Pattern: (^HLSv3$)|(^HLSv4$)|(^Smooth$)
com.amazonaws.internal.ListWithAutoConstructFlag<T> outputKeys
If your
output is not HLS
or does not have a segment duration
set, the name of the output file is a concatenation of
OutputKeyPrefix
and Outputs:Key
:
OutputKeyPrefixOutputs:Key
If your
output is HLSv3
and has a segment duration set, or is not
included in a playlist, Elastic Transcoder creates an output playlist
file with a file extension of .m3u8
, and a series of
.ts
files that include a five-digit sequential counter
beginning with 00000:
OutputKeyPrefixOutputs:Key
.m3u8
OutputKeyPrefixOutputs:Key
00000.ts
If
your output is HLSv4
, has a segment duration set, and is
included in an HLSv4
playlist, Elastic Transcoder creates
an output playlist file with a file extension of
_v4.m3u8
. If the output is video, Elastic Transcoder also
creates an output file with an extension of _iframe.m3u8
:
OutputKeyPrefixOutputs:Key
_v4.m3u8
OutputKeyPrefixOutputs:Key
_iframe.m3u8
OutputKeyPrefixOutputs:Key
.ts
Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.
If you include more than one output
in a playlist, any segment duration settings, clip settings, or
caption settings must be the same for all outputs in the playlist. For
Smooth
playlists, the Audio:Profile
,
Video:Profile
, and Video:FrameRate
to
Video:KeyframesMaxDist
ratio must be the same for all
outputs.
Constraints:
Length: 0 - 30
HlsContentProtection hlsContentProtection
PlayReadyDrm playReadyDrm
String status
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
String statusDetail
Constraints:
Length: 0 - 255
String format
Constraints:
Pattern: (^microsoft$)|(^discretix-3.0$)
String key
128
,
192
, or 256
.
The key must also be encrypted by using AWS KMS.
Constraints:
Pattern: (^(?:[A-Za-z0-9\+/]{4})*(?:[A-Za-z0-9\+/]{2}==|[A-Za-z0-9\+/]{3}=)?$)
String keyMd5
Constraints:
Pattern: (^(?:[A-Za-z0-9\+/]{4})*(?:[A-Za-z0-9\+/]{2}==|[A-Za-z0-9\+/]{3}=)?$)
String keyId
The key ID must be provided in big endian, and Elastic Transcoder will convert it to little endian before inserting it into the PlayReady DRM headers. If you are unsure whether your license server provides your key ID in big or little endian, check with your DRM provider.
Constraints:
Pattern: (^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)|(^[0-9A-Fa-f]{32}$)
String initializationVector
Constraints:
Length: 0 - 255
String licenseAcquisitionUrl
Constraints:
Length: 1 - 512
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
String arn
String name
Constraints:
Length: 1 - 40
String description
Constraints:
Length: 0 - 255
String container
flac
, flv
, fmp4
,
gif
, mp3
, mp4
,
mpg
, mxf
, oga
,
ogg
, ts
, and webm
.
Constraints:
Pattern: (^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^flac$)|(^oga$)|(^ogg$)|(^fmp4$)|(^mpg$)|(^flv$)|(^gif$)|(^mxf$)
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> warnings
Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.
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})?$)
Long submitTimeMillis
Long startTimeMillis
Long finishTimeMillis
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/.+$
String awsKmsKeyArn
If you use either S3
or
S3-AWS-KMS
as your Encryption:Mode
, you
don't need to provide a key with your job because a default key, known
as an AWS-KMS key, is created for you automatically. You need to
provide an AWS-KMS key only if you want to use a non-default AWS-KMS
key, or if you are using an Encryption:Mode
of
AES-PKCS7
, AES-CTR
, or AES-GCM
.
Constraints:
Length: 0 - 255
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> warnings
Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.
Pipeline pipeline
String codec
gif
, H.264
, mpeg2
, and
vp8
. You can only specify vp8
when the
container type is webm
, gif
when the
container type is gif
, and mpeg2
when the
container type is mpg
.
Constraints:
Pattern: (^H\.264$)|(^vp8$)|(^mpeg2$)|(^gif$)
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 (Optional, H.264/MPEG2/VP8 only)
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 (Optional, H.264/MPEG2/VP8 only)
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
FMP4 or 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
.
InterlacedMode (Optional, H.264/MPEG2 Only)
The interlace mode for the output video.
Interlaced video is used to double the perceived frame rate for a video by interlacing two fields (one field on every other line, the other field on the other lines) so that the human eye registers multiple pictures per frame. Interlacing reduces the bandwidth required for transmitting a video, but can result in blurred images and flickering.
Valid
values include Progressive
(no interlacing, top to
bottom), TopFirst
(top field first),
BottomFirst
(bottom field first), and Auto
.
If InterlaceMode
is not specified, Elastic Transcoder
uses Progressive
for the output. If Auto
is
specified, Elastic Transcoder interlaces the output.
ColorSpaceConversionMode (Optional, H.264/MPEG2 Only)
The
color space conversion Elastic Transcoder applies to the output video.
Color spaces are the algorithms used by the computer to store
information about how to render color. Bt.601
is the
standard for standard definition video, while Bt.709
is
the standard for high definition video.
Valid values include
None
, Bt709toBt601
,
Bt601toBt709
, and Auto
.
If you chose
Auto
for ColorSpaceConversionMode
and your
output is interlaced, your frame rate is one of 23.97
,
24
, 25
, 29.97
, 50
,
or 60
, your SegmentDuration
is null, and you
are using one of the resolution changes from the list below, Elastic
Transcoder applies the following color space conversions:
Bt601ToBt709
Bt601ToBt709
Bt709ToBt601
Bt709ToBt601
ColorspaceConversionMode
Auto
mode in the future. All outputs in a playlist must
use the same ColorSpaceConversionMode
.If you
do not specify a ColorSpaceConversionMode
, Elastic
Transcoder does not change the color space of a file. If you are
unsure what ColorSpaceConversionMode
was applied to your
output file, you can check the
AppliedColorSpaceConversion
parameter included in your
job response. If your job does not have an
AppliedColorSpaceConversion
in its response, no
ColorSpaceConversionMode
was applied.
ChromaSubsampling
The sampling pattern for the chroma
(color) channels of the output video. Valid values include
yuv420p
and yuv422p
.
yuv420p
samples the chroma information of every other horizontal and every
other vertical line, yuv422p
samples the color
information of every horizontal line and every other vertical line.
LoopCount (Gif Only)
The number of times you want the
output gif to loop. Valid values include Infinite
and
integers between 0
and 100
, inclusive.
Constraints:
Length: 0 - 30
String keyframesMaxDist
H.264
, MPEG2
, or VP8
. The maximum number of frames between key frames. Key frames are fully encoded frames; the frames between key frames are encoded based, in part, on the content of the key frames. The value is an integer formatted as a string; valid values are between 1 (every frame is a key frame) and 100000, inclusive. A higher value results in higher compression but may also discernibly decrease video quality.
For
Smooth
outputs, the FrameRate
must have a
constant ratio to the KeyframesMaxDist
. This allows
Smooth
playlists to switch between different quality
levels while the file is being played.
For example, an input file
can have a FrameRate
of 30 with a
KeyframesMaxDist
of 90. The output file then needs to
have a ratio of 1:3. Valid outputs would have FrameRate
of 30, 25, and 10, and KeyframesMaxDist
of 90, 75, and
30, respectively.
Alternately, this can be achieved by setting
FrameRate
to auto and having the same values for
MaxFrameRate
and KeyframesMaxDist
.
Constraints:
Pattern: ^\d{1,6}$
String fixedGOP
H.264
, MPEG2
, or VP8
.
Whether to use a fixed value for FixedGOP
. Valid
values are true
and false
:
true
: Elastic Transcoder uses the value of
KeyframesMaxDist
for the distance between key frames (the
number of frames in a group of pictures, or GOP).false
: The distance between key frames can vary.FixedGOP
must be set to
true
for fmp4
containers.
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
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String uploadId
String accountId
AccountId
value is the AWS account ID. This value
must match the AWS account ID associated with the credentials used to
sign the request. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), 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
any hyphens ('-') in the ID.String vaultName
String accountId
AccountId
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
Map<K,V> tags
String accountId
AccountId
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String uploadId
String archiveSize
String checksum
String accountId
AccountId
value is the AWS account ID. This value
must match the AWS account ID associated with the credentials used to
sign the request. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), 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
any hyphens ('-') in the ID.String vaultName
String lockId
lockId
value is the lock ID obtained from a
InitiateVaultLock request.String accountId
AccountId
value is the AWS account ID. This value
must match the AWS account ID associated with the credentials used to
sign the request. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), 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
any hyphens ('-') in the ID.String vaultName
String location
com.amazonaws.internal.ListWithAutoConstructFlag<T> rules
String strategy
Valid values: BytesPerHour|FreeTier|None
Long bytesPerHour
This
field is required only if the value of the Strategy field is
BytesPerHour
. Your PUT operation will be rejected if the
Strategy field is not set to BytesPerHour
and you set
this field.
String accountId
AccountId
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String archiveId
String accountId
AccountId
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String accountId
AccountId
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String accountId
AccountId
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String accountId
AccountId
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.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
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.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
value is the AWS account ID. This value
must match the AWS account ID associated with the credentials used to
sign the request. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), 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
any hyphens ('-') in the ID.DataRetrievalPolicy policy
String accountId
AccountId
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String jobId
String range
InputStream body
String checksum
Integer status
String contentRange
String acceptRanges
String contentType
String archiveDescription
String accountId
AccountId
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
VaultAccessPolicy policy
String accountId
AccountId
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String policy
String state
InProgress
or
Locked
.String expirationDate
null
if the vault lock is in a Locked
state.String creationDate
InProgress
state.String accountId
AccountId
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.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
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
JobParameters jobParameters
String accountId
AccountId
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.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 accountId
AccountId
value is the AWS account ID. This value
must match the AWS account ID associated with the credentials used to
sign the request. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), 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
any hyphens ('-') in the ID.String vaultName
VaultLockPolicy policy
String lockId
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
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.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
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String uploadIdMarker
String limit
com.amazonaws.internal.ListWithAutoConstructFlag<T> uploadsList
String marker
null
.String accountId
AccountId
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.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
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String accountId
AccountId
value is the AWS account ID. This value
must match the AWS account ID associated with the credentials used to
sign the request. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), 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
any hyphens ('-') in the ID.String marker
String limit
com.amazonaws.internal.ListWithAutoConstructFlag<T> vaultList
String marker
String accountId
AccountId
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
String accountId
AccountId
value is the AWS account ID. This value
must match the AWS account ID associated with the credentials used to
sign the request. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), 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
any hyphens ('-') in the ID.DataRetrievalPolicy policy
String accountId
AccountId
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
VaultAccessPolicy policy
String accountId
AccountId
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
VaultNotificationConfig vaultNotificationConfig
Long contentLength
String vaultName
String accountId
AccountId
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String archiveDescription
String checksum
InputStream body
String multipartUploadId
String vaultARN
String archiveDescription
Long partSizeInBytes
String creationDate
String accountId
AccountId
value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-
' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String uploadId
String checksum
String range
InputStream body
String checksum
String policy
String policy
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
Date lastUsedDate
The user does not have an access key.
An access key exists but has never been used, at least not since IAM started tracking this information on April 22nd, 2015.
There is no sign-in data associated with the user
String serviceName
The user does not have an access key.
An access key exists but has never been used, at least not since IAM started tracking this information on April 22nd, 2015.
There is no sign-in data associated with the user
String region
The user does not have an access key.
An access key exists but has never been used, at least not since IAM started tracking this information on April 22nd, 2015.
There is no sign-in data associated with the user
For more information about AWS regions, see Regions and Endpoints in the Amazon Web Services General Reference.
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; Inactive
means it is not.
Constraints:
Allowed Values: Active, Inactive
Date createDate
String openIDConnectProviderArn
Constraints:
Length: 20 - 2048
String clientID
Constraints:
Length: 1 - 255
String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
String policyArn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
String policyArn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]+
String policyArn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]+
String policyArn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
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 contextKeyName
aws:SourceIp
or
s3:VersionId
.
Constraints:
Length: 5 - 256
com.amazonaws.internal.ListWithAutoConstructFlag<T> contextKeyValues
Condition
element in an input policy.String contextKeyType
ContextKeyValues
parameter.
Constraints:
Allowed Values: string, stringList, numeric, numericList, boolean, booleanList, ip, ipList, binary, binaryList, date, dateList
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 url
iss
claim in the provider's
OpenID Connect ID tokens. Per the OIDC standard, path components are
allowed but query parameters are not. Typically the URL consists of
only a host name, like "https://server.example.org" or
"https://example.com". You cannot register the same provider multiple times in a single AWS account. If you try to submit a URL that has already been used for an OpenID Connect provider in the AWS account, you will get an error.
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> clientIDList
client_id
parameter on OAuth requests.) You can register multiple client IDs with the same provider. For example, you might have multiple applications that use the same OIDC provider. You cannot register more than 100 client IDs with a single IAM OIDC provider.
There is no defined format for a client ID. The
CreateOpenIDConnectProviderRequest
action accepts client
IDs up to 255 characters long.
com.amazonaws.internal.ListWithAutoConstructFlag<T> thumbprintList
The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.
You must provide at least one thumbprint when creating an IAM OIDC
provider. For example, if the OIDC provider is
server.example.com
and the provider stores its keys at
"https://keys.server.example.com/openid-connect", the thumbprint
string would be the hex-encoded SHA-1 hash value of the certificate
used by https://keys.server.example.com.
For more information about obtaining the OIDC provider's thumbprint, see Obtaining the Thumbprint for an OpenID Connect Provider in the IAM User Guide.
String openIDConnectProviderArn
Constraints:
Length: 20 - 2048
String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
String path
For more information about paths, see IAM Identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
Constraints:
Pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/
String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
String description
Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."
The policy description is immutable. After a value is assigned, it cannot be changed.
Constraints:
Length: 0 - 1000
Policy policy
String policyArn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
Boolean setAsDefault
When this parameter is true
, the new policy version
becomes the operative version; that is, the version that is in effect
for the IAM users, groups, and roles that the policy is attached to.
For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
PolicyVersion policyVersion
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 About SAML 2.0-based Federation in the IAM User 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 openIDConnectProviderArn
Constraints:
Length: 20 - 2048
String policyArn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
String policyArn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
String versionId
For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
Constraints:
Pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)?
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 groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
String policyArn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]+
String policyArn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]+
String policyArn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
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 evalActionName
Constraints:
Length: 3 - 128
String evalResourceName
Constraints:
Length: 1 - 2048
String evalDecision
Constraints:
Allowed Values: allowed, explicitDeny, implicitDeny
com.amazonaws.internal.ListWithAutoConstructFlag<T> matchedStatements
com.amazonaws.internal.ListWithAutoConstructFlag<T> missingContextValues
If the response includes any keys in this list, then the reported results might be untrustworthy because the simulation could not completely evaluate all of the conditions specified in the policies that would occur in a real world request.
String accessKeyId
Constraints:
Length: 16 - 32
Pattern: [\w]+
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
AccessKeyLastUsed accessKeyLastUsed
com.amazonaws.internal.ListWithAutoConstructFlag<T> filter
Integer maxItems
IsTruncated
response
element is true
. This parameter is optional. If you do
not include it, it defaults to 100. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
String marker
Marker
element in the response you
received to inform the next call about where to start.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> userDetailList
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupDetailList
com.amazonaws.internal.ListWithAutoConstructFlag<T> roleDetailList
com.amazonaws.internal.ListWithAutoConstructFlag<T> policies
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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]+
PasswordPolicy passwordPolicy
This data type is used as a response element in the GetAccountPasswordPolicy action.
Map<K,V> summaryMap
SummaryMap
contains the following
keys:
AccessKeysPerUserQuota
The maximum number of active access keys allowed for each IAM user.
AccountAccessKeysPresent
This value is 1 if the AWS account (root) has an access key, otherwise it is 0.
AccountMFAEnabled
This value is 1 if the AWS account (root) has an MFA device assigned, otherwise it is 0.
AccountSigningCertificatesPresent
This value is 1 if the AWS account (root) has a signing certificate, otherwise it is 0.
AssumeRolePolicySizeQuota
The maximum allowed size for assume role policy documents (trust policies), in non-whitespace characters.
AttachedPoliciesPerGroupQuota
The maximum number of managed policies that can be attached to an IAM group.
AttachedPoliciesPerRoleQuota
The maximum number of managed policies that can be attached to an IAM role.
AttachedPoliciesPerUserQuota
The maximum number of managed policies that can be attached to an IAM user.
GroupPolicySizeQuota
The maximum allowed size for the aggregate of all inline policies embedded in an IAM group, in non-whitespace characters.
Groups
The number of IAM groups in the AWS account.
GroupsPerUserQuota
The maximum number of IAM groups each IAM user can belong to.
GroupsQuota
The maximum number of IAM groups allowed in the AWS account.
InstanceProfiles
The number of instance profiles in the AWS account.
InstanceProfilesQuota
The maximum number of instance profiles allowed in the AWS account.
MFADevices
The number of MFA devices in the AWS account, including those assigned and unassigned.
MFADevicesInUse
The number of MFA devices that have been assigned to an IAM user or to the AWS account (root).
Policies
The number of customer managed policies in the AWS account.
PoliciesQuota
The maximum number of customer managed policies allowed in the AWS account.
PolicySizeQuota
The maximum allowed size of a customer managed policy, in non-whitespace characters.
PolicyVersionsInUse
The number of managed policies that are attached to IAM users, groups, or roles in the AWS account.
PolicyVersionsInUseQuota
The maximum number of managed policies that can be attached to IAM users, groups, or roles in the AWS account.
Providers
The number of identity providers in the AWS account.
RolePolicySizeQuota
The maximum allowed size for the aggregate of all inline policies (access policies, not the trust policy) embedded in an IAM role, in non-whitespace characters.
Roles
The number of IAM roles in the AWS account.
RolesQuota
The maximum number of IAM roles allowed in the AWS account.
ServerCertificates
The number of server certificates in the AWS account.
ServerCertificatesQuota
The maximum number of server certificates allowed in the AWS account.
SigningCertificatesPerUserQuota
The maximum number of X.509 signing certificates allowed for each IAM user.
UserPolicySizeQuota
The maximum allowed size for the aggregate of all inline policies embedded in an IAM user, in non-whitespace characters.
Users
The number of IAM users in the AWS account.
UsersQuota
The maximum number of IAM users allowed in the AWS account.
VersionsPerPolicyQuota
The maximum number of policy versions allowed for each managed policy.
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyInputList
Condition
elements.com.amazonaws.internal.ListWithAutoConstructFlag<T> contextKeyNames
Condition
elements of the input policies.String policySourceArn
Constraints:
Length: 20 - 2048
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyInputList
Condition
elements.com.amazonaws.internal.ListWithAutoConstructFlag<T> contextKeyNames
Condition
elements of the input policies.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
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
Group group
com.amazonaws.internal.ListWithAutoConstructFlag<T> users
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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 instanceProfileName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
InstanceProfile instanceProfile
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]+
LoginProfile loginProfile
String openIDConnectProviderArn
Constraints:
Length: 20 - 2048
String url
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> clientIDList
com.amazonaws.internal.ListWithAutoConstructFlag<T> thumbprintList
Date createDate
String policyArn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
Policy policy
String policyArn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
String versionId
Constraints:
Pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)?
PolicyVersion policyVersion
For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
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 - 64
Pattern: [\w+=,.@-]+
String sSHPublicKeyId
Constraints:
Length: 20 - 128
Pattern: [\w]+
String encoding
SSH
. To
retrieve the public key in PEM format, use PEM
.
Constraints:
Allowed Values: SSH, PEM
SSHPublicKey sSHPublicKey
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 groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
String groupId
Constraints:
Length: 16 - 32
Pattern: [\w]+
String arn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
Date createDate
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupPolicyList
com.amazonaws.internal.ListWithAutoConstructFlag<T> attachedManagedPolicies
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
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> accessKeyMetadata
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> accountAliases
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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 groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
String pathPrefix
Constraints:
Pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/
String marker
Marker
element in the response you
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> attachedPolicies
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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 pathPrefix
Constraints:
Pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/
String marker
Marker
element in the response you
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> attachedPolicies
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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+=,.@-]+
String pathPrefix
Constraints:
Pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/
String marker
Marker
element in the response you
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> attachedPolicies
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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 policyArn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
String entityFilter
For example, when
EntityFilter
is Role
, only the roles that
are attached to the specified policy are returned. This parameter is
optional. If it is not included, all attached entities (users, groups,
and roles) are returned.
Constraints:
Allowed Values: User, Role, Group, LocalManagedPolicy, AWSManagedPolicy
String pathPrefix
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
String marker
Marker
element in the response you
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyUsers
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyRoles
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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 groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
String marker
Marker
element in the response you
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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/
gets 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
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceProfiles
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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/
gets 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
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceProfiles
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> mFADevices
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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> openIDConnectProviderList
String scope
To list only AWS
managed policies, set Scope
to AWS
. To list
only the customer managed policies in your AWS account, set
Scope
to Local
.
This parameter is
optional. If it is not included, or if it is set to All
,
all policies are returned.
Constraints:
Allowed Values: All, AWS, Local
Boolean onlyAttached
When
OnlyAttached
is true
, the returned list
contains only the policies that are attached to a user, group, or
role. When OnlyAttached
is false
, or when
the parameter is not included, all policies are returned.
String pathPrefix
Constraints:
Pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/
String marker
Marker
element in the response you
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> policies
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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 policyArn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
String marker
Marker
element in the response you
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> versions
For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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/
gets 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
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> roles
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> serverCertificateMetadataList
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> certificates
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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+=,.@-]+
String marker
Marker
element in the response you
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> sSHPublicKeys
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> users
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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
received to inform the next call about where to start.
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. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> virtualMFADevices
AssignmentStatus
value that was passed in the request.Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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 policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
String policyId
For more information about IDs, see IAM Identifiers in the Using IAM guide.
Constraints:
Length: 16 - 32
Pattern: [\w]+
String arn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
String path
For more information about paths, see IAM Identifiers in the Using IAM guide.
Constraints:
Pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/
String defaultVersionId
For more information about policy versions, see Versioning for Managed Policies in the Using IAM guide.
Constraints:
Pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)?
Integer attachmentCount
Boolean isAttachable
String description
Constraints:
Length: 0 - 1000
Date createDate
Date updateDate
When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyVersionList
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]+
String serialNumber
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]+
Date enableDate
String arn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
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 policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
String policyId
For more information about IDs, see IAM Identifiers in the Using IAM guide.
Constraints:
Length: 16 - 32
Pattern: [\w]+
String arn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
String path
For more information about paths, see IAM Identifiers in the Using IAM guide.
Constraints:
Pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/
String defaultVersionId
Constraints:
Pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)?
Integer attachmentCount
Boolean isAttachable
String description
This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.
Constraints:
Length: 0 - 1000
Date createDate
Date updateDate
When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.
String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+
String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]+
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]+
String document
The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations.
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
String versionId
Policy version identifiers
always begin with v
(always lowercase). When a policy is
created, the first policy version is v1
.
Constraints:
Pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)?
Boolean isDefaultVersion
Date createDate
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 openIDConnectProviderArn
Constraints:
Length: 20 - 2048
String clientID
Constraints:
Length: 1 - 255
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
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
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
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
Date createDate
String assumeRolePolicyDocument
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceProfileList
com.amazonaws.internal.ListWithAutoConstructFlag<T> rolePolicyList
com.amazonaws.internal.ListWithAutoConstructFlag<T> attachedManagedPolicies
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 policyArn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
String versionId
For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
Constraints:
Pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)?
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyInputList
com.amazonaws.internal.ListWithAutoConstructFlag<T> actionNames
iam:CreateUser
.com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceArns
*
(all resources). Each API in the ActionNames
parameter is
evaluated for each resource in this list. The simulation determines
the access result (allowed or denied) of each combination and reports
it in the response.com.amazonaws.internal.ListWithAutoConstructFlag<T> contextEntries
Condition
element in one of the simulated IAM permission
policies, the corresponding value is supplied.Integer maxItems
IsTruncated
response
element is true
. This parameter is optional. If you do
not include it, it defaults to 100. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
String marker
Marker
element in the response you
received to inform the next call about where to start.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> evaluationResults
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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 policySourceArn
Constraints:
Length: 20 - 2048
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyInputList
com.amazonaws.internal.ListWithAutoConstructFlag<T> actionNames
iam:CreateUser
.com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceArns
*
(all resources). Each API in the ActionNames
parameter is
evaluated for each resource in this list. The simulation determines
the access result (allowed or denied) of each combination and reports
it in the response.com.amazonaws.internal.ListWithAutoConstructFlag<T> contextEntries
Condition
element in one of the simulated IAM permission
policies, the corresponding value is supplied.Integer maxItems
IsTruncated
response
element is true
. This parameter is optional. If you do
not include it, it defaults to 100. Note that IAM might return fewer
results, even when there are more results available. If this is the
case, the IsTruncated
response element returns
true
and Marker
contains a value to include
in the subsequent call that tells the service where to continue from.
Constraints:
Range: 1 - 1000
String marker
Marker
element in the response you
received to inform the next call about where to start.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> evaluationResults
Boolean isTruncated
Marker
request parameter to retrieve more
items. Note that IAM might return fewer than the MaxItems
number of results even when there are more results available. We
recommend that you check IsTruncated
after every call to
ensure that you receive all of your results.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+=,.@-]+
String sSHPublicKeyId
Constraints:
Length: 20 - 128
Pattern: [\w]+
String fingerprint
Constraints:
Length: 48 - 48
Pattern: [:\w]+
String sSHPublicKeyBody
Constraints:
Length: 1 - 16384
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
String status
Active
means the key
can be used for authentication with an AWS CodeCommit repository.
Inactive
means the key cannot be used.
Constraints:
Allowed Values: Active, Inactive
Date uploadDate
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]+
String sSHPublicKeyId
Constraints:
Length: 20 - 128
Pattern: [\w]+
String status
Active
means the key
can be used for authentication with an AWS CodeCommit repository.
Inactive
means the key cannot be used.
Constraints:
Allowed Values: Active, Inactive
Date uploadDate
String sourcePolicyId
String sourcePolicyType
Constraints:
Allowed Values: user, group, role, aws-managed, user-managed, none
Position startPosition
Statement
in
an IAM policy.Position endPosition
Statement
in an IAM
policy.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
! @ # $ % ^ & * ( ) _ + - = [ ] { } | '
Default value: false
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 openIDConnectProviderArn
Constraints:
Length: 20 - 2048
com.amazonaws.internal.ListWithAutoConstructFlag<T> thumbprintList
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 - 64
Pattern: [\w+=,.@-]+
String sSHPublicKeyId
Constraints:
Length: 20 - 128
Pattern: [\w]+
String status
Active
means
the key can be used for authentication with an AWS CodeCommit
repository. Inactive
means the key 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 userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]+
String sSHPublicKeyBody
Constraints:
Length: 1 - 16384
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
SSHPublicKey sSHPublicKey
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
Date passwordLastUsed
The user does not have a password
The password exists but has never been used (at least not since IAM started tracking this information on October 20th, 2014
there is no sign-in data associated with the user
This value is returned only in the GetUser and ListUsers actions.
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
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
Date createDate
com.amazonaws.internal.ListWithAutoConstructFlag<T> userPolicyList
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupList
com.amazonaws.internal.ListWithAutoConstructFlag<T> attachedManagedPolicies
String serialNumber
VirtualMFADevice
.
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]+
ByteBuffer base32StringSeed
Base32StringSeed
is Base64-encoded.ByteBuffer qRCodePNG
otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String
where $virtualMFADeviceName
is one of the create call
arguments, AccountName
is the user name if set
(otherwise, the account ID otherwise), and Base32String
is the seed in Base32 format. The Base32String
value is
Base64-encoded.User user
This data type is used as a response element in the following actions:
Date enableDate
Boolean success
com.amazonaws.internal.SdkInternalList<T> jobIds
String name
String company
String phoneNumber
String country
String stateOrProvince
String city
String postalCode
String street1
String street2
String street3
String aPIVersion
String jobId
String jobType
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
com.amazonaws.internal.SdkInternalList<T> artifactList
com.amazonaws.internal.SdkInternalList<T> jobs
Boolean isTruncated
Boolean success
String warningMessage
com.amazonaws.internal.SdkInternalList<T> artifactList
String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
Integer shardCount
DefaultShardLimit;
Constraints:
Range: 1 - 100000
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
InvalidArgumentException
.
Constraints:
Range: 1 - 10000
com.amazonaws.internal.ListWithAutoConstructFlag<T> records
String nextShardIterator
null
, the shard has been
closed and the requested iterator will not return any more data.
Constraints:
Length: 1 - 512
Long millisBehindLatest
Constraints:
Range: 0 -
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 - 1048576
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 result 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})
com.amazonaws.internal.ListWithAutoConstructFlag<T> records
Constraints:
Length: 1 - 500
String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
ByteBuffer data
Constraints:
Length: 0 - 1048576
String explicitHashKey
Constraints:
Pattern: 0|([1-9]\d{0,38})
String partitionKey
Constraints:
Length: 1 - 256
Integer failedRecordCount
PutRecords
request.
Constraints:
Range: 1 - 100000
com.amazonaws.internal.ListWithAutoConstructFlag<T> records
SequenceNumber
and ShardId
in the result. A
record that fails to be added to your Amazon Kinesis stream includes
ErrorCode
and ErrorMessage
in the result.
Constraints:
Length: 1 - 500
String sequenceNumber
Constraints:
Pattern: 0|([1-9]\d{0,128})
String shardId
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String errorCode
ErrorCodes
can be either
ProvisionedThroughputExceededException
or
InternalFailure
.String errorMessage
ErrorCode
value of
ProvisionedThroughputExceededException
has an error
message that includes the account ID, stream name, and shard ID. An
ErrorCode
value of InternalFailure
has the
error message "Internal Service Failure"
.String sequenceNumber
Constraints:
Pattern: 0|([1-9]\d{0,128})
Date approximateArrivalTimestamp
ByteBuffer data
Constraints:
Length: 0 - 1048576
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 aliasName
Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$
String aliasArn
Constraints:
Length: 20 - 2048
String targetKeyId
Constraints:
Length: 1 - 256
String aliasName
Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$
String targetKeyId
Constraints:
Length: 1 - 256
String keyId
Constraints:
Length: 1 - 256
String granteePrincipal
keyId
parameter.
Constraints:
Length: 1 - 256
String retiringPrincipal
Constraints:
Length: 1 - 256
com.amazonaws.internal.ListWithAutoConstructFlag<T> operations
GrantConstraints constraints
Operations
parameter are allowed.com.amazonaws.internal.ListWithAutoConstructFlag<T> grantTokens
Constraints:
Length: 0 - 10
String grantToken
Constraints:
Length: 1 - 8192
String grantId
Constraints:
Length: 1 - 128
String policy
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
String description
Constraints:
Length: 0 - 8192
String keyUsage
Constraints:
Allowed Values: ENCRYPT_DECRYPT
KeyMetadata keyMetadata
ByteBuffer ciphertextBlob
Constraints:
Length: 1 - 6144
Map<K,V> encryptionContext
com.amazonaws.internal.ListWithAutoConstructFlag<T> grantTokens
Constraints:
Length: 0 - 10
String keyId
Constraints:
Length: 1 - 256
ByteBuffer plaintext
Constraints:
Length: 1 - 4096
String aliasName
Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$
String keyId
Constraints:
Length: 1 - 256
KeyMetadata keyMetadata
String keyId
Constraints:
Length: 1 - 256
String keyId
Constraints:
Length: 1 - 256
String keyId
Constraints:
Length: 1 - 256
String keyId
Constraints:
Length: 1 - 256
String keyId
Constraints:
Length: 1 - 256
ByteBuffer plaintext
Constraints:
Length: 1 - 4096
Map<K,V> encryptionContext
Decrypt
API or decryption will fail. For
more information, see Encryption
Context.com.amazonaws.internal.ListWithAutoConstructFlag<T> grantTokens
Constraints:
Length: 0 - 10
ByteBuffer ciphertextBlob
Constraints:
Length: 1 - 6144
String keyId
Constraints:
Length: 1 - 256
String keyId
Constraints:
Length: 1 - 256
Map<K,V> encryptionContext
Integer numberOfBytes
KeySpec
parameter instead.
Constraints:
Range: 1 - 1024
String keySpec
Constraints:
Allowed Values: AES_256, AES_128
com.amazonaws.internal.ListWithAutoConstructFlag<T> grantTokens
Constraints:
Length: 0 - 10
ByteBuffer ciphertextBlob
If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
Constraints:
Length: 1 - 6144
ByteBuffer plaintext
Constraints:
Length: 1 - 4096
String keyId
Constraints:
Length: 1 - 256
String keyId
Constraints:
Length: 1 - 256
Map<K,V> encryptionContext
String keySpec
Constraints:
Allowed Values: AES_256, AES_128
Integer numberOfBytes
KeySpec
parameter instead.
Constraints:
Range: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> grantTokens
Constraints:
Length: 0 - 10
ByteBuffer ciphertextBlob
If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
Constraints:
Length: 1 - 6144
String keyId
Constraints:
Length: 1 - 256
Integer numberOfBytes
Constraints:
Range: 1 - 1024
ByteBuffer plaintext
Constraints:
Length: 1 - 4096
String keyId
Constraints:
Length: 1 - 256
String policyName
Constraints:
Length: 1 - 128
Pattern: [\w]+
String policy
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
String keyId
Constraints:
Length: 1 - 256
Boolean keyRotationEnabled
String grantId
Constraints:
Length: 1 - 128
String granteePrincipal
Constraints:
Length: 1 - 256
String retiringPrincipal
Constraints:
Length: 1 - 256
String issuingAccount
Constraints:
Length: 1 - 256
com.amazonaws.internal.ListWithAutoConstructFlag<T> operations
GrantConstraints constraints
Operations
parameter are allowed.String aWSAccountId
String keyId
Constraints:
Length: 1 - 256
String arn
Constraints:
Length: 20 - 2048
Date creationDate
Boolean enabled
String description
Constraints:
Length: 0 - 8192
String keyUsage
Constraints:
Allowed Values: ENCRYPT_DECRYPT
Integer limit
Truncated
response element will be set to true.
Constraints:
Range: 1 - 1000
String marker
NextMarker
element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> aliases
String nextMarker
Truncated
is true, this value is present and contains
the value to use for the Marker
request parameter in a
subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
Boolean truncated
Marker
request parameter to retrieve
more aliases in the list.String keyId
Constraints:
Length: 1 - 256
Integer limit
Truncated
response element will be set to
true.
Constraints:
Range: 1 - 1000
String marker
NextMarker
in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> grants
String nextMarker
Truncated
is true, this value is present and contains
the value to use for the Marker
request parameter in a
subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
Boolean truncated
Marker
request parameter to retrieve
more grants in the list.String keyId
Constraints:
Length: 1 - 256
Integer limit
Truncated
response element will be set to
true.
Constraints:
Range: 1 - 1000
String marker
NextMarker
in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
String nextMarker
Truncated
is true, this value is present and contains
the value to use for the Marker
request parameter in a
subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
Boolean truncated
Marker
request parameter to retrieve
more policies in the list.Integer limit
Truncated
response element will be set to
true.
Constraints:
Range: 1 - 1000
String marker
NextMarker
in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> keys
String nextMarker
Truncated
is true, this value is present and contains
the value to use for the Marker
request parameter in a
subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
Boolean truncated
Marker
request parameter to retrieve
more keys in the list.String keyId
Constraints:
Length: 1 - 256
String policyName
Constraints:
Length: 1 - 128
Pattern: [\w]+
String policy
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
ByteBuffer ciphertextBlob
Constraints:
Length: 1 - 6144
Map<K,V> sourceEncryptionContext
CiphertextBlob
parameter.String destinationKeyId
Constraints:
Length: 1 - 256
Map<K,V> destinationEncryptionContext
com.amazonaws.internal.ListWithAutoConstructFlag<T> grantTokens
Constraints:
Length: 0 - 10
ByteBuffer ciphertextBlob
Constraints:
Length: 1 - 6144
String sourceKeyId
Constraints:
Length: 1 - 256
String keyId
Constraints:
Length: 1 - 256
String grantToken
Constraints:
Length: 1 - 8192
String keyId
Constraints:
Length: 1 - 256
String grantId
CreateGrant
function.
Constraints:
Length: 1 - 128
String keyId
Constraints:
Length: 1 - 256
String grantId
Constraints:
Length: 1 - 128
String aliasName
Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$
String targetKeyId
Constraints:
Length: 1 - 256
String keyId
Constraints:
Length: 1 - 256
String description
Constraints:
Length: 0 - 8192
boolean handled
String type
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 111
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)
String statementId
Constraints:
Length: 1 - 100
Pattern: ([a-zA-Z0-9-_]+)
String action
Constraints:
Pattern: (lambda:[*]|lambda:[a-zA-Z]+|[*])
String principal
Constraints:
Pattern: .*
String sourceArn
Constraints:
Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)
String sourceAccount
SourceArn
identifies a bucket, then this
is the bucket owner's account ID. You can use this additional
condition to ensure the bucket you specify is owned by a specific
account (it is possible the bucket owner deleted the bucket and some
other AWS account created the bucket). You can also use this condition
to specify all sources (that is, you don't specify the
SourceArn
) owned by a specific account.
Constraints:
Pattern: \d{12}
String statement
String type
String eventSourceArn
BatchSize
. AWS Lambda POSTs the Amazon
Kinesis event, containing records, to your Lambda function as JSON.
Constraints:
Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 111
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)
Boolean enabled
Integer batchSize
Constraints:
Range: 1 - 10000
String startingPosition
Constraints:
Allowed Values: TRIM_HORIZON, LATEST
String uUID
Integer batchSize
Constraints:
Range: 1 - 10000
String eventSourceArn
Constraints:
Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)
String functionArn
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?
Date lastModified
String lastProcessingResult
String state
String stateTransitionReason
String functionName
Constraints:
Length: 1 - 111
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)
String runtime
Constraints:
Allowed Values: nodejs, java8
String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
String handler
package.class-name::handler
or package.class-name
. For more information, see Lambda
Function Handler (Java).
Constraints:
Length: 0 - 128
Pattern: [^\s]+
String description
Constraints:
Length: 0 - 256
Integer timeout
Constraints:
Range: 1 - 60
Integer memorySize
Constraints:
Range: 128 - 1536
FunctionCode code
String functionName
Constraints:
Length: 1 - 111
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)
String functionArn
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?
String runtime
Constraints:
Allowed Values: nodejs, java8
String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
String handler
Constraints:
Length: 0 - 128
Pattern: [^\s]+
Long codeSize
String description
Constraints:
Length: 0 - 256
Integer timeout
Constraints:
Range: 1 - 60
Integer memorySize
Constraints:
Range: 128 - 1536
String lastModified
String uUID
String uUID
Integer batchSize
Constraints:
Range: 1 - 10000
String eventSourceArn
Constraints:
Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)
String functionArn
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?
Date lastModified
String lastProcessingResult
String state
String stateTransitionReason
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 111
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)
String uUID
Integer batchSize
Constraints:
Range: 1 - 10000
String eventSourceArn
Constraints:
Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)
String functionArn
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?
Date lastModified
String lastProcessingResult
String state
String stateTransitionReason
ByteBuffer zipFile
String s3Bucket
Constraints:
Length: 3 - 63
Pattern: ^[0-9A-Za-z\.\-_]*(?
String s3Key
Constraints:
Length: 1 - 1024
String s3ObjectVersion
Constraints:
Length: 1 - 1024
String functionName
Constraints:
Length: 1 - 111
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)
String functionArn
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?
String runtime
Constraints:
Allowed Values: nodejs, java8
String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
String handler
Constraints:
Length: 0 - 128
Pattern: [^\s]+
Long codeSize
String description
Constraints:
Length: 0 - 256
Integer timeout
Constraints:
Range: 1 - 60
Integer memorySize
Constraints:
Range: 128 - 1536
String lastModified
String uUID
String uUID
Integer batchSize
Constraints:
Range: 1 - 10000
String eventSourceArn
Constraints:
Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)
String functionArn
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?
Date lastModified
String lastProcessingResult
String state
String stateTransitionReason
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 111
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)
String functionName
Constraints:
Length: 1 - 111
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)
String functionArn
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?
String runtime
Constraints:
Allowed Values: nodejs, java8
String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
String handler
Constraints:
Length: 0 - 128
Pattern: [^\s]+
Long codeSize
String description
Constraints:
Length: 0 - 256
Integer timeout
Constraints:
Range: 1 - 60
Integer memorySize
Constraints:
Range: 128 - 1536
String lastModified
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 111
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)
FunctionConfiguration configuration
FunctionCodeLocation code
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 111
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)
String policy
String type
String type
String functionName
Constraints:
Length: 1 - 111
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)
InputStream invokeArgs
Integer status
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 111
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)
String invocationType
Invoke
API assumes "RequestResponse"
invocation type. You can optionally request asynchronous execution by
specifying "Event" as the InvocationType
. You can also
use this parameter to request AWS Lambda to not execute the function
but do some verification, such as if the caller is authorized to
invoke the function and if the inputs are valid. You request this by
specifying "DryRun" as the InvocationType
. This is useful
in a cross-account scenario when you want to verify access to a
function without running it.
Constraints:
Allowed Values: Event, RequestResponse, DryRun
String logType
InvocationType
parameter with value
"RequestResponse". In this case, AWS Lambda returns the base64-encoded
last 4 KB of log data produced by your Lambda function in the
x-amz-log-results
header.
Constraints:
Allowed Values: None, Tail
String clientContext
ClientContext
you can pass client-specific
information to the Lambda function you are invoking. You can then
process the client information in your Lambda function as you choose
through the context variable. For an example of a ClientContext JSON,
go to PutEvents
in the Amazon Mobile Analytics API Reference and User Guide.
The ClientContext JSON must be base64-encoded.
ByteBuffer payload
Integer statusCode
String functionError
Handled
or Unhandled
. Handled
errors are errors that are reported by the function while the
Unhandled
errors are those detected and reported by AWS
Lambda. Unhandled errors include out of memory errors and function
timeouts. For information about how to report an Handled
error, see Programming
Model.String logResult
ByteBuffer payload
In the event of a function error this field
contains a message describing the error. For the Handled
errors the Lambda function will report this message. For
Unhandled
errors AWS Lambda reports the message.
String eventSourceArn
Constraints:
Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 111
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)
String marker
ListEventSourceMappings
operation. If present, specifies
to continue the list from where the returning call left off.Integer maxItems
Constraints:
Range: 1 - 10000
String nextMarker
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventSourceMappings
EventSourceMappingConfiguration
objects.String marker
ListFunctions
operation. If present, indicates where to
continue the listing.Integer maxItems
Constraints:
Range: 1 - 10000
String nextMarker
com.amazonaws.internal.ListWithAutoConstructFlag<T> functions
String type
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 111
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)
String statementId
Constraints:
Length: 1 - 100
Pattern: ([a-zA-Z0-9-_]+)
String type
String type
String type
String type
String type
String uUID
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 111
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)
Boolean enabled
Integer batchSize
Constraints:
Range: 1 - 10000
String uUID
Integer batchSize
Constraints:
Range: 1 - 10000
String eventSourceArn
Constraints:
Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)
String functionArn
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?
Date lastModified
String lastProcessingResult
String state
String stateTransitionReason
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 111
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)
ByteBuffer zipFile
String s3Bucket
Constraints:
Length: 3 - 63
Pattern: ^[0-9A-Za-z\.\-_]*(?
String s3Key
Constraints:
Length: 1 - 1024
String s3ObjectVersion
Constraints:
Length: 1 - 1024
String functionName
Constraints:
Length: 1 - 111
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)
String functionArn
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?
String runtime
Constraints:
Allowed Values: nodejs, java8
String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
String handler
Constraints:
Length: 0 - 128
Pattern: [^\s]+
Long codeSize
String description
Constraints:
Length: 0 - 256
Integer timeout
Constraints:
Range: 1 - 60
Integer memorySize
Constraints:
Range: 128 - 1536
String lastModified
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 111
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)
String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
String handler
Constraints:
Length: 0 - 128
Pattern: [^\s]+
String description
Constraints:
Length: 0 - 256
Integer timeout
Constraints:
Range: 1 - 60
Integer memorySize
Constraints:
Range: 128 - 1536
String functionName
Constraints:
Length: 1 - 111
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)
String functionArn
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?
String runtime
Constraints:
Allowed Values: nodejs, java8
String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
String handler
Constraints:
Length: 0 - 128
Pattern: [^\s]+
Long codeSize
String description
Constraints:
Length: 0 - 256
Integer timeout
Constraints:
Range: 1 - 60
Integer memorySize
Constraints:
Range: 128 - 1536
String lastModified
String taskId
Id of the export task to cancel.
String taskName
The name of the export task.
String logGroupName
The name of the log group to export.
String logStreamNamePrefix
Will only export log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.
Long from
A unix timestamp indicating the start time of the range for the request. Events with a timestamp prior to this time will not be exported.
Long to
A unix timestamp indicating the end time of the range for the request. Events with a timestamp later than this time will not be exported.
String destination
Name of Amazon S3 bucket to which the log data will be exported.
NOTE: Only buckets in the same AWS region are supported
String destinationPrefix
Prefix that will be used as the start of Amazon S3 key for every object exported. If not specified, this defaults to 'exportedlogs'.
String taskId
Id of the export task that got created.
String logGroupName
The name of the log group to create.
String expectedSequenceToken
String destinationName
The name of destination to delete.
String logGroupName
The name of the log group to delete.
String logGroupName
The name of the log group that is associated with the retention policy to delete.
com.amazonaws.internal.SdkInternalList<T> destinations
String nextToken
String taskId
Export task that matches the specified task Id will be returned. This can result in zero or one export task.
String statusCode
All export tasks that matches the specified status code will be returned. This can return zero or more export tasks.
String nextToken
A string token used for pagination that points to the next page of
results. It must be a value obtained from the response of the previous
DescribeExportTasks
request.
Integer limit
The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
com.amazonaws.internal.SdkInternalList<T> exportTasks
String nextToken
String logGroupNamePrefix
Will only return log groups that match the provided logGroupNamePrefix. If you don't specify a value, no prefix filter is applied.
String nextToken
A string token used for pagination that points to the next page of
results. It must be a value obtained from the response of the previous
DescribeLogGroups
request.
Integer limit
The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
com.amazonaws.internal.SdkInternalList<T> logGroups
String nextToken
String logGroupName
The log group name for which log streams are to be listed.
String logStreamNamePrefix
Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.
String orderBy
Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.
Boolean descending
If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.
String nextToken
A string token used for pagination that points to the next page of
results. It must be a value obtained from the response of the previous
DescribeLogStreams
request.
Integer limit
The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
com.amazonaws.internal.SdkInternalList<T> logStreams
String nextToken
String logGroupName
The log group name for which metric filters are to be listed.
String filterNamePrefix
Will only return metric filters that match the provided filterNamePrefix. If you don't specify a value, no prefix filter is applied.
String nextToken
A string token used for pagination that points to the next page of
results. It must be a value obtained from the response of the previous
DescribeMetricFilters
request.
Integer limit
The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
com.amazonaws.internal.SdkInternalList<T> metricFilters
String nextToken
String logGroupName
The log group name for which subscription filters are to be listed.
String filterNamePrefix
Will only return subscription filters that match the provided filterNamePrefix. If you don't specify a value, no prefix filter is applied.
String nextToken
Integer limit
com.amazonaws.internal.SdkInternalList<T> subscriptionFilters
String nextToken
String destinationName
Name of the destination.
String targetArn
ARN of the physical target where the log events will be delivered (eg. ARN of a Kinesis stream).
String roleArn
A role for impersonation for delivering log events to the target.
String accessPolicy
An IAM policy document that governs which AWS accounts can create subscription filters against this destination.
String arn
ARN of this destination.
Long creationTime
A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC specifying when this destination was created.
String taskId
Id of the export task.
String taskName
The name of the export task.
String logGroupName
The name of the log group from which logs data was exported.
Long from
A unix timestamp indicating the start time of the range for the request. Events with a timestamp prior to this time were not exported.
Long to
A unix timestamp indicating the end time of the range for the request. Events with a timestamp later than this time were not exported.
String destination
Name of Amazon S3 bucket to which the log data was exported.
String destinationPrefix
Prefix that was used as the start of Amazon S3 key for every object exported.
ExportTaskStatus status
Status of the export task.
ExportTaskExecutionInfo executionInfo
Execution info about the export task.
String logGroupName
The name of the log group to query.
com.amazonaws.internal.SdkInternalList<T> logStreamNames
Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.
Long startTime
A unix timestamp indicating the start time of the range for the request. If provided, events with a timestamp prior to this time will not be returned.
Long endTime
A unix timestamp indicating the end time of the range for the request. If provided, events with a timestamp later than this time will not be returned.
String filterPattern
A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.
String nextToken
A pagination token obtained from a
FilterLogEvents
response to continue paginating
the FilterLogEvents results.
Integer limit
The maximum number of events to return in a page of results. Default is 10,000 events.
Boolean interleaved
If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.
com.amazonaws.internal.SdkInternalList<T> events
A list of FilteredLogEvent
objects representing
the matched events from the request.
com.amazonaws.internal.SdkInternalList<T> searchedLogStreams
A list of SearchedLogStream
objects indicating
which log streams have been searched in this request and whether each has
been searched completely or still has more to be paginated.
String nextToken
A pagination token obtained from a
FilterLogEvents
response to continue paginating
the FilterLogEvents results.
String logGroupName
The name of the log group to query.
String logStreamName
The name of the log stream to query.
Long startTime
Long endTime
String nextToken
A string token used for pagination that points to the next page of
results. It must be a value obtained from the
nextForwardToken
or
nextBackwardToken
fields in the response of the
previous GetLogEvents
request.
Integer limit
The maximum number of log events returned in the response. If you don't specify a value, the request would return as many log events as can fit in a response size of 1MB, up to 10,000 log events.
Boolean startFromHead
If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).
com.amazonaws.internal.SdkInternalList<T> events
String nextForwardToken
String nextBackwardToken
String expectedSequenceToken
String filterName
String filterPattern
com.amazonaws.internal.SdkInternalList<T> metricTransformations
Long creationTime
Long eventNumber
String eventMessage
com.amazonaws.internal.SdkInternalMap<K,V> extractedValues
String destinationName
A name for the destination.
String targetArn
The ARN of an Amazon Kinesis stream to deliver matching log events to.
String roleArn
The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to do Amazon Kinesis PutRecord requests on the desitnation stream.
Destination destination
String logGroupName
The name of the log group to put log events to.
String logStreamName
The name of the log stream to put log events to.
com.amazonaws.internal.SdkInternalList<T> logEvents
String sequenceToken
A string token that must be obtained from the response of the previous
PutLogEvents
request.
String nextSequenceToken
RejectedLogEventsInfo rejectedLogEventsInfo
String logGroupName
The name of the log group to associate the metric filter with.
String filterName
A name for the metric filter.
String filterPattern
A valid CloudWatch Logs filter pattern for extracting metric data out of ingested log events.
com.amazonaws.internal.SdkInternalList<T> metricTransformations
A collection of information needed to define how metric data gets emitted.
String logGroupName
The name of the log group to associate the subscription filter with.
String filterName
A name for the subscription filter.
String filterPattern
A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events.
String destinationArn
The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:
Destination
)
belonging to a different account, for cross-account delivery.String roleArn
The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to
deliver ingested log events to the destination stream. You don't need to
provide the ARN when you are working with a logical destination (used via
an ARN of Destination
) for cross-account delivery.
String filterPattern
com.amazonaws.internal.SdkInternalList<T> logEventMessages
A list of log event messages to test.
com.amazonaws.internal.SdkInternalList<T> matches
String batchPredictionId
The ID assigned to the BatchPrediction
at creation. This
value should be identical to the value of the
BatchPredictionID
in the request.
String mLModelId
The ID of the MLModel
that generated predictions for the
BatchPrediction
request.
String batchPredictionDataSourceId
The ID of the DataSource
that points to the group of
observations to predict.
String inputDataLocationS3
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
String createdByIamUser
The AWS user account that invoked the BatchPrediction
. The
account type can be either an AWS root account or an AWS Identity and
Access Management (IAM) user account.
Date createdAt
The time that the BatchPrediction
was created. The time is
expressed in epoch time.
Date lastUpdatedAt
The time of the most recent edit to the BatchPrediction
. The
time is expressed in epoch time.
String name
A user-supplied name or description of the BatchPrediction
.
String status
The status of the BatchPrediction
. This element can have one
of the following values:
PENDING
- Amazon Machine Learning (Amazon ML) submitted
a request to generate predictions for a batch of observations.INPROGRESS
- The process is underway.FAILED
- The request to peform a batch prediction did
not run to completion. It is not usable.COMPLETED
- The batch prediction process completed
successfully.DELETED
- The BatchPrediction
is marked as
deleted. It is not usable.String outputUri
The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the s3 key portion of the "outputURI" field: ':', '//', '/./', '/../'.
String message
A description of the most recent details about processing the batch prediction request.
String batchPredictionId
A user-supplied ID that uniquely identifies the
BatchPrediction
.
String batchPredictionName
A user-supplied name or description of the BatchPrediction
.
BatchPredictionName
can only use the UTF-8 character set.
String mLModelId
The ID of the MLModel
that will generate predictions for the
group of observations.
String batchPredictionDataSourceId
The ID of the DataSource
that points to the group of
observations to predict.
String outputUri
The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the "outputURI" field: ':', '//', '/./', '/../'.
Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.
String batchPredictionId
A user-supplied ID that uniquely identifies the
BatchPrediction
. This value is identical to the value of the
BatchPredictionId
in the request.
String dataSourceId
A user-supplied ID that uniquely identifies the DataSource
.
Typically, an Amazon Resource Number (ARN) becomes the ID for a
DataSource
.
String dataSourceName
A user-supplied name or description of the DataSource
.
RDSDataSpec rDSData
The data specification of an Amazon RDS DataSource
:
DatabaseInformation -
DatabaseName
- Name of the Amazon RDS database. InstanceIdentifier
- Unique identifier for the Amazon
RDS database instance.DatabaseCredentials - AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon RDS database.
ResourceRole - Role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (EC2) instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
ServiceRole - Role (DataPipelineDefaultRole) assumed by the AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon Simple Storage Service (S3). For more information, see Role templates for data pipelines.
SecurityInfo - Security information to use to access an Amazon RDS
instance. You need to set up appropriate ingress rules for the security
entity IDs provided to allow access to the Amazon RDS instance. Specify a
[SubnetId
, SecurityGroupIds
] pair for a
VPC-based Amazon RDS instance.
SelectSqlQuery - Query that is used to retrieve the observation data for
the Datasource
.
S3StagingLocation - Amazon S3 location for staging RDS data. The data
retrieved from Amazon RDS using SelectSqlQuery
is stored in
this location.
DataSchemaUri - Amazon S3 location of the DataSchema
.
DataSchema - A JSON string representing the schema. This is not required
if DataSchemaUri
is specified.
DataRearrangement - A JSON string representing the splitting requirement
of a Datasource
.
Sample -
"{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
String roleARN
The role that Amazon ML assumes on behalf of the user to create and
activate a data pipeline in the user’s account and copy data (using the
SelectSqlQuery
) query from Amazon RDS to Amazon S3.
Boolean computeStatistics
The compute statistics for a DataSource
. The statistics are
generated from the observation data referenced by a
DataSource
. Amazon ML uses the statistics internally during
an MLModel
training. This parameter must be set to
true
if the DataSource
needs to be
used for
MLModel
training.
String dataSourceId
A user-supplied ID that uniquely identifies the datasource. This value
should be identical to the value of the DataSourceID
in the
request.
String dataSourceId
A user-supplied ID that uniquely identifies the DataSource
.
String dataSourceName
A user-supplied name or description of the DataSource
.
RedshiftDataSpec dataSpec
The data specification of an Amazon Redshift DataSource
:
DatabaseInformation -
DatabaseName
- Name of the Amazon Redshift database. ClusterIdentifier
- Unique ID for the Amazon Redshift
cluster.DatabaseCredentials - AWS Identity abd Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.
SelectSqlQuery - Query that is used to retrieve the observation data for
the Datasource
.
S3StagingLocation - Amazon Simple Storage Service (Amazon S3) location
for staging Amazon Redshift data. The data retrieved from Amazon
Relational Database Service (Amazon RDS) using
SelectSqlQuery
is stored in this location.
DataSchemaUri - Amazon S3 location of the DataSchema
.
DataSchema - A JSON string representing the schema. This is not required
if DataSchemaUri
is specified.
DataRearrangement - A JSON string representing the splitting requirement
of a Datasource
.
Sample -
"{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
String roleARN
A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:
A security group to allow Amazon ML to execute the
SelectSqlQuery
query on an Amazon Redshift cluster
An Amazon S3 bucket policy to grant Amazon ML read/write permissions on
the S3StagingLocation
Boolean computeStatistics
The compute statistics for a DataSource
. The statistics are
generated from the observation data referenced by a
DataSource
. Amazon ML uses the statistics internally during
MLModel
training. This parameter must be set to
true
if the DataSource
needs to be
used for
MLModel
training
String dataSourceId
A user-supplied ID that uniquely identifies the datasource. This value
should be identical to the value of the DataSourceID
in the
request.
String dataSourceId
A user-supplied identifier that uniquely identifies the
DataSource
.
String dataSourceName
A user-supplied name or description of the DataSource
.
S3DataSpec dataSpec
The data specification of a DataSource
:
DataLocationS3 - Amazon Simple Storage Service (Amazon S3) location of the observation data.
DataSchemaLocationS3 - Amazon S3 location of the DataSchema
.
DataSchema - A JSON string representing the schema. This is not required
if DataSchemaUri
is specified.
DataRearrangement - A JSON string representing the splitting requirement
of a Datasource
.
Sample -
"{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
Boolean computeStatistics
The compute statistics for a DataSource
. The statistics are
generated from the observation data referenced by a
DataSource
. Amazon ML uses the statistics internally during
an MLModel
training. This parameter must be set to
true
if the DataSource
needs to be
used for
MLModel
training
String dataSourceId
A user-supplied ID that uniquely identifies the datasource. This value
should be identical to the value of the DataSourceID
in the
request.
String evaluationId
A user-supplied ID that uniquely identifies the Evaluation
.
String evaluationName
A user-supplied name or description of the Evaluation
.
String mLModelId
The ID of the MLModel
to evaluate.
The schema used in creating the MLModel
must match the
schema of the DataSource
used in the Evaluation
.
String evaluationDataSourceId
The ID of the DataSource
for the evaluation. The schema of
the DataSource
must match the schema used to create the
MLModel
.
String evaluationId
The user-supplied ID that uniquely identifies the Evaluation
. This value should be identical to the value of the
EvaluationId
in the request.
String mLModelId
A user-supplied ID that uniquely identifies the MLModel
.
String mLModelName
A user-supplied name or description of the MLModel
.
String mLModelType
The category of supervised learning that this MLModel
will
address. Choose from the following types:
REGRESSION
if the MLModel
will be
used to predict a numeric value.BINARY
if the MLModel
result has two
possible values.MULTICLASS
if the MLModel
result has
a limited number of values.For more information, see the Amazon Machine Learning Developer Guide.
com.amazonaws.internal.SdkInternalMap<K,V> parameters
A list of the training parameters in the MLModel
. The list
is implemented as a map of key/value pairs.
The following is the current set of training parameters:
sgd.l1RegularizationAmount
- Coefficient regularization L1
norm. It controls overfitting the data by penalizing large coefficients.
This tends to drive coefficients to zero, resulting in sparse feature
set. If you use this parameter, start by specifying a small value such as
1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is
not to use L1 normalization. The parameter cannot be used when
L2
is specified. Use this parameter sparingly.
sgd.l2RegularizationAmount
- Coefficient regularization L2
norm. It controls overfitting the data by penalizing large coefficients.
This tends to drive coefficients to small, nonzero values. If you use
this parameter, start by specifying a small value such as 1.0E-08.
The valuseis a double that ranges from 0 to MAX_DOUBLE. The default is
not to use L2 normalization. This cannot be used when L1
is
specified. Use this parameter sparingly.
sgd.maxPasses
- Number of times that the training process
traverses the observations to build the MLModel
. The value
is an integer that ranges from 1 to 10000. The default value is 10.
sgd.maxMLModelSizeInBytes
- Maximum allowed size of the
model. Depending on the input data, the size of the model might affect
its performance.
The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.
String trainingDataSourceId
The DataSource
that points to the training data.
String recipe
The data recipe for creating MLModel
. You must specify
either the recipe or its URI. If you don’t specify a recipe or its URI,
Amazon ML creates a default.
String recipeUri
The Amazon Simple Storage Service (Amazon S3) location and file name that
contains the MLModel
recipe. You must specify either the
recipe or its URI. If you don’t specify a recipe or its URI, Amazon ML
creates a default.
String mLModelId
A user-supplied ID that uniquely identifies the MLModel
.
This value should be identical to the value of the MLModelId
in the request.
String mLModelId
The ID assigned to the MLModel
during creation.
String mLModelId
A user-supplied ID that uniquely identifies the MLModel
.
This value should be identical to the value of the MLModelId
in the request.
RealtimeEndpointInfo realtimeEndpointInfo
The endpoint information of the MLModel
String dataSourceId
The ID that is assigned to the DataSource
during creation.
String dataLocationS3
The location and name of the data in Amazon Simple Storage Service
(Amazon S3) that is used by a DataSource
.
String dataRearrangement
A JSON string that represents the splitting requirement of a
Datasource
.
String createdByIamUser
The AWS user account from which the DataSource
was created.
The account type can be either an AWS root account or an AWS Identity and
Access Management (IAM) user account.
Date createdAt
The time that the DataSource
was created. The time is
expressed in epoch time.
Date lastUpdatedAt
The time of the most recent edit to the BatchPrediction
. The
time is expressed in epoch time.
Long dataSizeInBytes
The total number of observations contained in the data files that the
DataSource
references.
Long numberOfFiles
The number of data files referenced by the DataSource
.
String name
A user-supplied name or description of the DataSource
.
String status
The current status of the DataSource
. This element can have
one of the following values:
DataSource
.DataSource
did not run
to completion. It is not usable.DataSource
is marked as deleted. It is not
usable.String message
A description of the most recent details about creating the
DataSource
.
RedshiftMetadata redshiftMetadata
RDSMetadata rDSMetadata
String roleARN
Boolean computeStatistics
The parameter is true
if statistics need to be generated
from the observation data.
String batchPredictionId
A user-supplied ID that uniquely identifies the
BatchPrediction
.
String batchPredictionId
A user-supplied ID that uniquely identifies the
BatchPrediction
. This value should be identical to the value
of the BatchPredictionID
in the request.
String dataSourceId
A user-supplied ID that uniquely identifies the DataSource
.
String dataSourceId
A user-supplied ID that uniquely identifies the DataSource
.
This value should be identical to the value of the
DataSourceID
in the request.
String evaluationId
A user-supplied ID that uniquely identifies the Evaluation
to delete.
String evaluationId
A user-supplied ID that uniquely identifies the Evaluation
.
This value should be identical to the value of the
EvaluationId
in the request.
String mLModelId
A user-supplied ID that uniquely identifies the MLModel
.
String mLModelId
A user-supplied ID that uniquely identifies the MLModel
.
This value should be identical to the value of the MLModelID
in the request.
String mLModelId
The ID assigned to the MLModel
during creation.
String mLModelId
A user-supplied ID that uniquely identifies the MLModel
.
This value should be identical to the value of the MLModelId
in the request.
RealtimeEndpointInfo realtimeEndpointInfo
The endpoint information of the MLModel
String filterVariable
Use one of the following variables to filter a list of
BatchPrediction
:
CreatedAt
- Sets the search criteria to the
BatchPrediction
creation date.Status
- Sets the search criteria to the
BatchPrediction
status.Name
- Sets the search criteria to the contents of the
BatchPrediction
Name
.IAMUser
- Sets the search criteria to the user account
that invoked the BatchPrediction
creation.MLModelId
- Sets the search criteria to the
MLModel
used in the BatchPrediction
.DataSourceId
- Sets the search criteria to the
DataSource
used in the BatchPrediction
.DataURI
- Sets the search criteria to the data file(s)
used in the BatchPrediction
. The URL can identify either a
file or an Amazon Simple Storage Solution (Amazon S3) bucket or
directory.String eQ
The equal to operator. The BatchPrediction
results will have
FilterVariable
values that exactly match the value specified
with EQ
.
String gT
The greater than operator. The BatchPrediction
results will
have FilterVariable
values that are greater than the value
specified with GT
.
String lT
The less than operator. The BatchPrediction
results will
have FilterVariable
values that are less than the value
specified with LT
.
String gE
The greater than or equal to operator. The BatchPrediction
results will have FilterVariable
values that are greater
than or equal to the value specified with GE
.
String lE
The less than or equal to operator. The BatchPrediction
results will have FilterVariable
values that are less than
or equal to the value specified with LE
.
String nE
The not equal to operator. The BatchPrediction
results will
have FilterVariable
values not equal to the value specified
with NE
.
String prefix
A string that is found at the beginning of a variable, such as
Name
or Id
.
For example, a Batch Prediction
operation could have the
Name
2014-09-09-HolidayGiftMailer
. To search
for this BatchPrediction
, select Name
for the
FilterVariable
and any of the following strings for the
Prefix
:
2014-09
2014-09-09
2014-09-09-Holiday
String sortOrder
A two-value parameter that determines the sequence of the resulting list
of MLModel
s.
asc
- Arranges the list in ascending order (A-Z, 0-9).dsc
- Arranges the list in descending order (Z-A, 9-0).
Results are sorted by FilterVariable
.
String nextToken
An ID of the page in the paginated results.
Integer limit
The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.
com.amazonaws.internal.SdkInternalList<T> results
A list of BatchPrediction objects that meet the search criteria.
String nextToken
The ID of the next page in the paginated results that indicates at least one more page follows.
String filterVariable
Use one of the following variables to filter a list of
DataSource
:
CreatedAt
- Sets the search criteria to
DataSource
creation dates.Status
- Sets the search criteria to
DataSource
statuses.Name
- Sets the search criteria to the contents of
DataSource
Name
.DataUri
- Sets the search criteria to the URI of data
files used to create the DataSource
. The URI can identify
either a file or an Amazon Simple Storage Service (Amazon S3) bucket or
directory.IAMUser
- Sets the search criteria to the user account
that invoked the DataSource
creation.String eQ
The equal to operator. The DataSource
results will have
FilterVariable
values that exactly match the value specified
with EQ
.
String gT
The greater than operator. The DataSource
results will have
FilterVariable
values that are greater than the value
specified with GT
.
String lT
The less than operator. The DataSource
results will have
FilterVariable
values that are less than the value specified
with LT
.
String gE
The greater than or equal to operator. The DataSource
results will have FilterVariable
values that are greater
than or equal to the value specified with GE
.
String lE
The less than or equal to operator. The DataSource
results
will have FilterVariable
values that are less than or equal
to the value specified with LE
.
String nE
The not equal to operator. The DataSource
results will have
FilterVariable
values not equal to the value specified with
NE
.
String prefix
A string that is found at the beginning of a variable, such as
Name
or Id
.
For example, a DataSource
could have the Name
2014-09-09-HolidayGiftMailer
. To search for this
DataSource
, select Name
for the
FilterVariable
and any of the following strings for the
Prefix
:
2014-09
2014-09-09
2014-09-09-Holiday
String sortOrder
A two-value parameter that determines the sequence of the resulting list
of DataSource
.
asc
- Arranges the list in ascending order (A-Z, 0-9).dsc
- Arranges the list in descending order (Z-A, 9-0).
Results are sorted by FilterVariable
.
String nextToken
The ID of the page in the paginated results.
Integer limit
The maximum number of DataSource
to include in the result.
com.amazonaws.internal.SdkInternalList<T> results
A list of DataSource
that meet the search criteria.
String nextToken
An ID of the next page in the paginated results that indicates at least one more page follows.
String filterVariable
Use one of the following variable to filter a list of
Evaluation
objects:
CreatedAt
- Sets the search criteria to the
Evaluation
creation date.Status
- Sets the search criteria to the
Evaluation
status.Name
- Sets the search criteria to the contents of
Evaluation
Name
.IAMUser
- Sets the search criteria to the user account
that invoked an Evaluation
.MLModelId
- Sets the search criteria to the
MLModel
that was evaluated.DataSourceId
- Sets the search criteria to the
DataSource
used in Evaluation
.DataUri
- Sets the search criteria to the data file(s)
used in Evaluation
. The URL can identify either a file or an
Amazon Simple Storage Solution (Amazon S3) bucket or directory.String eQ
The equal to operator. The Evaluation
results will have
FilterVariable
values that exactly match the value specified
with EQ
.
String gT
The greater than operator. The Evaluation
results will have
FilterVariable
values that are greater than the value
specified with GT
.
String lT
The less than operator. The Evaluation
results will have
FilterVariable
values that are less than the value specified
with LT
.
String gE
The greater than or equal to operator. The Evaluation
results will have FilterVariable
values that are greater
than or equal to the value specified with GE
.
String lE
The less than or equal to operator. The Evaluation
results
will have FilterVariable
values that are less than or equal
to the value specified with LE
.
String nE
The not equal to operator. The Evaluation
results will have
FilterVariable
values not equal to the value specified with
NE
.
String prefix
A string that is found at the beginning of a variable, such as
Name
or Id
.
For example, an Evaluation
could have the Name
2014-09-09-HolidayGiftMailer
. To search for this
Evaluation
, select Name
for the
FilterVariable
and any of the following strings for the
Prefix
:
2014-09
2014-09-09
2014-09-09-Holiday
String sortOrder
A two-value parameter that determines the sequence of the resulting list
of Evaluation
.
asc
- Arranges the list in ascending order (A-Z, 0-9).dsc
- Arranges the list in descending order (Z-A, 9-0).
Results are sorted by FilterVariable
.
String nextToken
The ID of the page in the paginated results.
Integer limit
The maximum number of Evaluation
to include in the result.
com.amazonaws.internal.SdkInternalList<T> results
A list of Evaluation that meet the search criteria.
String nextToken
The ID of the next page in the paginated results that indicates at least one more page follows.
String filterVariable
Use one of the following variables to filter a list of
MLModel
:
CreatedAt
- Sets the search criteria to
MLModel
creation date.Status
- Sets the search criteria to
MLModel
status.Name
- Sets the search criteria to the contents of
MLModel
Name
.IAMUser
- Sets the search criteria to the user account
that invoked the MLModel
creation.TrainingDataSourceId
- Sets the search criteria to the
DataSource
used to train one or more MLModel
.RealtimeEndpointStatus
- Sets the search criteria to the
MLModel
real-time endpoint status.MLModelType
- Sets the search criteria to
MLModel
type: binary, regression, or multi-class.Algorithm
- Sets the search criteria to the algorithm
that the MLModel
uses.TrainingDataURI
- Sets the search criteria to the data
file(s) used in training a MLModel
. The URL can identify
either a file or an Amazon Simple Storage Service (Amazon S3) bucket or
directory.String eQ
The equal to operator. The MLModel
results will have
FilterVariable
values that exactly match the value specified
with EQ
.
String gT
The greater than operator. The MLModel
results will have
FilterVariable
values that are greater than the value
specified with GT
.
String lT
The less than operator. The MLModel
results will have
FilterVariable
values that are less than the value specified
with LT
.
String gE
The greater than or equal to operator. The MLModel
results
will have FilterVariable
values that are greater than or
equal to the value specified with GE
.
String lE
The less than or equal to operator. The MLModel
results will
have FilterVariable
values that are less than or equal to
the value specified with LE
.
String nE
The not equal to operator. The MLModel
results will have
FilterVariable
values not equal to the value specified with
NE
.
String prefix
A string that is found at the beginning of a variable, such as
Name
or Id
.
For example, an MLModel
could have the Name
2014-09-09-HolidayGiftMailer
. To search for this
MLModel
, select Name
for the
FilterVariable
and any of the following strings for the
Prefix
:
2014-09
2014-09-09
2014-09-09-Holiday
String sortOrder
A two-value parameter that determines the sequence of the resulting list
of MLModel
.
asc
- Arranges the list in ascending order (A-Z, 0-9).dsc
- Arranges the list in descending order (Z-A, 9-0).
Results are sorted by FilterVariable
.
String nextToken
The ID of the page in the paginated results.
Integer limit
The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.
com.amazonaws.internal.SdkInternalList<T> results
A list of MLModel that meet the search criteria.
String nextToken
The ID of the next page in the paginated results that indicates at least one more page follows.
String evaluationId
The ID that is assigned to the Evaluation
at creation.
String mLModelId
The ID of the MLModel
that is the focus of the evaluation.
String evaluationDataSourceId
The ID of the DataSource
that is used to evaluate the
MLModel
.
String inputDataLocationS3
The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.
String createdByIamUser
The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.
Date createdAt
The time that the Evaluation
was created. The time is
expressed in epoch time.
Date lastUpdatedAt
The time of the most recent edit to the Evaluation
. The time
is expressed in epoch time.
String name
A user-supplied name or description of the Evaluation
.
String status
The status of the evaluation. This element can have one of the following values:
PENDING
- Amazon Machine Learning (Amazon ML) submitted
a request to evaluate an MLModel
.INPROGRESS
- The evaluation is underway.FAILED
- The request to evaluate an MLModel
did not run to completion. It is not usable.COMPLETED
- The evaluation process completed
successfully.DELETED
- The Evaluation
is marked as
deleted. It is not usable.PerformanceMetrics performanceMetrics
Measurements of how well the MLModel
performed, using
observations referenced by the DataSource
. One of the
following metrics is returned, based on the type of the MLModel:
BinaryAUC: A binary MLModel
uses the Area Under the Curve
(AUC) technique to measure performance.
RegressionRMSE: A regression MLModel
uses the Root Mean
Square Error (RMSE) technique to measure performance. RMSE measures the
difference between predicted and actual values for a single variable.
MulticlassAvgFScore: A multiclass MLModel
uses the F1 score
technique to measure performance.
For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.
String message
A description of the most recent details about evaluating the
MLModel
.
String batchPredictionId
An ID assigned to the BatchPrediction
at creation.
String batchPredictionId
An ID assigned to the BatchPrediction
at creation. This
value should be identical to the value of the
BatchPredictionID
in the request.
String mLModelId
The ID of the MLModel
that generated predictions for the
BatchPrediction
request.
String batchPredictionDataSourceId
The ID of the DataSource
that was used to create the
BatchPrediction
.
String inputDataLocationS3
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
String createdByIamUser
The AWS user account that invoked the BatchPrediction
. The
account type can be either an AWS root account or an AWS Identity and
Access Management (IAM) user account.
Date createdAt
The time when the BatchPrediction
was created. The time is
expressed in epoch time.
Date lastUpdatedAt
The time of the most recent edit to BatchPrediction
. The
time is expressed in epoch time.
String name
A user-supplied name or description of the BatchPrediction
.
String status
The status of the BatchPrediction
, which can be one of the
following values:
PENDING
- Amazon Machine Learning (Amazon ML) submitted
a request to generate batch predictions.INPROGRESS
- The batch predictions are in progress.FAILED
- The request to perform a batch prediction did
not run to completion. It is not usable.COMPLETED
- The batch prediction process completed
successfully.DELETED
- The BatchPrediction
is marked as
deleted. It is not usable.String outputUri
The location of an Amazon S3 bucket or directory to receive the operation results.
String logUri
A link to the file that contains logs of the CreateBatchPrediction operation.
String message
A description of the most recent details about processing the batch prediction request.
String dataSourceId
The ID assigned to the DataSource
at creation. This value
should be identical to the value of the DataSourceId
in the
request.
String dataLocationS3
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
String dataRearrangement
A JSON string that captures the splitting rearrangement requirement of
the DataSource
.
String createdByIamUser
The AWS user account from which the DataSource
was created.
The account type can be either an AWS root account or an AWS Identity and
Access Management (IAM) user account.
Date createdAt
The time that the DataSource
was created. The time is
expressed in epoch time.
Date lastUpdatedAt
The time of the most recent edit to the DataSource
. The time
is expressed in epoch time.
Long dataSizeInBytes
The total size of observations in the data files.
Long numberOfFiles
The number of data files referenced by the DataSource
.
String name
A user-supplied name or description of the DataSource
.
String status
The current status of the DataSource
. This element can have
one of the following values:
PENDING
- Amazon Machine Language (Amazon ML) submitted
a request to create a DataSource
.INPROGRESS
- The creation process is underway.FAILED
- The request to create a DataSource
did not run to completion. It is not usable.COMPLETED
- The creation process completed successfully.
DELETED
- The DataSource
is marked as
deleted. It is not usable.String logUri
A link to the file containining logs of either create
DataSource
operation.
String message
The description of the most recent details about creating the
DataSource
.
RedshiftMetadata redshiftMetadata
RDSMetadata rDSMetadata
String roleARN
Boolean computeStatistics
The parameter is true
if statistics need to be generated
from the observation data.
String dataSourceSchema
The schema used by all of the data files of this DataSource
.
This parameter is provided as part of the verbose format.
String evaluationId
The ID of the Evaluation
to retrieve. The evaluation of each
MLModel
is recorded and cataloged. The ID provides the means
to access the information.
String evaluationId
The evaluation ID which is same as the EvaluationId
in the
request.
String mLModelId
The ID of the MLModel
that was the focus of the evaluation.
String evaluationDataSourceId
The DataSource
used for this evaluation.
String inputDataLocationS3
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
String createdByIamUser
The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.
Date createdAt
The time that the Evaluation
was created. The time is
expressed in epoch time.
Date lastUpdatedAt
The time of the most recent edit to the BatchPrediction
. The
time is expressed in epoch time.
String name
A user-supplied name or description of the Evaluation
.
String status
The status of the evaluation. This element can have one of the following values:
PENDING
- Amazon Machine Language (Amazon ML) submitted
a request to evaluate an MLModel
.INPROGRESS
- The evaluation is underway.FAILED
- The request to evaluate an MLModel
did not run to completion. It is not usable.COMPLETED
- The evaluation process completed
successfully.DELETED
- The Evaluation
is marked as
deleted. It is not usable.PerformanceMetrics performanceMetrics
Measurements of how well the MLModel
performed using
observations referenced by the DataSource
. One of the
following metric is returned based on the type of the
MLModel
:
BinaryAUC: A binary MLModel
uses the Area Under the Curve
(AUC) technique to measure performance.
RegressionRMSE: A regression MLModel
uses the Root Mean
Square Error (RMSE) technique to measure performance. RMSE measures the
difference between predicted and actual values for a single variable.
MulticlassAvgFScore: A multiclass MLModel
uses the F1 score
technique to measure performance.
For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.
String logUri
A link to the file that contains logs of the CreateEvaluation operation.
String message
A description of the most recent details about evaluating the
MLModel
.
String mLModelId
The MLModel ID which is same as the MLModelId
in the
request.
String trainingDataSourceId
The ID of the training DataSource
.
String createdByIamUser
The AWS user account from which the MLModel
was created. The
account type can be either an AWS root account or an AWS Identity and
Access Management (IAM) user account.
Date createdAt
The time that the MLModel
was created. The time is expressed
in epoch time.
Date lastUpdatedAt
The time of the most recent edit to the MLModel
. The time is
expressed in epoch time.
String name
A user-supplied name or description of the MLModel
.
String status
The current status of the MLModel
. This element can have one
of the following values:
PENDING
- Amazon Machine Learning (Amazon ML) submitted
a request to describe a MLModel
.INPROGRESS
- The request is processing.FAILED
- The request did not run to completion. It is
not usable.COMPLETED
- The request completed successfully.DELETED
- The MLModel
is marked as deleted.
It is not usable.Long sizeInBytes
RealtimeEndpointInfo endpointInfo
The current endpoint of the MLModel
com.amazonaws.internal.SdkInternalMap<K,V> trainingParameters
A list of the training parameters in the MLModel
. The list
is implemented as a map of key/value pairs.
The following is the current set of training parameters:
sgd.l1RegularizationAmount
- Coefficient regularization L1
norm. It controls overfitting the data by penalizing large coefficients.
This tends to drive coefficients to zero, resulting in a sparse feature
set. If you use this parameter, specify a small value, such as 1.0E-04 or
1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is
not to use L1 normalization. The parameter cannot be used when
L2
is specified. Use this parameter sparingly.
sgd.l2RegularizationAmount
- Coefficient regularization L2
norm. It controls overfitting the data by penalizing large coefficients.
This tends to drive coefficients to small, nonzero values. If you use
this parameter, specify a small value, such as 1.0E-04 or 1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is
not to use L2 normalization. This parameter cannot be used when
L1
is specified. Use this parameter sparingly.
sgd.maxPasses
- The number of times that the training
process traverses the observations to build the MLModel
. The
value is an integer that ranges from 1 to 10000. The default value is 10.
sgd.maxMLModelSizeInBytes
- The maximum allowed size of the
model. Depending on the input data, the model size might affect
performance.
The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.
String inputDataLocationS3
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
String mLModelType
Identifies the MLModel
category. The following are the
available types:
Float scoreThreshold
The scoring threshold is used in binary classification
MLModel
s, and marks the boundary between a positive
prediction and a negative prediction.
Output values greater than or equal to the threshold receive a positive
result from the MLModel, such as true
. Output values less
than the threshold receive a negative response from the MLModel, such as
false
.
Date scoreThresholdLastUpdatedAt
The time of the most recent edit to the ScoreThreshold
. The
time is expressed in epoch time.
String logUri
A link to the file that contains logs of the CreateMLModel
operation.
String message
Description of the most recent details about accessing the
MLModel
.
String recipe
The recipe to use when training the MLModel
. The
Recipe
provides detailed information about the observation
data to use during training, as well as manipulations to perform on the
observation data during training.
This parameter is provided as part of the verbose format.
String schema
The schema used by all of the data files referenced by the
DataSource
.
This parameter is provided as part of the verbose format.
Integer code
Integer code
Integer code
Integer code
String mLModelId
The ID assigned to the MLModel
at creation.
String trainingDataSourceId
The ID of the training DataSource
. The CreateMLModel
operation uses the TrainingDataSourceId
.
String createdByIamUser
The AWS user account from which the MLModel
was created. The
account type can be either an AWS root account or an AWS Identity and
Access Management (IAM) user account.
Date createdAt
The time that the MLModel
was created. The time is expressed
in epoch time.
Date lastUpdatedAt
The time of the most recent edit to the MLModel
. The time is
expressed in epoch time.
String name
A user-supplied name or description of the MLModel
.
String status
The current status of an MLModel
. This element can have one
of the following values:
MLModel
.MLModel
did not run to
completion. It is not usable.MLModel
is marked as deleted. It is not
usable.Long sizeInBytes
RealtimeEndpointInfo endpointInfo
The current endpoint of the MLModel
.
com.amazonaws.internal.SdkInternalMap<K,V> trainingParameters
A list of the training parameters in the MLModel
. The list
is implemented as a map of key/value pairs.
The following is the current set of training parameters:
sgd.l1RegularizationAmount
- Coefficient regularization L1
norm. It controls overfitting the data by penalizing large coefficients.
This tends to drive coefficients to zero, resulting in a sparse feature
set. If you use this parameter, specify a small value, such as 1.0E-04 or
1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is
not to use L1 normalization. The parameter cannot be used when
L2
is specified. Use this parameter sparingly.
sgd.l2RegularizationAmount
- Coefficient regularization L2
norm. It controls overfitting the data by penalizing large coefficients.
This tends to drive coefficients to small, nonzero values. If you use
this parameter, specify a small value, such as 1.0E-04 or 1.0E-08.
The valus is a double that ranges from 0 to MAX_DOUBLE. The default is
not to use L2 normalization. This cannot be used when L1
is
specified. Use this parameter sparingly.
sgd.maxPasses
- Number of times that the training process
traverses the observations to build the MLModel
. The value
is an integer that ranges from 1 to 10000. The default value is 10.
sgd.maxMLModelSizeInBytes
- Maximum allowed size of the
model. Depending on the input data, the model size might affect
performance.
The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.
String inputDataLocationS3
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
String algorithm
The algorithm used to train the MLModel
. The following
algorithm is supported:
String mLModelType
Identifies the MLModel
category. The following are the
available types:
Float scoreThreshold
Date scoreThresholdLastUpdatedAt
The time of the most recent edit to the ScoreThreshold
. The
time is expressed in epoch time.
String message
A description of the most recent details about accessing the
MLModel
.
com.amazonaws.internal.SdkInternalMap<K,V> properties
String predictedLabel
MLModel
.Float predictedValue
MLModel
.com.amazonaws.internal.SdkInternalMap<K,V> predictedScores
com.amazonaws.internal.SdkInternalMap<K,V> details
String mLModelId
A unique identifier of the MLModel
.
com.amazonaws.internal.SdkInternalMap<K,V> record
String predictEndpoint
Prediction prediction
RDSDatabase databaseInformation
Describes the DatabaseName
and
InstanceIdentifier
of an an Amazon RDS database.
String selectSqlQuery
The query that is used to retrieve the observation data for the
DataSource
.
RDSDatabaseCredentials databaseCredentials
The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.
String s3StagingLocation
The Amazon S3 location for staging Amazon RDS data. The data retrieved
from Amazon RDS using SelectSqlQuery
is stored in this
location.
String dataRearrangement
DataRearrangement - A JSON string that represents the splitting
requirement of a DataSource
.
Sample -
"{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
String dataSchema
A JSON string that represents the schema for an Amazon RDS
DataSource
. The DataSchema
defines the
structure of the observation data in the data file(s) referenced in the
DataSource
.
A DataSchema
is not required if you specify a
DataSchemaUri
Define your DataSchema
as a series of key-value pairs.
attributes
and excludedVariableNames
have an
array of key-value pairs for their value. Use the following format to
define your DataSchema
.
{ "version": "1.0",
"recordAnnotationFieldName": "F1",
"recordWeightFieldName": "F2",
"targetFieldName": "F3",
"dataFormat": "CSV",
"dataFileContainsHeader": true,
"attributes": [
{ "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],
"excludedVariableNames": [ "F6" ] }
String dataSchemaUri
The Amazon S3 location of the DataSchema
.
String resourceRole
The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.
String serviceRole
The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
String subnetId
The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.
com.amazonaws.internal.SdkInternalList<T> securityGroupIds
The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.
RDSDatabase database
The database details required to connect to an Amazon RDS.
String databaseUserName
String selectSqlQuery
The SQL query that is supplied during CreateDataSourceFromRDS.
Returns only if Verbose
is true in
GetDataSourceInput
.
String resourceRole
The role (DataPipelineDefaultResourceRole) assumed by an Amazon EC2 instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
String serviceRole
The role (DataPipelineDefaultRole) assumed by the Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
String dataPipelineId
The ID of the Data Pipeline instance that is used to carry to copy data from Amazon RDS to Amazon S3. You can use the ID to find details about the instance in the Data Pipeline console.
Integer peakRequestsPerSecond
The maximum processing rate for the real-time endpoint for
MLModel
, measured in incoming requests per second.
Date createdAt
The time that the request to create the real-time endpoint for the
MLModel
was received. The time is expressed in epoch time.
String endpointUrl
The URI that specifies where to send real-time prediction requests for
the MLModel
.
The application must wait until the real-time endpoint is ready before using this URI.
String endpointStatus
The current status of the real-time endpoint for the MLModel
. This element can have one of the following values:
RedshiftDatabase databaseInformation
Describes the DatabaseName
and
ClusterIdentifier
for an Amazon Redshift
DataSource
.
String selectSqlQuery
Describes the SQL Query to execute on an Amazon Redshift database for an
Amazon Redshift DataSource
.
RedshiftDatabaseCredentials databaseCredentials
Describes AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon Redshift database.
String s3StagingLocation
Describes an Amazon S3 location to store the result set of the
SelectSqlQuery
query.
String dataRearrangement
Describes the splitting specifications for a DataSource
.
String dataSchema
A JSON string that represents the schema for an Amazon Redshift
DataSource
. The DataSchema
defines the
structure of the observation data in the data file(s) referenced in the
DataSource
.
A DataSchema
is not required if you specify a
DataSchemaUri
.
Define your DataSchema
as a series of key-value pairs.
attributes
and excludedVariableNames
have an
array of key-value pairs for their value. Use the following format to
define your DataSchema
.
{ "version": "1.0",
"recordAnnotationFieldName": "F1",
"recordWeightFieldName": "F2",
"targetFieldName": "F3",
"dataFormat": "CSV",
"dataFileContainsHeader": true,
"attributes": [
{ "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],
"excludedVariableNames": [ "F6" ] }
String dataSchemaUri
Describes the schema location for an Amazon Redshift
DataSource
.
RedshiftDatabase redshiftDatabase
String databaseUserName
String selectSqlQuery
The SQL query that is specified during
CreateDataSourceFromRedshift. Returns only if Verbose
is true in GetDataSourceInput.
Integer code
String dataLocationS3
The location of the data file(s) used by a DataSource
. The
URI specifies a data file or an Amazon Simple Storage Service (Amazon S3)
directory or bucket containing data files.
String dataRearrangement
Describes the splitting requirement of a Datasource
.
String dataSchema
A JSON string that represents the schema for an Amazon S3
DataSource
. The DataSchema
defines the
structure of the observation data in the data file(s) referenced in the
DataSource
.
Define your DataSchema
as a series of key-value pairs.
attributes
and excludedVariableNames
have an
array of key-value pairs for their value. Use the following format to
define your DataSchema
.
{ "version": "1.0",
"recordAnnotationFieldName": "F1",
"recordWeightFieldName": "F2",
"targetFieldName": "F3",
"dataFormat": "CSV",
"dataFileContainsHeader": true,
"attributes": [
{ "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],
"excludedVariableNames": [ "F6" ] }
String dataSchemaLocationS3
Describes the schema Location in Amazon S3.
String batchPredictionId
The ID assigned to the BatchPrediction
during creation. This
value should be identical to the value of the
BatchPredictionId
in the request.
String dataSourceId
The ID assigned to the DataSource
during creation. This
value should be identical to the value of the DataSourceID
in the request.
String evaluationId
The ID assigned to the Evaluation
during creation. This
value should be identical to the value of the Evaluation
in
the request.
String mLModelId
The ID assigned to the MLModel
during creation.
String mLModelName
A user-supplied name or description of the MLModel
.
Float scoreThreshold
The ScoreThreshold
used in binary classification
MLModel
that marks the boundary between a positive
prediction and a negative prediction.
Output values greater than or equal to the ScoreThreshold
receive a positive result from the MLModel
, such as
true
. Output values less than the
ScoreThreshold
receive a negative response from the
MLModel
, such as false
.
String mLModelId
The ID assigned to the MLModel
during creation. This value
should be identical to the value of the MLModelID
in the
request.
String version
StackConfigurationManager configurationManager
String appId
String stackId
String shortname
String name
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> dataSources
String type
Constraints:
Allowed Values: aws-flow-ruby, 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. After you deploy
the app, these variables are defined on the associated app server
instances. For more information, see
Environment Variables. String instanceId
com.amazonaws.internal.ListWithAutoConstructFlag<T> layerIds
Integer instanceCount
Integer thresholdsWaitTime
Constraints:
Range: 1 - 100
Integer ignoreMetricsTime
IgnoreMetricsTime
allows you to direct AWS
OpsWorks to suppress scaling events long enough to get the new
instances online.
Constraints:
Range: 1 - 100
Double cpuThreshold
Double memoryThreshold
Double loadThreshold
com.amazonaws.internal.ListWithAutoConstructFlag<T> alarms
cloudwatch:DescribeAlarms
. You can either have AWS
OpsWorks update the role for you when you first use this feature or
you can edit the role manually. For more information, see Allowing
AWS OpsWorks to Act on Your Behalf.String deviceName
/dev/sdh
. For the root device, you can use the explicit
device name or you can set this parameter to ROOT_DEVICE
and AWS OpsWorks will provide the correct device name.String noDevice
String virtualName
EbsBlockDevice ebs
EBSBlockDevice
that defines how to configure an Amazon
EBS volume when the instance is launched.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 2015.03
, Red
Hat Enterprise Linux 7
, Ubuntu 12.04 LTS
, or
Ubuntu 14.04 LTS
.Microsoft Windows Server
2012 R2 Base
.Custom
. You
specify the custom AMI you want to use when you create instances. For
more information on how to use custom AMIs with OpsWorks, see Using
Custom AMIs.The default option is the parent
stack's operating system. For more information on the supported
operating systems, see AWS
OpsWorks Operating Systems.
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
Europe_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 Attributes
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 agentVersion
LATEST
. AWS OpsWorks automatically installs new agent
versions on the stack's instances as soon as they are available.The default setting is LATEST
. To specify an
agent version, you must use the complete version number, not the
abbreviated number shown on the console. For a list of available agent
version numbers, call DescribeAgentVersions.
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
other
.
Constraints:
Allowed Values: aws-flow-ruby, 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. After you deploy
the app, these variables are defined on the associated app server
instance. For more information, see
Environment Variables. There is no specific limit on the
number of environment variables. However, the size of the associated
data structure - which includes the variables' names, values, and
protected flag values - cannot exceed 10 KB (10240 Bytes). This limit
should accommodate most if not all use cases. Exceeding it will cause
an exception with the message, "Environment: is too large (maximum is
10KB)."
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 Attributes.
String deploymentId
String stackId
com.amazonaws.internal.ListWithAutoConstructFlag<T> layerIds
String instanceType
t2.micro
. For a list of
supported instance types, open the stack in the console, choose
Instances, and choose + Instance. The Size list
contains the currently supported types. For more information, see Instance
Families and Types. The parameter values that you use to specify
the various types are in the API Name column of the
Available Instance Types table.String autoScalingType
Constraints:
Allowed Values: load, timer
String hostname
String os
Amazon Linux 2015.03
, Red
Hat Enterprise Linux 7
, Ubuntu 12.04 LTS
, or
Ubuntu 14.04 LTS
.Microsoft Windows Server
2012 R2 Base
.Custom
.For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
The default option is the current
Amazon Linux version. 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 supported operating systems, see Operating
SystemsFor more information on how to use custom AMIs with AWS
OpsWorks, see Using
Custom AMIs.
String amiId
Os
to Custom
.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
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
BlockDeviceMapping
objects that specify the
instance's block devices. For more information, see Block
Device Mapping.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 by 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 agentVersion
INHERIT
- Use the stack's default agent
version setting.The default setting is
INHERIT
. To specify an agent version, you must use the
complete version number, not the abbreviated number shown on the
console. For a list of available agent version numbers, call
DescribeAgentVersions.
String instanceId
String stackId
String type
Constraints:
Allowed Values: aws-flow-ruby, ecs-cluster, java-app, lb, web, php-app, rails-app, nodejs-app, memcached, db-master, monitoring-master, custom
String name
String shortname
The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference.
Map<K,V> attributes
To create a cluster layer, set the
EcsClusterArn
attribute to the cluster's ARN.
String customInstanceProfileArn
String customJson
com.amazonaws.internal.ListWithAutoConstructFlag<T> customSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> packages
Package
objects that describes 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 by manually running yum
(Amazon Linux)
or apt-get
(Ubuntu) on the instances. To ensure
that your instances have the latest security updates, we strongly
recommend using the default value of true
.
Boolean useEbsOptimizedInstances
LifecycleEventConfiguration lifecycleEventConfiguration
LifeCycleEventConfiguration
object that you can use to
configure the Shutdown event to specify an execution timeout and
enable or disable Elastic Load Balancer connection draining.String layerId
String name
String region
String vpcId
no VPC
.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 2015.03
, Red Hat Enterprise Linux
7
, Ubuntu 12.04 LTS
, or Ubuntu 14.04
LTS
.Microsoft Windows Server 2012 R2
Base
.Custom
. You specify
the custom AMI you want to use when you create instances. For more
information, see
Using Custom AMIs.The default option is the current Amazon Linux version. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
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
Europe_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 Attributes.
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 agentVersion
LATEST
. AWS OpsWorks automatically installs new agent
versions on the stack's instances as soon as they are available.The default setting is LATEST
. To specify an
agent version, you must use the complete version number, not the
abbreviated number shown on the console. For a list of available agent
version numbers, call DescribeAgentVersions.
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 Attributes.
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. Ruby on 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, configure, setup, deploy, rollback, start, stop, restart, undeploy
Map<K,V> args
{"arg_name1" :
["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...],
...}
The update_dependencies
command takes two
arguments:
upgrade_os_to
- Specifies the desired
Amazon Linux version for instances whose OS you want to upgrade, such
as Amazon Linux 2014.09
. You must also set the
allow_reboot
argument to true.allow_reboot
- Specifies whether to allow AWS
OpsWorks to reboot the instances if necessary, after installing the
updates. This argument can be set to either true
or
false
. The default value is false
.For example, to upgrade an instance to Amazon Linux 2014.09,
set Args
to the following. {
"upgrade_os_to":["Amazon Linux 2014.09"], "allow_reboot":["true"] }
String ecsClusterArn
String elasticIp
String instanceId
String rdsDbInstanceArn
String volumeId
String stackId
StackConfigurationManager configurationManager
com.amazonaws.internal.ListWithAutoConstructFlag<T> agentVersions
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.com.amazonaws.internal.ListWithAutoConstructFlag<T> ecsClusterArns
String stackId
DescribeEcsClusters
returns a description of
the cluster that is registered with the stack.String nextToken
NextToken
parameter value
is set to a token. To retrieve the next set of results, call
DescribeEcsClusters
again and assign that token to the
request object's NextToken
parameter. If there are no
remaining results, the previous response object's
NextToken
parameter is set to null
.Integer maxResults
NextToken
value that you can assign to the
NextToken
request parameter to get the next set of
results.com.amazonaws.internal.ListWithAutoConstructFlag<T> ecsClusters
EcsCluster
objects containing the cluster
descriptions.String nextToken
NextToken
parameter to retrieve the next set of
results. If the previous paginated request returned all of the
remaining results, this parameter is set to null
.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.String stackId
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 snapshotId
Integer iops
Integer volumeSize
String volumeType
gp2
for General Purpose (SSD) volumes,
io1
for Provisioned IOPS (SSD) volumes, and
standard
for Magnetic volumes.
Constraints:
Allowed Values: gp2, io1, standard
Boolean deleteOnTermination
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
Integer validForInMinutes
Constraints:
Range: 60 - 1440
TemporaryCredential temporaryCredential
TemporaryCredential
object that contains the data
needed to log in to the instance by RDP clients, such as the Microsoft
Remote Desktop Connection.String agentVersion
INHERIT
if
the instance inherits the default stack setting or to a a version
number for a fixed agent version.String amiId
String architecture
Constraints:
Allowed Values: x86_64, i386
String autoScalingType
Constraints:
Allowed Values: load, timer
String availabilityZone
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
BlockDeviceMapping
objects that specify the
instance's block device mappings.String createdAt
Boolean ebsOptimized
String ec2InstanceId
String ecsClusterArn
String ecsContainerInstanceArn
String elasticIp
String hostname
String infrastructureClass
ec2
or on-premises
.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 by 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.
String instanceId
String instanceProfileArn
String instanceType
t2.micro
.String lastServiceErrorId
com.amazonaws.internal.ListWithAutoConstructFlag<T> layerIds
String os
String platform
String privateDns
String privateIp
String publicDns
String publicIp
String registeredBy
String reportedAgentVersion
ReportedOs reportedOs
String rootDeviceType
Constraints:
Allowed Values: ebs, instance-store
String rootDeviceVolumeId
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
String sshHostDsaKeyFingerprint
String sshHostRsaKeyFingerprint
String sshKeyName
String stackId
String status
booting
connection_lost
online
pending
rebooting
requested
running_setup
setup_failed
shutting_down
start_failed
stopped
stopping
terminated
terminating
String subnetId
String virtualizationType
paravirtual
or
hvm
.
Constraints:
Allowed Values: paravirtual, hvm
Integer assigning
Integer booting
booting
status.Integer connectionLost
connection_lost
status.Integer deregistering
Integer online
online
status.Integer pending
pending
status.Integer rebooting
rebooting
status.Integer registered
Integer registering
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.Integer unassigning
String stackId
String layerId
String type
Constraints:
Allowed Values: aws-flow-ruby, ecs-cluster, java-app, lb, web, php-app, rails-app, nodejs-app, memcached, db-master, monitoring-master, custom
String name
String shortname
Map<K,V> attributes
For the HaproxyStatsPassword
,
MysqlRootPassword
, and GangliaPassword
attributes, AWS OpsWorks returns *****FILTERED*****
instead of the actual value
For an ECS Cluster layer, AWS OpsWorks
the EcsClusterArn
attribute is set to the cluster's ARN.
String customInstanceProfileArn
String customJson
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
LifecycleEventConfiguration lifecycleEventConfiguration
LifeCycleEventConfiguration
object that specifies the
Shutdown event configuration.ShutdownEventConfiguration shutdown
ShutdownEventConfiguration
object that specifies the
Shutdown event configuration.String layerId
Boolean enable
AutoScalingThresholds upScaling
AutoScalingThresholds
object that describes the
upscaling configuration, which defines how and when AWS OpsWorks
increases the number of instances.AutoScalingThresholds downScaling
AutoScalingThresholds
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
*****FILTERED*****
instead of the
actual value.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 ecsClusterArn
String elasticIp
String stackId
String hostname
String publicIp
String privateIp
String rsaPublicKey
String rsaPublicKeyFingerprint
InstanceIdentity instanceIdentity
String instanceId
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.Integer executionTimeout
Boolean delayUntilElbConnectionsDrained
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
Password
to the
appropriate IAM secret access key.Password
to the
password.For more information on how to safely handle IAM credentials, see .
In responses, AWS OpsWorks returns *****FILTERED*****
instead of the actual value.
String sshKey
In responses, AWS OpsWorks
returns *****FILTERED*****
instead of the actual value.
String revision
String stackId
String name
String arn
String region
String vpcId
Map<K,V> attributes
String serviceRoleArn
String defaultInstanceProfileArn
String defaultOs
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 Attributes.
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 agentVersion
LATEST
for
auto-update. or a version number for a fixed agent version.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 username
String password
Integer validForInMinutes
String instanceId
String instanceId
WeeklyAutoScalingSchedule autoScalingSchedule
WeeklyAutoScalingSchedule
object with the instance
schedule.String instanceId
String volumeId
String appId
String name
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> dataSources
String type
Constraints:
Allowed Values: aws-flow-ruby, 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. After you deploy
the app, these variables are defined on the associated app server
instances.For more information, see
Environment Variables. There is no specific limit on the
number of environment variables. However, the size of the associated
data structure - which includes the variables' names, values, and
protected flag values - cannot exceed 10 KB (10240 Bytes). This limit
should accommodate most if not all use cases. Exceeding it will cause
an exception with the message, "Environment: is too large (maximum is
10KB)."
String instanceId
com.amazonaws.internal.ListWithAutoConstructFlag<T> layerIds
String instanceType
t2.micro
. For a list of
supported instance types, open the stack in the console, choose
Instances, and choose + Instance. The Size list
contains the currently supported types. For more information, see Instance
Families and Types. The parameter values that you use to specify
the various types are in the API Name column of the
Available Instance Types table.String autoScalingType
Constraints:
Allowed Values: load, timer
String hostname
String os
Amazon Linux 2015.03
, Red
Hat Enterprise Linux 7
, Ubuntu 12.04 LTS
, or
Ubuntu 14.04 LTS
.Microsoft Windows Server
2012 R2 Base
.Custom
.For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
The default option is the current
Amazon Linux version. If you set this parameter to
Custom
, you must use the AmiId parameter to specify the
custom AMI that you want to use. For more information on the supported
operating systems, see Operating
Systems. For more information on how to use custom AMIs with
OpsWorks, see Using
Custom AMIs.
String amiId
Os
to
Custom
.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 by 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 agentVersion
INHERIT
- Use the stack's default agent
version setting.The default setting is
INHERIT
. To specify an agent version, you must use the
complete version number, not the abbreviated number shown on the
console. For a list of available agent version numbers, call
DescribeAgentVersions.
String layerId
String name
String shortname
The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference
Map<K,V> attributes
String customInstanceProfileArn
String customJson
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
LifecycleEventConfiguration lifecycleEventConfiguration
String sshPublicKey
String stackId
String name
Map<K,V> attributes
String serviceRoleArn
String defaultInstanceProfileArn
String defaultOs
Amazon Linux 2015.03
, Red
Hat Enterprise Linux 7
, Ubuntu 12.04 LTS
, or
Ubuntu 14.04 LTS
.Microsoft Windows Server
2012 R2 Base
.Custom
. You
specify the custom AMI you want to use when you create instances. For
more information on how to use custom AMIs with OpsWorks, see Using
Custom AMIs.The default option is the stack's current operating system. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
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
Europe_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 Attributes.
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
none
. If you specify a key-pair name, AWS OpsWorks
installs the public key on the instance and you can use the private
key with an SSH client to log in to the instance. For more
information, see
Using SSH to Communicate with an Instance and
Managing SSH Access. You can override this setting by specifying a
different key pair, or no key pair, when you
create an instance.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 provide your own custom security groups instead of using the
built-in groups. UseOpsworksSecurityGroups
has the
following settings:
For more information, see Create a New Stack.
String agentVersion
LATEST
. AWS OpsWorks automatically installs new agent
versions on the stack's instances as soon as they are available.The default setting is LATEST
. To specify an
agent version, you must use the complete version number, not the
abbreviated number shown on the console. For a list of available agent
version numbers, call DescribeAgentVersions.
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
standard
- Magneticio1
- Provisioned IOPS (SSD)gp2
- General Purpose (SSD)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 resourceIdentifier
String applyAction
String optInType
immediate
cannot be
undone. Valid values:
immediate
- Apply the
maintenance action immediately.next-maintenance
- Apply the maintenance action during
the next maintenance window for the resource.undo-opt-in
- Cancel any existing
next-maintenance
opt-in requests.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
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 name
String certificateIdentifier
String certificateType
String thumbprint
Date validFrom
Date validTill
String sourceDBClusterSnapshotIdentifier
Constraints:
Example: my-cluster-snapshot1
String targetDBClusterSnapshotIdentifier
Constraints:
Example: my-cluster-snapshot2
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String sourceDBParameterGroupIdentifier
Constraints:
my-db-param-group
, or a valid ARN.arn:aws:rds:us-west-2:123456789012:pg:special-parameters
.String targetDBParameterGroupIdentifier
Constraints:
Example:
my-db-parameter-group
String targetDBParameterGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
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 sourceOptionGroupIdentifier
Constraints:
my-option-group
, or a valid
ARN.arn:aws:rds:us-west-2:123456789012:og:special-options
.String targetOptionGroupIdentifier
Constraints:
Example:
my-option-group
String targetOptionGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBClusterParameterGroupName
Constraints:
String dBParameterGroupFamily
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Integer backupRetentionPeriod
Default: 1
Constraints:
String characterSetName
String databaseName
String dBClusterIdentifier
Constraints:
Example: my-cluster1
String dBClusterParameterGroupName
default.aurora5.6
for the specified engine will be used. Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
String dBSubnetGroupName
String engine
Valid Values: MySQL
String engineVersion
Aurora
Example: 5.6.0
Integer port
Default: 3306
String masterUsername
Constraints:
String masterUserPassword
Constraints: Must contain from 8 to 41 characters.
String optionGroupName
Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.
String preferredBackupWindow
BackupRetentionPeriod
parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
hh24:mi-hh24:mi
.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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBClusterSnapshotIdentifier
Constraints:
Example: my-cluster1-snapshot1
String dBClusterIdentifier
Constraints:
Example:
my-cluster1
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 | db.m3.medium |
db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large |
db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge |
db.t2.micro | db.t2.small | db.t2.medium
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
Constraints:
String storageType
Valid values: standard | gp2 | io1
If you specify
io1
, you must also include a value for the
Iops
parameter.
Default: io1
if the
Iops
parameter is specified; otherwise
standard
String dBName
Type: String
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:
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter is not specified, the default "postgres" database is created in the DB instance.
Constraints:
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
Type: Integer
MySQL
Constraints: Must be an integer from 5 to 6144.
PostgreSQL
Constraints: Must be an integer from 5 to 6144.
Oracle
Constraints: Must be an integer from 10 to 6144.
SQL Server
Constraints: Must be an integer from 200 to 4096 (Standard Edition and Enterprise Edition) or from 20 to 4096 (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 |
db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge |
db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge |
db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
String engine
Valid Values: MySQL
| oracle-se1
|
oracle-se
| oracle-ee
|
sqlserver-ee
| sqlserver-se
|
sqlserver-ex
| sqlserver-web
|
postgres
Not every database engine is available for every AWS region.
String masterUsername
MySQL
Constraints:
Type: String
Oracle
Constraints:
SQL Server
Constraints:
PostgreSQL
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.
PostgreSQL
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. For more information,
see DB
Instance Backups. Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
hh24:mi-hh24:mi
.Integer port
MySQL
Default: 3306
Valid Values:
1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535
except for 1434
, 3389
, 47001
,
49152
, and 49152
through 49156
.
Boolean multiAZ
String engineVersion
The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS region.
MySQL
5.1.73a | 5.1.73b
5.5.40 | 5.5.40a
5.5.40b | 5.5.41 | 5.5.42
5.6.19a |
5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23
MySQL
5.1.73a |
5.1.73b
5.5.40 |
5.5.40a
5.5.40b | 5.5.41 | 5.5.42
5.6.19a | 5.6.19b | 5.6.21 |
5.6.21b | 5.6.22 | 5.6.23
MySQL
5.1.73a | 5.1.73b
5.5.40 | 5.5.40a
5.5.40b |
5.5.41 | 5.5.42
5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 |
5.6.23
MySQL
5.1.73a | 5.1.73b
5.5.40 | 5.5.40a
5.5.40b | 5.5.41 | 5.5.42
5.6.19a |
5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23
Oracle Database Enterprise Edition (oracle-ee)
11.2.0.2.v3 | 11.2.0.2.v4 |
11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
11.2.0.3.v1 | 11.2.0.3.v2
| 11.2.0.4.v1 | 11.2.0.4.v3
12.1.0.1.v1
Oracle Database Enterprise Edition (oracle-ee)
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 |
11.2.0.2.v6 | 11.2.0.2.v7
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.4.v1 |
11.2.0.4.v3
12.1.0.1.v1
Oracle Database Enterprise Edition (oracle-ee)
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 |
11.2.0.2.v6 | 11.2.0.2.v7
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.4.v1 |
11.2.0.4.v3
12.1.0.1.v1
Oracle Database Standard Edition (oracle-se)
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 |
11.2.0.2.v7
11.2.0.3.v1 |
11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3
12.1.0.1.v1
Oracle Database Standard Edition (oracle-se)
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 |
11.2.0.2.v7
11.2.0.3.v1 |
11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3
12.1.0.1.v1
Oracle Database Standard Edition (oracle-se)
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 |
11.2.0.2.v7
11.2.0.3.v1 |
11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3
12.1.0.1.v1
Oracle Database Standard Edition One (oracle-se1)
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 |
11.2.0.2.v7
11.2.0.3.v1 |
11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3
12.1.0.1.v1
Oracle Database Standard Edition One (oracle-se1)
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 |
11.2.0.2.v7
11.2.0.3.v1 |
11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3
12.1.0.1.v1
Oracle Database Standard Edition One (oracle-se1)
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 |
11.2.0.2.v7
11.2.0.3.v1 |
11.2.0.3.v2 | 11.2.0.4.v1 | 11.2.0.4.v3
12.1.0.1.v1
PostgreSQL
9.3.1 |
9.3.2
9.3.3 | 9.3.5 | 9.3.6
9.4.1
PostgreSQL
9.3.1 |
9.3.2
9.3.3 | 9.3.5 | 9.3.6
9.4.1
PostgreSQL
9.3.1 |
9.3.2
9.3.3 | 9.3.5 | 9.3.6
9.4.1
Microsoft SQL Server Enterprise Edition (sqlserver-ee)
10.50.2789.0.v1
11.00.2100.60.v1
Microsoft SQL Server Enterprise Edition (sqlserver-ee)
10.50.2789.0.v1
11.00.2100.60.v1
Microsoft SQL Server Express Edition (sqlserver-ex)
10.50.2789.0.v1
11.00.2100.60.v1
Microsoft SQL Server Express Edition (sqlserver-ex)
10.50.2789.0.v1
11.00.2100.60.v1
Microsoft SQL Server Standard Edition (sqlserver-se)
10.50.2789.0.v1
11.00.2100.60.v1
Microsoft SQL Server Standard Edition (sqlserver-se)
10.50.2789.0.v1
11.00.2100.60.v1
Microsoft SQL Server Web Edition (sqlserver-web)
10.50.2789.0.v1
11.00.2100.60.v1
Microsoft SQL Server Web Edition (sqlserver-web)
10.50.2789.0.v1
11.00.2100.60.v1
Boolean autoMinorVersionUpgrade
Default:
true
String licenseModel
Valid values:
license-included
| bring-your-own-license
|
general-public-license
Integer iops
Constraints: To use PIOPS, this value 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 dBClusterIdentifier
For information on creating a DB cluster, see CreateDBCluster.
Type: String
String storageType
Valid values: standard | gp2 | io1
If you specify
io1
, you must also include a value for the
Iops
parameter.
Default: io1
if the
Iops
parameter is specified; otherwise
standard
String tdeCredentialArn
String tdeCredentialPassword
Boolean storageEncrypted
Default: false
String kmsKeyId
The KMS key identifier is the Amazon Resoure Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted
parameter is true, and
you do not specify a value for the KmsKeyId
parameter,
then Amazon RDS will use your default encryption key. AWS KMS creates
the default encryption key for your AWS account. Your AWS account has
a different default encryption key for each AWS region.
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
Integer allocatedStorage
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Integer backupRetentionPeriod
String characterSetName
String databaseName
String dBClusterIdentifier
String dBClusterParameterGroup
String dBSubnetGroup
String status
String percentProgress
Date earliestRestorableTime
String endpoint
String engine
String engineVersion
Date latestRestorableTime
Integer port
String masterUsername
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBClusterOptionGroupMemberships
String preferredBackupWindow
BackupRetentionPeriod
.String preferredMaintenanceWindow
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBClusterMembers
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroups
String dBInstanceIdentifier
Boolean isClusterWriter
true
if the cluster member is the primary
instance for the DB cluster and false
otherwise.String dBClusterParameterGroupStatus
String dBClusterParameterGroupName
String dBParameterGroupFamily
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
String dBClusterSnapshotIdentifier
String dBClusterIdentifier
Date snapshotCreateTime
String engine
Integer allocatedStorage
String status
Integer port
String vpcId
Date clusterCreateTime
String masterUsername
String engineVersion
String licenseModel
String snapshotType
Integer percentProgress
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, SQL Server, PostgreSQL
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 storageType
String tdeCredentialArn
Integer dbInstancePort
String dBClusterIdentifier
Boolean storageEncrypted
String kmsKeyId
StorageEncrypted
is true, the KMS key identifier for
the encrypted DB instance.String dbiResourceId
StorageEncrypted
is true, the region-unique, immutable
identifier for the encrypted DB instance. This identifier is found in
AWS CloudTrail log entries whenever the KMS key for the DB instance is
accessed.String cACertificateIdentifier
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 sourceDBSnapshotIdentifier
String storageType
String tdeCredentialArn
Boolean encrypted
String kmsKeyId
Encrypted
is true, the KMS key identifier for the
encrypted DB snapshot.String dBSubnetGroupName
String dBSubnetGroupDescription
String vpcId
String subnetGroupStatus
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
String dBClusterParameterGroupName
Constraints:
String dBClusterIdentifier
Constraints:
Boolean skipFinalSnapshot
true
is specified, no DB
cluster snapshot is created. If false
is specified, a DB
cluster snapshot is created before the DB cluster is deleted.
FinalDBSnapshotIdentifier
parameter if SkipFinalSnapshot
is
false
.Default: false
String finalDBSnapshotIdentifier
SkipFinalSnapshot
is set to
false
. SkipFinalShapshot
parameter to true results in an
error. Constraints:
String dBClusterSnapshotIdentifier
Constraints:
Must be the name of an existing DB cluster snapshot in the
available
state.
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. Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true".
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> accountQuotas
String certificateIdentifier
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 can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> certificates
String marker
MaxRecords
.String dBClusterParameterGroupName
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 can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
DescribeDBClusterParameterGroups
request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.String marker
DescribeDBClusterParameterGroups
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> dBClusterParameterGroups
String dBClusterParameterGroupName
Constraints:
String source
engine
,
service
, or customer
.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
DescribeDBClusterParameters
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 dBClusterIdentifier
DBClusterSnapshotIdentifier
parameter. This parameter is
not case-sensitive. Constraints:
String dBClusterSnapshotIdentifier
DBClusterIdentifier
parameter. This value is stored as a
lowercase string. Constraints:
SnapshotType
parameter must also be specified.String snapshotType
automated
or manual
. If this parameter is
not specified, the returned results will include all snapshot types.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
DescribeDBClusterSnapshots
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> dBClusterSnapshots
String dBClusterIdentifier
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 can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
MaxRecords
.String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBClusters
String engine
String engineVersion
Example: 5.1.49
String dBParameterGroupFamily
Constraints:
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
.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 can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
DescribeDBInstances
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> dBInstances
String dBInstanceIdentifier
Constraints:
String filenameContains
Long fileLastWritten
Long fileSize
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
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 can 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
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
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 can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
DescribeDBSecurityGroups
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> 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 can 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 can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
MaxRecords
.String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSubnetGroups
String dBParameterGroupFamily
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
DescribeEngineDefaultClusterParameters
request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.String dBParameterGroupFamily
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
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> filters
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
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> 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
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
.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
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
.com.amazonaws.internal.ListWithAutoConstructFlag<T> orderableDBInstanceOptions
String marker
MaxRecords
.String resourceIdentifier
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Supported filters:
db-instance-id
- Accepts DB instance identifiers and DB
instance Amazon Resource Names (ARNs). The results list will only
include pending maintenance actions for the DB instances identified by
these ARNs.String marker
DescribePendingMaintenanceActions
request. If this
parameter is specified, the response includes only records beyond the
marker, up to a number of records specified by
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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> pendingMaintenanceActions
String marker
DescribePendingMaintenanceActions
request. If this
parameter is specified, the response includes only records beyond the
marker, up to a number of records specified by
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: "Partial Upfront" | "All Upfront" | "No Upfront"
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> reservedDBInstancesOfferings
String reservedDBInstanceId
String reservedDBInstancesOfferingId
String dBInstanceClass
String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
String productDescription
String offeringType
Valid
Values: "Partial Upfront" | "All Upfront" | "No Upfront"
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
If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.
If neither Marker or NumberOfLines are specified, the entire log file is returned.
If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned.
If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.
You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
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 dBClusterIdentifier
Constraints:
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
String resourceName
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
String dBClusterParameterGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
String dBClusterParameterGroupName
Constraints:
String dBClusterIdentifier
Constraints:
String newDBClusterIdentifier
Constraints:
Example: my-cluster2
Boolean applyImmediately
PreferredMaintenanceWindow
setting for the DB cluster. If this parameter is set to
false
, changes to the DB cluster are applied during the
next maintenance window.
Default: false
Integer backupRetentionPeriod
Default: 1
Constraints:
String dBClusterParameterGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Integer port
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
String masterUserPassword
Constraints: Must contain from 8 to 41 characters.
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 cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.
String preferredBackupWindow
BackupRetentionPeriod
parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
hh24:mi-hh24:mi
.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 dBInstanceIdentifier
Constraints:
Integer allocatedStorage
ApplyImmediately
is set to
true
for this request. MySQL
Default: Uses existing setting
Valid Values: 5-6144
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
PostgreSQL
Default: Uses existing setting
Valid Values: 5-6144
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-6144
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 might 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 setting causes an outage during the change and is
applied during the next maintenance window, unless
ApplyImmediately
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 |
db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge |
db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge |
db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
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 set to false
,
changes to the DB instance are applied during the next maintenance
window. Some parameter changes can cause an outage and will be applied
on the next call to RebootDBInstance, or the next failure
reboot. Review the table of parameters in Modifying
a DB Instance and Using the Apply Immediately Parameter to see the
impact that setting ApplyImmediately
to true
or false
has for each modified parameter and to determine
when the changes will be 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
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
parameter. 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. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.
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.
For a list of valid engine versions, see CreateDBInstance.
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. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
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 might 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
Apply
Immediately
to true, or will occur during the next maintenance
window if Apply Immediately
to false. This value is
stored as a lowercase string. Constraints:
String storageType
Valid values: standard | gp2 | io1
If you specify
io1
, you must also include a value for the
Iops
parameter.
Default: io1
if the
Iops
parameter is specified; otherwise
standard
String tdeCredentialArn
String tdeCredentialPassword
String cACertificateIdentifier
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
true
indicates the option
group can be applied to both VPC and non-VPC instances.String vpcId
false
,
this field is blank. If AllowsVpcAndNonVpcInstanceMemberships
is true
and this field is blank, then this option group
can be applied to both VPC and non-VPC instances. If this field
contains a value, then this option group can only be applied to
instances that are in the VPC indicated by this field.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
Boolean supportsStorageEncryption
String storageType
Boolean supportsIops
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 action
Date autoAppliedAfterDate
next-maintenance
opt-in requests are ignored.Date forcedApplyDate
immediate
opt-in requests are ignored.String optInStatus
Date currentApplyDate
AutoAppliedAfterDate
, and the
ForcedApplyDate
. This value is blank if an opt-in request
has not been received and nothing has been specified as
AutoAppliedAfterDate
or ForcedApplyDate
.String description
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 storageType
String cACertificateIdentifier
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. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
hh24:mi-hh24:mi
.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 dBClusterParameterGroupName
Boolean resetAllParameters
true
to reset all parameters in
the DB cluster parameter group to their default values, and
false
otherwise. You cannot use this parameter if there
is a list of parameter names specified for the Parameters
parameter.com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
ResetAllParameters
parameter is set to true
.String dBClusterParameterGroupName
Constraints:
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 resourceIdentifier
com.amazonaws.internal.ListWithAutoConstructFlag<T> pendingMaintenanceActionDetails
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
String dBClusterIdentifier
Constraints:
Example:
my-snapshot-id
String snapshotIdentifier
Constraints:
String engine
Default: The same as source
Constraint: Must be compatible with the engine of the source
String engineVersion
Integer port
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
String dBSubnetGroupName
String databaseName
String optionGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBClusterIdentifier
Constraints:
String sourceDBClusterIdentifier
Constraints:
Date restoreToTime
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
UseLatestRestorableTime
parameter is trueExample: 2015-03-07T23:45:00Z
Boolean useLatestRestorableTime
true
to restore the DB cluster to
the latest restorable backup time, and false
otherwise.
Default: false
Constraints: Cannot be specified if
RestoreToTime
parameter is provided.
Integer port
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
String dBSubnetGroupName
String optionGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBInstanceIdentifier
Constraints:
Example: my-snapshot-id
String dBSnapshotIdentifier
Constraints:
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 |
db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge |
db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge |
db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
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
Valid Values: MySQL
| oracle-se1
| oracle-se
| oracle-ee
|
sqlserver-ee
| sqlserver-se
|
sqlserver-ex
| sqlserver-web
|
postgres
Integer iops
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
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 storageType
Valid values: standard | gp2 | io1
If you specify
io1
, you must also include a value for the
Iops
parameter.
Default: io1
if the
Iops
parameter is specified; otherwise
standard
String tdeCredentialArn
String tdeCredentialPassword
String sourceDBInstanceIdentifier
Constraints:
String targetDBInstanceIdentifier
Constraints:
Date restoreTime
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
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 |
db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge |
db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge |
db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
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
Valid Values: MySQL
| oracle-se1
| oracle-se
| oracle-ee
|
sqlserver-ee
| sqlserver-se
|
sqlserver-ex
| sqlserver-web
|
postgres
Integer iops
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
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 storageType
Valid values: standard | gp2 | io1
If you specify
io1
, you must also include a value for the
Iops
parameter.
Default: io1
if the
Iops
parameter is specified; otherwise
standard
String tdeCredentialArn
String tdeCredentialPassword
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
, major 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
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String kmsKeyId
String parameterGroupName
String parameterGroupFamily
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String parameterGroupName
String parameterApplyStatus
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterParameterStatusList
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
String parameterName
String parameterApplyStatus
The following are possible statuses and descriptions.
in-sync
: The parameter value is
in sync with the database.pending-reboot
: The
parameter value will be applied after the cluster reboots.applying
: The parameter value is being applied to the
database.invalid-parameter
: Cannot apply the
parameter value because it has an invalid value or syntax.apply-deferred
: The parameter contains static
property changes. The changes are deferred until the cluster
reboots.apply-error
: Cannot connect to the
cluster. The parameter change will be applied after the cluster
reboots.unknown-error
: Cannot apply the
parameter change right now. The change will be applied after the
cluster reboots.String parameterApplyErrorDescription
String clusterSecurityGroupName
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> eC2SecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> iPRanges
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String destinationRegion
Long retentionPeriod
String snapshotCopyGrantName
String clusterSubnetGroupName
String description
String vpcId
String subnetGroupStatus
Complete
, Incomplete
and
Invalid
.com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
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: ds1.xlarge
|
ds1.8xlarge
| ds2.xlarge
|
ds2.8xlarge
| dc1.large
|
dc1.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. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
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
, major version upgrades can be applied during the
maintenance window to the Amazon Redshift engine that is running on
the cluster. When a new major 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 Cluster 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 Cluster Management Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String kmsKeyId
String clusterSecurityGroupName
Constraints:
Example:
examplesecuritygroup
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String snapshotIdentifier
Constraints:
Example:
my-snapshot-id
String clusterIdentifier
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String clusterSubnetGroupName
Constraints:
Example:
examplesubnetgroup
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
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.com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String hsmClientCertificateIdentifier
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String hsmConfigurationIdentifier
String description
String hsmIpAddress
String hsmPartitionName
String hsmPartitionPassword
String hsmServerPublicCertificate
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String snapshotCopyGrantName
Constraints:
String kmsKeyId
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String resourceName
arn:aws:redshift:us-east-1:123456789:cluster:t1
.com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Key
and the
corresponding value is passed in with the parameter
Value
. The Key
and Value
parameters are separated by a comma (,). Separate multiple tags with a
space. For example, --tags "Key"="owner","Value"="admin"
"Key"="environment","Value"="test"
"Key"="version","Value"="1.0"
.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 snapshotCopyGrantName
String resourceName
arn:aws:redshift:us-east-1:123456789:cluster:t1
.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
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.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner
and environment
. If
you specify both of these tag keys in the request, Amazon Redshift
returns a response with the parameter groups that have either or both
of these tag keys associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin
and
test
. If you specify both of these tag values in the
request, Amazon Redshift returns a response with the parameter groups
that have either or both of these tag values associated with them.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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner
and environment
. If
you specify both of these tag keys in the request, Amazon Redshift
returns a response with the security groups that have either or both
of these tag keys associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin
and
test
. If you specify both of these tag values in the
request, Amazon Redshift returns a response with the security groups
that have either or both of these tag values associated with them.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
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner
and environment
. If you specify
both of these tag keys in the request, Amazon Redshift returns a
response with the snapshots that have either or both of these tag keys
associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin
and test
. If you
specify both of these tag values in the request, Amazon Redshift
returns a response with the snapshots that have either or both of
these tag values associated with them.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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner
and environment
. If you specify both
of these tag keys in the request, Amazon Redshift returns a response
with the clusters that have either or both of these tag keys
associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin
and test
. If you specify
both of these tag values in the request, Amazon Redshift returns a
response with the clusters that have either or both of these tag
values associated with them.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.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner
and environment
. If you specify
both of these tag keys in the request, Amazon Redshift returns a
response with the subnet groups that have either or both of these tag
keys associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin
and test
. If
you specify both of these tag values in the request, Amazon Redshift
returns a response with the subnet groups that have either or both of
these tag values associated with them.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.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner
and environment
. If
you specify both of these tag keys in the request, Amazon Redshift
returns a response with the HSM client certificates that have either
or both of these tag keys associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin
and
test
. If you specify both of these tag values in the
request, Amazon Redshift returns a response with the HSM client
certificates that have either or both of these tag values associated
with them.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.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner
and environment
. If you
specify both of these tag keys in the request, Amazon Redshift returns
a response with the HSM configurations that have either or both of
these tag keys associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin
and test
. If
you specify both of these tag values in the request, Amazon Redshift
returns a response with the HSM configurations that have either or
both of these tag values associated with them.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 snapshotCopyGrantName
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
DescribeSnapshotCopyGrant
request exceed the value
specified in 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 SnapshotCopyGrantName parameter or the Marker parameter, but not both.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner
and environment
. If you specify both
of these tag keys in the request, Amazon Redshift returns a response
with all resources that have either or both of these tag keys
associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin
and test
. If you specify both of these
tag values in the request, Amazon Redshift returns a response with all
resources that have either or both of these tag values associated with
them.String marker
DescribeSnapshotCopyGrant
request exceed the value
specified in 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 SnapshotCopyGrantName parameter or the Marker parameter, but not both.
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotCopyGrants
String resourceName
arn:aws:redshift:us-east-1:123456789:cluster:t1
.String resourceType
For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.
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.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> tagKeys
owner
and environment
. If you specify both
of these tag keys in the request, Amazon Redshift returns a response
with all resources that have either or both of these tag keys
associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin
and test
. If you specify both of these
tag values in the request, Amazon Redshift returns a response with all
resources that have either or both of these tag values associated with
them.com.amazonaws.internal.ListWithAutoConstructFlag<T> taggedResources
String marker
Marker
parameter and retrying the
command. If the Marker
field is empty, all response
records have been retrieved for the request.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 status
String eC2SecurityGroupName
String eC2SecurityGroupOwnerId
EC2SecurityGroupName
field.com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
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 snapshotCopyGrantName
String sourceIdentifier
String sourceType
Constraints:
Allowed Values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot
String message
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
Values: Configuration, Management, Monitoring, Security
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.com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String hsmClientCertificateIdentifier
String hsmClientCertificatePublicKey
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String hsmConfigurationIdentifier
String description
String hsmIpAddress
String hsmPartitionName
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String hsmClientCertificateIdentifier
String hsmConfigurationIdentifier
String status
Values: active, applying
String status
String cIDRIP
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
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 DescribeResize to track the progress of the resize request.
Valid Values: ds1.xlarge
|
ds1.8xlarge
| ds2.xlarge
|
ds2.8xlarge
| dc1.large
|
dc1.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 parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Example: 1.0
Boolean allowVersionUpgrade
true
, major version 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
String applyType
static
.
Constraints:
Allowed Values: static, dynamic
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
, major version 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. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
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 kmsKeyId
String nodeType
Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds2.xlarge into ds1.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide
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.String kmsKeyId
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> restorableNodeTypes
String snapshotCopyGrantName
String kmsKeyId
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String subnetIdentifier
AvailabilityZone subnetAvailabilityZone
String subnetStatus
Tag tag
String resourceName
arn:aws:redshift:us-east-1:123456789:cluster:t1
.String resourceType
For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.
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 hostedZoneId
Note that you cannot associate a VPC with a hosted zone that doesn't have an existing VPC association.
Constraints:
Length: 0 - 32
VPC vPC
String comment
AssociateVPCWithHostedZoneRequest
.ChangeInfo changeInfo
AssociateVPCWithHostedZoneRequest
.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
- The resource type for health checks is
healthcheck
.
- The resource type for hosted zones is
hostedzone
.
Constraints:
Allowed Values: healthcheck, hostedzone
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
VPC vPC
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
String delegationSetId
Constraints:
Length: 0 - 32
HostedZone hostedZone
ChangeInfo changeInfo
DelegationSet delegationSet
VPC vPC
String location
Constraints:
Length: 0 - 1024
String callerReference
CreateReusableDelegationSet
requests to be retried
without the risk of executing the operation twice. You must use a
unique CallerReference
string every time you create a
reusable delegation set. 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
String hostedZoneId
Constraints:
Length: 0 - 32
DelegationSet delegationSet
String location
Constraints:
Length: 0 - 1024
String id
String callerReference
com.amazonaws.internal.ListWithAutoConstructFlag<T> nameServers
NameServer
that is
assigned to your hosted zone.
Constraints:
Length: 1 -
String healthCheckId
Constraints:
Length: 0 - 64
String id
Constraints:
Length: 0 - 32
ChangeInfo changeInfo
String id
Constraints:
Length: 0 - 32
String hostedZoneId
Note that you cannot disassociate the last VPC from a hosted zone.
Constraints:
Length: 0 - 32
VPC vPC
String comment
DisassociateVPCFromHostedZoneRequest
.ChangeInfo changeInfo
DisassociateVPCFromHostedZoneRequest
.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
com.amazonaws.internal.ListWithAutoConstructFlag<T> healthCheckObservations
HealthCheckObservation
element
for each Route 53 health checker.String healthCheckId
Constraints:
Length: 0 - 64
HealthCheck healthCheck
String healthCheckId
Constraints:
Length: 0 - 64
com.amazonaws.internal.ListWithAutoConstructFlag<T> healthCheckObservations
HealthCheckObservation
element
for each Route 53 health checker.Long hostedZoneCount
String id
Constraints:
Length: 0 - 32
HostedZone hostedZone
DelegationSet delegationSet
com.amazonaws.internal.ListWithAutoConstructFlag<T> vPCs
Constraints:
Length: 1 -
String id
Constraints:
Length: 0 - 32
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, CALCULATED
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
Boolean measureLatency
Boolean inverted
Inverted
is True
, then Route 53 considers
the health check to be unhealthy.Integer healthThreshold
Constraints:
Range: 0 - 256
com.amazonaws.internal.ListWithAutoConstructFlag<T> childHealthChecks
HealthCheckId
values for the associated child health
checks.
Constraints:
Length: 0 - 256
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])$
StatusReport statusReport
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
Boolean privateZone
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 dNSName
ListHostedZonesByNameRequest
request to list.
If the request returned more than one page of results, submit
another request and specify the value of NextDNSName
and
NextHostedZoneId
from the last response in the
DNSName
and HostedZoneId
parameters to get
the next page of results.
Constraints:
Length: 0 - 1024
String hostedZoneId
NextDNSName
and
NextHostedZoneId
from the last response in the
DNSName
and HostedZoneId
parameters to get
the next page of results.
Constraints:
Length: 0 - 32
String maxItems
com.amazonaws.internal.ListWithAutoConstructFlag<T> hostedZones
String dNSName
DNSName
value sent in the request.
Constraints:
Length: 0 - 1024
String hostedZoneId
HostedZoneId
value sent in the request.
Constraints:
Length: 0 - 32
Boolean isTruncated
NextDNSName
and
NextHostedZoneId
elements. Valid Values:
true
| false
String nextDNSName
true
, there are more hosted zones associated with the
current AWS account. To get the next page of results, make another
request to ListHostedZonesByName
. Specify the value of
ListHostedZonesByNameResponse$NextDNSName in the
ListHostedZonesByNameRequest$DNSName element and
ListHostedZonesByNameResponse$NextHostedZoneId in the
ListHostedZonesByNameRequest$HostedZoneId element.
Constraints:
Length: 0 - 1024
String nextHostedZoneId
true
, there are more hosted zones associated with the
current AWS account. To get the next page of results, make another
request to ListHostedZonesByName
. Specify the value of
ListHostedZonesByNameResponse$NextDNSName in the
ListHostedZonesByNameRequest$DNSName element and
ListHostedZonesByNameResponse$NextHostedZoneId in the
ListHostedZonesByNameRequest$HostedZoneId element.
Constraints:
Length: 0 - 32
String maxItems
MaxItems
, the value of
ListHostedZonesByNameResponse$IsTruncated in the response is
true
. Call ListHostedZonesByName
again and
specify the value of ListHostedZonesByNameResponse$NextDNSName
and ListHostedZonesByNameResponse$NextHostedZoneId elements
respectively 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
String delegationSetId
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.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> delegationSets
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
ListReusableDelegationSets
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
ListReusablDelegationSetsResponse$IsTruncated in the response
is true
. Call ListReusableDelegationSets
again and specify the value of
ListReusableDelegationSetsResponse$NextMarker in the
ListReusableDelegationSetsRequest$Marker element to get the
next page of results.String resourceType
- The resource type for health checks is
healthcheck
.
- The resource type for hosted zones is
hostedzone
.
Constraints:
Allowed Values: healthcheck, hostedzone
String resourceId
Constraints:
Length: 0 - 64
ResourceTagSet resourceTagSet
ResourceTagSet
containing tags associated with the
specified resource.String resourceType
- The resource type for health checks is
healthcheck
.
- The resource type for hosted zones is
hostedzone
.
Constraints:
Allowed Values: healthcheck, hostedzone
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, eu-central-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
- The resource type for health checks is
healthcheck
.
- The resource type for hosted zones is
hostedzone
.
Constraints:
Allowed Values: healthcheck, hostedzone
String resourceId
Constraints:
Length: 0 - 64
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Constraints:
Length: 1 - 10
String status
Date checkedTime
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 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
Boolean inverted
Inverted
is True
, then Route 53 considers
the health check to be unhealthy. Specify this value only if you want to change it.
Integer healthThreshold
Specify this value only if you want to change it.
Constraints:
Range: 0 - 256
com.amazonaws.internal.ListWithAutoConstructFlag<T> childHealthChecks
HealthCheckId
values for the associated child health
checks. Specify this value only if you want to change it.
Constraints:
Length: 0 - 256
HealthCheck healthCheck
HostedZone hostedZone
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.DONT_KNOW
??? The TLD registry
didn't reply with a definitive answer about whether the domain name is
available. Amazon Route 53 can return this response for a variety of
reasons, for example, the registry is performing maintenance. Try
again later.
Constraints:
Allowed Values: AVAILABLE, AVAILABLE_RESERVED, AVAILABLE_PREORDER, UNAVAILABLE, UNAVAILABLE_PREMIUM, UNAVAILABLE_RESTRICTED, RESERVED, DONT_KNOW
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
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when they're surrounded by letters, numbers, or other hyphens. You can't specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagsToDelete
Type: A list that contains the keys of the tags that you want to delete.
Default: None
Required: No'>
String domainName
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
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
|
ES_IDENTIFICATION
| ES_IDENTIFICATION_TYPE
|
ES_LEGAL_FORM
| 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, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, 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 domainName
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Type: A complex type containing a list of tags
Each tag includes the following elements.
Key
The key (name) of a tag.
Type: String
Value
The value of a tag.
Type: String
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 key
Type: String
Default: None
Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@"
Constraints: Each key can be 1-128 characters long.
Required: Yes
String value
Type: String
Default: None
Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@"
Constraints: Each value can be 0-256 characters long.
Required: Yes
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
Required: No
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_\-.]*
String fIAuthKey
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 domainName
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when they're surrounded by letters, numbers, or other hyphens. You can't specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagsToUpdate
Type: A complex type containing a list of tags
Default: None
Required: No'>
Each tag includes the following elements:
Key
The key (name) of a tag.
Type: String
Default: None
Valid values: Unicode characters including alphanumeric, space, and ".:/=+\-@"
Constraints: Each key can be 1-128 characters long.
Required: Yes
Value
The value of a tag.
Type: String
Default: None
Valid values: Unicode characters including alphanumeric, space, and ".:/=+\-@"
Constraints: Each value can be 0-256 characters long.
Required: Yes
String extendedRequestId
Map<K,V> additionalDetails
String errorResponseXml
String bucketRegion
PauseStatus status
String assumedRoleId
Constraints:
Length: 2 - 96
Pattern: [\w+=,.@:-]*
String arn
Constraints:
Length: 20 - 2048
String roleArn
Constraints:
Length: 20 - 2048
String roleSessionName
Use the role session name to uniquely identity a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.
Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*
String policy
This 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
intersection of) 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, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity
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
SessionNotOnOrAfter
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
NameID
element in the
Subject
element of the SAML assertion.String subjectType
Format
attribute in the NameID
element of the SAML assertion.
Typical examples of the format are transient
or
persistent
. If the format includes the prefix
urn:oasis:names:tc:SAML:2.0:nameid-format
, that prefix is
removed. For example,
urn:oasis:names:tc:SAML:2.0:nameid-format:transient
is
returned as transient
. If the format includes any other
prefix, the format is returned with no modifications.
String issuer
Issuer
element of the SAML assertion.String audience
Recipient
attribute of the
SubjectConfirmationData
element of the SAML assertion.String nameQualifier
Issuer
response value, the AWS account ID, and the friendly name (the last
part of the ARN) of the SAML provider in IAM. The combination of
NameQualifier
and Subject
can be used to
uniquely identify a federated user. The following pseudocode shows how the hash value is calculated:
BASE64 ( SHA1 (
"https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )
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
Specify this value only for OAuth 2.0 access tokens.
Currently www.amazon.com
and
graph.facebook.com
are the only supported identity
providers for OAuth 2.0 access tokens. Do not include URL schemes and
port numbers.
Do not specify this value for OpenID Connect ID tokens.
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.
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). For OpenID Connect ID tokens, this field contains the
value 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.
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.String headerName
String headerValue
String name
Content text
Content html
String topicArn
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.String smtpReplyCode
String statusCode
String message
String sender
String recipient
String recipientArn
String bounceType
RecipientDsnFields
.
Constraints:
Allowed Values: DoesNotExist, MessageTooLarge, ExceededQuota, ContentRejected, Undefined, TemporaryFailure
RecipientDsnFields recipientDsnFields
BounceType
. You
must provide either this parameter or BounceType
.String name
String ruleSetName
String originalRuleSetName
ReceiptFilter filter
String ruleSetName
String after
ReceiptRule rule
String ruleSetName
String identity
[email protected]
,
example.com
,
arn:aws:ses:us-east-1:123456789012:identity/example.com
.
To successfully call this API, you must own the identity.
String policyName
Constraints:
Length: 1 - 64
String identity
String filterName
String ruleSetName
String emailAddress
ReceiptRuleSetMetadata metadata
com.amazonaws.internal.ListWithAutoConstructFlag<T> rules
ReceiptRule rule
String ruleSetName
ReceiptRuleSetMetadata metadata
com.amazonaws.internal.ListWithAutoConstructFlag<T> rules
com.amazonaws.internal.ListWithAutoConstructFlag<T> toAddresses
com.amazonaws.internal.ListWithAutoConstructFlag<T> ccAddresses
com.amazonaws.internal.ListWithAutoConstructFlag<T> bccAddresses
String name
String value
com.amazonaws.internal.ListWithAutoConstructFlag<T> identities
com.amazonaws.internal.ListWithAutoConstructFlag<T> identities
[email protected]
, example.com
,
arn:aws:ses:us-east-1:123456789012:identity/example.com
.String identity
[email protected]
,
example.com
,
arn:aws:ses:us-east-1:123456789012:identity/example.com
.
To successfully call this API, you must own the identity.
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
ListIdentityPolicies
.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 functionArn
String bucket
String topic
String topicArn
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.String functionArn
arn:aws:lambda:us-west-2:account-id:function:MyFunction
.
For more information about AWS Lambda, see the AWS
Lambda Developer Guide.String invocationType
RequestResponse
means that the execution of the function
will immediately result in a response, and a value of
Event
means that the function will be invoked
asynchronously. The default value is Event
. For
information about AWS Lambda invocation types, see the AWS
Lambda Developer Guide. RequestResponse
invocations. You should use
Event
invocation in most cases. Use
RequestResponse
only when you want to make a mail flow
decision, such as whether to stop the receipt rule or the receipt rule
set.
Constraints:
Allowed Values: Event, RequestResponse
String identityType
Constraints:
Allowed Values: EmailAddress, Domain
String nextToken
Integer maxItems
com.amazonaws.internal.ListWithAutoConstructFlag<T> identities
String nextToken
String identity
[email protected]
, example.com
,
arn:aws:ses:us-east-1:123456789012:identity/example.com
.
To successfully call this API, you must own the identity.
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
String nextToken
ListReceiptRuleSets
to indicate the position in the
receipt rule set list.com.amazonaws.internal.ListWithAutoConstructFlag<T> ruleSets
String nextToken
ListReceiptRuleSets
to retrieve up to 100 receipt rule
sets at a time.com.amazonaws.internal.ListWithAutoConstructFlag<T> verifiedEmailAddresses
String reportingMta
mta-name-type; mta-name
). The default value is
dns; inbound-smtp.[region].amazonaws.com
.Date arrivalDate
com.amazonaws.internal.ListWithAutoConstructFlag<T> extensionFields
String identity
[email protected]
, example.com
,
arn:aws:ses:us-east-1:123456789012:identity/example.com
.
To successfully call this API, you must own the identity.
String policyName
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
Constraints:
Length: 1 - 64
String policy
For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.
Constraints:
Length: 1 -
ByteBuffer data
The To:, CC:, and BCC: headers in the raw message can contain a group list.
If you are using SendRawEmail
with sending
authorization, you can include X-headers in the raw message to specify
the "Source," "From," and "Return-Path" addresses. For more
information, see the documentation for SendRawEmail
.
For more information, go to the Amazon SES Developer Guide.
S3Action s3Action
BounceAction bounceAction
WorkmailAction workmailAction
LambdaAction lambdaAction
StopAction stopAction
AddHeaderAction addHeaderAction
SNSAction sNSAction
String name
ReceiptIpFilter ipFilter
String policy
Constraints:
Allowed Values: Block, Allow
String cidr
String name
Boolean enabled
true
, the receipt rule is active. The default value is
true.String tlsPolicy
Require
, Amazon SES
will bounce emails that are not received over TLS. The default is
Optional
.
Constraints:
Allowed Values: Require, Optional
com.amazonaws.internal.ListWithAutoConstructFlag<T> recipients
com.amazonaws.internal.ListWithAutoConstructFlag<T> actions
Boolean scanEnabled
true
, then messages to which this receipt rule applies
are scanned for spam and viruses. The default value is
true
.String name
Date createdTimestamp
String finalRecipient
Final-Recipient
in the DSN. If not
specified, FinalRecipient
will be set to the
Recipient
specified in the
BouncedRecipientInfo
structure. Either
FinalRecipient
or the recipient in
BouncedRecipientInfo
must be a recipient of the original
bounced message. FinalRecipient
email address with rfc 822;
, as described in RFC 3798.String action
Constraints:
Allowed Values: failed, delayed, delivered, relayed, expanded
String remoteMta
mta-name-type; mta-name
). This parameter typically
applies only to propagating synchronous bounces.String status
String diagnosticCode
Date lastAttemptDate
com.amazonaws.internal.ListWithAutoConstructFlag<T> extensionFields
String ruleSetName
com.amazonaws.internal.ListWithAutoConstructFlag<T> ruleNames
String name
String name
String topicArn
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.String bucketName
String objectKeyPrefix
String kmsKeyArn
arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses
.
For example, if your AWS account ID is 123456789012 and you want to
use the default master key in the US West (Oregon) region, the ARN of
the default master key would be
arn:aws:kms:us-west-2:123456789012:alias/aws/ses
. If you
use the default master key, you don't need to perform any extra steps
to give Amazon SES permission to use the key.For more information about key
policies, see the AWS
KMS Developer Guide. If you do not specify a master key, Amazon
SES will not encrypt your emails.
String originalMessageId
String bounceSender
String explanation
MessageDsn messageDsn
com.amazonaws.internal.ListWithAutoConstructFlag<T> bouncedRecipientInfoList
BouncedRecipientInfo
in the list.String bounceSenderArn
String messageId
Date timestamp
Long deliveryAttempts
Long bounces
Long complaints
Long rejects
String source
If you are sending on behalf of another
user and have been permitted to do so by a sending authorization
policy, then you must also specify the SourceArn
parameter. For more information about sending authorization, see the
Amazon
SES Developer Guide.
In all cases, the email address must be
7-bit ASCII. If the text must contain any other characters, then you
must use MIME encoded-word syntax (RFC 2047) instead of a literal
string. MIME encoded-word syntax uses the following form:
=?charset?encoding?encoded-text?=
. For more information,
see RFC 2047.
Destination destination
Message message
com.amazonaws.internal.ListWithAutoConstructFlag<T> replyToAddresses
String returnPath
ReturnPath
parameter. The
ReturnPath
parameter is never overwritten. This email
address must be either individually verified with Amazon SES, or from
a domain that has been verified with Amazon SES.String sourceArn
Source
parameter. For example, if the owner of
example.com
(which has ARN
arn:aws:ses:us-east-1:123456789012:identity/example.com
)
attaches a policy to it that authorizes you to send from
[email protected]
, then you would specify the
SourceArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com
,
and the Source
to be [email protected]
.
For more information about sending authorization, see the Amazon SES Developer Guide.
String returnPathArn
ReturnPath
parameter. For example, if the owner of
example.com
(which has ARN
arn:aws:ses:us-east-1:123456789012:identity/example.com
)
attaches a policy to it that authorizes you to use
[email protected]
, then you would specify the
ReturnPathArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com
,
and the ReturnPath
to be
[email protected]
.
For more information about sending authorization, see the Amazon SES Developer Guide.
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 fromArn
Instead of using this parameter, you can
use the X-header X-SES-FROM-ARN
in the raw message of the
email. If you use both the FromArn
parameter and the
corresponding X-header, Amazon SES uses the value of the
FromArn
parameter. SendRawEmail
in this guide, or see the Amazon
SES Developer Guide.
String sourceArn
Source
parameter. For example, if the owner of
example.com
(which has ARN
arn:aws:ses:us-east-1:123456789012:identity/example.com
)
attaches a policy to it that authorizes you to send from
[email protected]
, then you would specify the
SourceArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com
,
and the Source
to be [email protected]
.
Instead of using this parameter, you can use the X-header
X-SES-SOURCE-ARN
in the raw message of the email. If you
use both the SourceArn
parameter and the corresponding
X-header, Amazon SES uses the value of the SourceArn
parameter. SendRawEmail
in this guide, or see the
Amazon
SES Developer Guide.
String returnPathArn
ReturnPath
parameter. For example, if the owner of
example.com
(which has ARN
arn:aws:ses:us-east-1:123456789012:identity/example.com
)
attaches a policy to it that authorizes you to use
[email protected]
, then you would specify the
ReturnPathArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com
,
and the ReturnPath
to be
[email protected]
.
Instead of using this parameter,
you can use the X-header X-SES-RETURN-PATH-ARN
in the raw
message of the email. If you use both the ReturnPathArn
parameter and the corresponding X-header, Amazon SES uses the value of
the ReturnPathArn
parameter. SendRawEmail
in this guide, or see the Amazon
SES Developer Guide.
String messageId
SendRawEmail
action.String ruleSetName
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
,
arn:aws:ses:us-east-1:123456789012:identity/example.com
.String notificationType
Constraints:
Allowed Values: Bounce, Complaint, Delivery
String snsTopic
SnsTopic
is cleared and publishing is disabled.String topicArn
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.String scope
Constraints:
Allowed Values: RuleSet
String topicArn
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.String ruleSetName
ReceiptRule rule
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 topicArn
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.String organizationArn
arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7
.
For information about Amazon WorkMail organizations, see the Amazon
WorkMail Administrator Guide.String name
The name of the configuration document.
String instanceId
The ID of the instance.
Date dateValue
The date when the association was made.
AssociationStatus status
The association status.
com.amazonaws.internal.SdkInternalList<T> entries
One or more associations.
com.amazonaws.internal.SdkInternalList<T> successful
Information about the associations that succeeded.
com.amazonaws.internal.SdkInternalList<T> failed
Information about the associations that failed.
AssociationDescription associationDescription
Information about the association.
String content
A valid JSON file. For more information about the contents of this file, see Configuration Document.
String name
A name for the configuration document.
DocumentDescription documentDescription
Information about the configuration document.
String name
The name of the configuration document.
AssociationDescription associationDescription
Information about the association.
String name
The name of the configuration document.
DocumentDescription document
Information about the configuration document.
String name
The name of the configuration document.
CreateAssociationBatchRequestEntry entry
The association.
String message
A description of the failure.
String fault
The source of the failure.
String name
The name of the configuration document.
com.amazonaws.internal.SdkInternalList<T> associationFilterList
One or more filters. Use a filter to return a more specific list of results.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> associations
The associations.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
com.amazonaws.internal.SdkInternalList<T> documentFilterList
One or more filters. Use a filter to return a more specific list of results.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> documentIdentifiers
The names of the configuration documents.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String name
The name of the configuration document.
String instanceId
The ID of the instance.
AssociationStatus associationStatus
The association status.
AssociationDescription associationDescription
Information about the association.
String details
ActivityType activityType
String activityId
String details
ActivityTaskTimeoutType timeoutType
String details
WorkflowExecution workflowExecution
WorkflowType workflowType
String details
String key
String detail
LambdaFunctionTimeoutType timeoutType
ScheduleActivityTaskFailedCause failureCause
ScheduleLambdaFunctionFailedCause 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 chain of events leading up to this event.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
String taskPriority
Valid values are
integers that range from Java's Integer.MIN_VALUE
(-2147483648) to Integer.MAX_VALUE
(2147483647). Higher
numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
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 duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String defaultTaskHeartbeatTimeout
You can specify this value only
when registering an activity type. The registered default value
can be overridden when you schedule a task through the
ScheduleActivityTask
decision. If the activity worker
subsequently attempts to record a heartbeat or returns a result, the
activity worker receives an UnknownResource
fault. In
this case, Amazon SWF no longer considers the activity task to be
valid; the activity worker should clean up the activity task.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList defaultTaskList
ScheduleActivityTask
decision. You can override the
default registered task list when scheduling a task through the
ScheduleActivityTask
decision.String defaultTaskPriority
Valid values are integers that range from Java's
Integer.MIN_VALUE
(-2147483648) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate
higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
String defaultTaskScheduleToStartTimeout
ScheduleActivityTask
decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String defaultTaskScheduleToCloseTimeout
ScheduleActivityTask
decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "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
NextPageToken
was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken
.
Keep all other arguments unchanged. The configured
maximumPageSize
determines how many results can be
returned in a single call.
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 chain of events leading up to
this event.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 chain of events leading up to this event.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 chain of events leading up to this event.String input
Constraints:
Length: 0 - 32768
String executionStartToCloseTimeout
defaultExecutionStartToCloseTimeout
specified when registering the workflow type. The duration is
specified in seconds; an integer greater than or equal to 0. The value
"NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList taskList
String taskPriority
Integer.MIN_VALUE
(-2147483648) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
String taskStartToCloseTimeout
defaultTaskStartToCloseTimout
specified when registering
the workflow type using RegisterWorkflowType. The duration
is specified in seconds; an integer greater than or equal to 0. The
value "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
String workflowTypeVersion
String lambdaRole
Constraints:
Length: 1 - 1224
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, CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED, 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 chain of events leading up to this event.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, ScheduleLambdaFunction
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.ScheduleLambdaFunctionDecisionAttributes scheduleLambdaFunctionDecisionAttributes
ScheduleLambdaFunction
decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource
element with the domain name to limit the action
to only specified domains.Action
element
to allow or deny permission to call this action.Condition
element
with the appropriate keys. activityType.name
:
String constraint. The key is swf:activityType.name
.activityType.version
: String constraint. The key is
swf:activityType.version
.taskList
:
String constraint. The key is swf:taskList.name
.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
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
NextPageToken
was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken
.
Keep all other arguments unchanged. The configured
maximumPageSize
determines how many results can be
returned in a single call.
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 taskPriority
Integer.MIN_VALUE
(-2147483648) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
String startToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "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
name
and version
that were
supplied when the activity was registered.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
NextPageToken
was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken
.
Keep all other arguments unchanged. The configured
maximumPageSize
determines how many results can be
returned in a single call.
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 chain of events leading up to this event.String domain
Constraints:
Length: 1 - 256
WorkflowExecution execution
String nextPageToken
NextPageToken
was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken
.
Keep all other arguments unchanged. The configured
maximumPageSize
determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
Integer maximumPageSize
nextPageToken
can be used to obtain futher pages of
results. The default is 1000, which is the maximum allowed page size.
You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
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
NextPageToken
was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken
.
Keep all other arguments unchanged. The configured
maximumPageSize
determines how many results can be
returned in a single call.
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, LambdaFunctionScheduled, LambdaFunctionStarted, LambdaFunctionCompleted, LambdaFunctionFailed, LambdaFunctionTimedOut, ScheduleLambdaFunctionFailed, StartLambdaFunctionFailed
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.LambdaFunctionScheduledEventAttributes lambdaFunctionScheduledEventAttributes
LambdaFunctionScheduled
event.LambdaFunctionStartedEventAttributes lambdaFunctionStartedEventAttributes
LambdaFunctionStarted
event.LambdaFunctionCompletedEventAttributes lambdaFunctionCompletedEventAttributes
LambdaFunctionCompleted
event.LambdaFunctionFailedEventAttributes lambdaFunctionFailedEventAttributes
LambdaFunctionFailed
event.LambdaFunctionTimedOutEventAttributes lambdaFunctionTimedOutEventAttributes
LambdaFunctionTimedOut
event.ScheduleLambdaFunctionFailedEventAttributes scheduleLambdaFunctionFailedEventAttributes
ScheduleLambdaFunctionFailed
event.StartLambdaFunctionFailedEventAttributes startLambdaFunctionFailedEventAttributes
StartLambdaFunctionFailed
event.Long scheduledEventId
LambdaFunctionScheduled
event that was
recorded when this AWS Lambda function was scheduled. This information
can be useful for diagnosing problems by tracing back the chain of
events leading up to this event.Long startedEventId
LambdaFunctionStarted
event recorded in the
history.String result
Constraints:
Length: 0 - 32768
Long scheduledEventId
LambdaFunctionScheduled
event that was
recorded when this AWS Lambda function was scheduled. This information
can be useful for diagnosing problems by tracing back the chain of
events leading up to this event.Long startedEventId
LambdaFunctionStarted
event recorded in the
history.String reason
Constraints:
Length: 0 - 256
String details
Constraints:
Length: 0 - 32768
String id
Constraints:
Length: 1 - 256
String name
Constraints:
Length: 1 - 64
String input
Constraints:
Length: 1 - 32768
String startToCloseTimeout
Constraints:
Length: 0 - 8
Long decisionTaskCompletedEventId
DecisionTaskCompleted
event for the
decision that resulted in the scheduling of this AWS Lambda function.
This information can be useful for diagnosing problems by tracing back
the chain of events leading up to this event.Long scheduledEventId
LambdaFunctionScheduled
event that was
recorded when this AWS Lambda function was scheduled. This information
can be useful for diagnosing problems by tracing back the chain of
events leading up to this event.Long scheduledEventId
LambdaFunctionScheduled
event that was
recorded when this AWS Lambda function was scheduled. This information
can be useful for diagnosing problems by tracing back the chain of
events leading up to this event.Long startedEventId
LambdaFunctionStarted
event recorded in the
history.String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE
String domain
Constraints:
Length: 1 - 256
String name
Constraints:
Length: 1 - 256
String registrationStatus
Constraints:
Allowed Values: REGISTERED, DEPRECATED
String nextPageToken
NextPageToken
was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken
.
Keep all other arguments unchanged. The configured
maximumPageSize
determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
Integer maximumPageSize
nextPageToken
can be used to obtain futher pages of
results. The default is 1000, which is the maximum allowed page size.
You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Constraints:
Range: 0 - 1000
Boolean reverseOrder
true
, returns the results in reverse order.
By default, the results are returned in ascending alphabetical order
by 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 by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken
.
Keep all other arguments unchanged. The configured
maximumPageSize
determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
Integer maximumPageSize
nextPageToken
can be used to obtain futher pages of
results. The default is 1000, which is the maximum allowed page size.
You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
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 by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken
.
Keep all other arguments unchanged. The configured
maximumPageSize
determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
String registrationStatus
Constraints:
Allowed Values: REGISTERED, DEPRECATED
Integer maximumPageSize
nextPageToken
can be used to obtain futher pages of
results. The default is 1000, which is the maximum allowed page size.
You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Constraints:
Range: 0 - 1000
Boolean reverseOrder
true
, returns the results in reverse order.
By default, the results are returned in ascending alphabetical order
by 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 by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken
.
Keep all other arguments unchanged. The configured
maximumPageSize
determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
Integer maximumPageSize
nextPageToken
can be used to obtain futher pages of
results. The default is 1000, which is the maximum allowed page size.
You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
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 by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken
.
Keep all other arguments unchanged. The configured
maximumPageSize
determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
Integer maximumPageSize
nextPageToken
can be used to obtain futher pages of
results. The default is 1000, which is the maximum allowed page size.
You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
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 chain of events leading up
to this event.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 by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken
.
Keep all other arguments unchanged. The configured
maximumPageSize
determines how many results can be
returned in a single call. 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
nextPageToken
can be used to obtain futher pages of
results. The default is 1000, which is the maximum allowed page size.
You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
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 chain of events leading up to this event.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 duration is specified in seconds; an integer greater than or equal to 0. The value "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 duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList defaultTaskList
ScheduleActivityTask
decision.String defaultTaskPriority
Integer.MIN_VALUE
(-2147483648) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
String defaultTaskScheduleToStartTimeout
ScheduleActivityTask
decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String defaultTaskScheduleToCloseTimeout
ScheduleActivityTask
decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value "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
If you pass the value
NONE
or 0
(zero), then the workflow
execution history will not be retained. As soon as the workflow
execution completes, the execution record and its history are deleted.
The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.
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 duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String defaultExecutionStartToCloseTimeout
StartChildWorkflowExecution
decision. The duration is
specified in seconds; an integer 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 defaultTaskPriority
Integer.MIN_VALUE
(-2147483648) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
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 defaultLambdaRole
This default can be
overridden when starting a workflow execution using the
StartWorkflowExecution action or the
StartChildWorkflowExecution
and
ContinueAsNewWorkflowExecution
decision.
Constraints:
Length: 1 - 1224
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 chain of events leading up to this event.String workflowId
workflowId
of the external workflow
execution to cancel.
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 chain of events leading up to this event.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 chain 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 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.
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 duration is
specified in seconds; an integer greater than or equal to 0. The value
"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 taskPriority
Integer.MIN_VALUE
(-2147483648) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
String scheduleToStartTimeout
The duration is specified in
seconds; an integer greater than or equal to 0. The value "NONE" can
be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String startToCloseTimeout
The duration is specified in seconds;
an integer greater than or equal to 0. The value "NONE" can be used to
specify unlimited duration.
Constraints:
Length: 0 - 8
String heartbeatTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "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 id
id
of the AWS Lambda task.
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 name
Constraints:
Length: 1 - 64
String input
Constraints:
Length: 1 - 32768
String startToCloseTimeout
Constraints:
Length: 0 - 8
String id
Constraints:
Length: 1 - 256
String name
Constraints:
Length: 1 - 64
String cause
Constraints:
Allowed Values: ID_ALREADY_IN_USE, OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED, LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED, LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION
Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision that resulted in the scheduling of this AWS Lambda
function. 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.
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 chain 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 chain 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. 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 duration is specified in seconds; an integer
greater than or equal to 0. The value "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 taskPriority
Integer.MIN_VALUE
(-2147483648) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
String taskStartToCloseTimeout
defaultTaskStartToCloseTimout
specified when registering
the workflow type using RegisterWorkflowType. The duration
is specified in seconds; an integer greater than or equal to 0. The
value "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
String lambdaRole
Constraints:
Length: 1 - 1224
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 duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList taskList
String taskPriority
Integer.MIN_VALUE
(-2147483648) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
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 duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
String lambdaRole
Constraints:
Length: 1 - 1224
Long scheduledEventId
LambdaFunctionScheduled
event that was
recorded when this AWS Lambda function was scheduled. 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: ASSUME_ROLE_FAILED
String message
Constraints:
Length: 0 - 1728
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; an integer 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 chain of events leading up to
this event.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 taskPriority
Integer.MIN_VALUE
(-2147483648) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
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; an integer
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 duration
is specified in seconds; an integer greater than or equal to 0. The
value "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
String lambdaRole
Constraints:
Length: 1 - 1224
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
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 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 chain of events leading up to
this event.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; an integer 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 chain of events leading up to
this event.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 chain of events leading up to this event.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 chain of events leading up to this event.String taskStartToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 1 - 8
String executionStartToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 1 - 8
TaskList taskList
String taskPriority
Integer.MIN_VALUE
(-2147483648) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
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 lambdaRole
Constraints:
Length: 1 - 1224
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 chain of events leading up to this event.String newExecutionRunId
runId
of the new workflow execution.
Constraints:
Length: 1 - 64
String executionStartToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList taskList
String taskPriority
String taskStartToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "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
String lambdaRole
Constraints:
Length: 1 - 1224
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 chain of events leading up to this event.String workflowId
Constraints:
Length: 1 - 256
WorkflowExecution execution
WorkflowType workflowType
Date startTimestamp
Date closeTimestamp
String executionStatus
Constraints:
Allowed Values: OPEN, CLOSED
String closeStatus
COMPLETED
: the execution
was successfully completed.CANCELED
: the
execution was canceled.Cancellation allows the implementation to
gracefully clean up before the execution is closed.TERMINATED
: the execution was force terminated.FAILED
: the execution failed to complete.TIMED_OUT
: the execution did not complete in the
alloted time and was automatically timed out.CONTINUED_AS_NEW
: the execution is logically
continued. This means the current execution was completed and a new
execution was started to carry on the workflow.
Constraints:
Allowed Values: COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT
WorkflowExecution parent
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
Boolean cancelRequested
com.amazonaws.internal.ListWithAutoConstructFlag<T> executionInfos
String nextPageToken
NextPageToken
was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken
.
Keep all other arguments unchanged. The configured
maximumPageSize
determines how many results can be
returned in a single call.
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 -
Integer openLambdaFunctions
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 duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String taskStartToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "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
TaskList taskList
WorkflowType workflowType
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
String taskPriority
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 lambdaRole
Constraints:
Length: 1 - 1224
String reason
Constraints:
Length: 0 - 256
String details
Constraints:
Length: 0 - 32768
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 cause
Constraints:
Allowed Values: CHILD_POLICY_APPLIED, EVENT_LIMIT_EXCEEDED, OPERATOR_INITIATED
String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE
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 name
Constraints:
Length: 1 - 256
String version
Constraints:
Length: 1 - 64
String defaultTaskStartToCloseTimeout
StartChildWorkflowExecution
decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String defaultExecutionStartToCloseTimeout
StartChildWorkflowExecution
decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList defaultTaskList
StartChildWorkflowExecution
decision.String defaultTaskPriority
StartChildWorkflowExecution
decision. Valid values are
integers that range from Java's Integer.MIN_VALUE
(-2147483648) to Integer.MAX_VALUE
(2147483647). Higher
numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
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 defaultLambdaRole
Constraints:
Length: 1 - 1224
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
NextPageToken
was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken
.
Keep all other arguments unchanged. The configured
maximumPageSize
determines how many results can be
returned in a single call.
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
AWS policy. For more information about policy structure, see Overview
of AWS IAM Policies in the Amazon IAM User Guide.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
PurgeQueue
API.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 from the queue
(epoch time in milliseconds).ApproximateReceiveCount
- returns the number of times
a message has been received from the queue but not deleted.SenderId
- 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 to the queue (epoch time in milliseconds).com.amazonaws.internal.ListWithAutoConstructFlag<T> messageAttributeNames
When using ReceiveMessage
, you can send a
list of attribute names to receive, or you can return all of the
attributes by specifying "All" or ".*" in your request. You can also
use "foo.*" to return all message attributes starting with the "foo"
prefix.
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
AWS policy. For more information about policy structure, see Overview
of AWS IAM Policies in the Amazon IAM User Guide.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", "eu-central-1", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2", "sa-east-1"
Constraints:
Length: 1 - 25
String gatewayType
STORED
.
Constraints:
Length: 2 - 20
String tapeDriveType
Valid Values: "IBM-ULT3580-TD5"
Constraints:
Length: 2 - 50
String mediumChangerType
Valid Values: "STK-L700", "AWS-Gateway-VTL"
Constraints:
Length: 2 - 50
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 resourceARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : /
String resourceARN
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: 1 - 100
String initiatorName
Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+
String secretToAuthenticateTarget
Constraints:
Length: 1 - 100
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
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 (for example, the 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 gatewayName
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 lastSoftwareUpdate
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
String gatewayName
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 resourceARN
Constraints:
Length: 50 - 500
String marker
Constraints:
Length: 1 - 1000
Integer limit
Constraints:
Range: 1 -
String resourceARN
Constraints:
Length: 50 - 500
String marker
Constraints:
Length: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String volumeARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> initiators
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 resourceARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
String resourceARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
String tapeARN
Constraints:
Length: 50 - 500
String gatewayARN
You retrieve archived virtual tapes to only one gateway and the gateway must be a gateway-VTL.
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: 7 - 16
Pattern: ^[A-Z0-9]*$
Long tapeSizeInBytes
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: 7 - 16
Pattern: ^[A-Z0-9]*$
Long tapeSizeInBytes
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
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: 1 - 100
String initiatorName
Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+
String secretToAuthenticateTarget
Byte constraints:
Minimum bytes of 12. Maximum bytes of 16.
Constraints:
Length: 1 - 100
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 gatewayName
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 vTLDeviceARN
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
The ID of the attachment set. If an AttachmentSetId
is not
specified, a new attachment set is created, and the ID of the set is
returned in the response. If an AttachmentSetId
is
specified, the attachments are added to the specified set, if it exists.
com.amazonaws.internal.SdkInternalList<T> attachments
One or more attachments to add to the set. The limit is 3 attachments per set, and the size limit is 5 MB per attachment.
String attachmentSetId
The ID of the attachment set. If an AttachmentSetId
was not
specified, a new attachment set is created, and the ID of the set is
returned in the response. If an AttachmentSetId
was
specified, the attachments are added to the specified set, if it exists.
String expiryTime
The time and date when the attachment set expires.
String caseId
The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
String communicationBody
The body of an email communication to add to the support case.
com.amazonaws.internal.SdkInternalList<T> ccEmailAddresses
The email addresses in the CC line of an email to be added to the support case.
String attachmentSetId
The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling AddAttachmentsToSet
Boolean result
True if AddCommunicationToCase succeeds. Otherwise, returns an error.
String fileName
The name of the attachment file.
ByteBuffer data
The content of the attachment file.
String caseId
The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
String displayId
The ID displayed for the case in the AWS Support Center. This is a numeric string.
String subject
The subject line for the case in the AWS Support Center.
String status
The status of the case.
String serviceCode
The code for the AWS service returned by the call to DescribeServices.
String categoryCode
The category of problem for the AWS Support case.
String severityCode
The code for the severity level returned by the call to DescribeSeverityLevels.
String submittedBy
The email address of the account that submitted the case.
String timeCreated
The time that the case was case created in the AWS Support Center.
RecentCaseCommunications recentCommunications
The five most recent communications between you and AWS Support Center,
including the IDs of any attachments to the communications. Also includes
a nextToken
that you can use to retrieve earlier
communications.
com.amazonaws.internal.SdkInternalList<T> ccEmailAddresses
The email addresses that receive copies of communication about the case.
String language
The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
String caseId
The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
String body
The text of the communication between the customer and AWS Support.
String submittedBy
The email address of the account that submitted the AWS Support case.
String timeCreated
The time the communication was created.
com.amazonaws.internal.SdkInternalList<T> attachmentSet
Information about the attachments to the case communication.
String subject
The title of the AWS Support case.
String serviceCode
The code for the AWS service returned by the call to DescribeServices.
String severityCode
The code for the severity level returned by the call to DescribeSeverityLevels.
The availability of severity levels depends on each customer's support subscription. In other words, your subscription may not necessarily require the urgent level of response time.
String categoryCode
The category of problem for the AWS Support case.
String communicationBody
The communication body text when you create an AWS Support case by calling CreateCase.
com.amazonaws.internal.SdkInternalList<T> ccEmailAddresses
A list of email addresses that AWS Support copies on case correspondence.
String language
The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
String issueType
The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical."
String attachmentSetId
The ID of a set of one or more attachments for the case. Create the set by using AddAttachmentsToSet.
String caseId
The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
String attachmentId
The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.
Attachment attachment
The attachment content and file name.
com.amazonaws.internal.SdkInternalList<T> caseIdList
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
String displayId
The ID displayed for a case in the AWS Support Center user interface.
String afterTime
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
String beforeTime
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
Boolean includeResolvedCases
Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
String nextToken
A resumption point for pagination.
Integer maxResults
The maximum number of results to return before paginating.
String language
The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
Boolean includeCommunications
Specifies whether communications should be included in the DescribeCases results. The default is true.
com.amazonaws.internal.SdkInternalList<T> cases
The details for the cases that match the request.
String nextToken
A resumption point for pagination.
String caseId
The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
String beforeTime
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
String afterTime
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
String nextToken
A resumption point for pagination.
Integer maxResults
The maximum number of results to return before paginating.
com.amazonaws.internal.SdkInternalList<T> communications
The communications for the case.
String nextToken
A resumption point for pagination.
com.amazonaws.internal.SdkInternalList<T> serviceCodeList
A JSON-formatted list of service codes available for AWS services.
String language
The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
com.amazonaws.internal.SdkInternalList<T> services
A JSON-formatted list of AWS services.
String language
The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
com.amazonaws.internal.SdkInternalList<T> severityLevels
The available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS.
com.amazonaws.internal.SdkInternalList<T> checkIds
The IDs of the Trusted Advisor checks.
com.amazonaws.internal.SdkInternalList<T> statuses
The refresh status of the specified Trusted Advisor checks.
String checkId
The unique identifier for the Trusted Advisor check.
String language
The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
TrustedAdvisorCheckResult result
The detailed results of the Trusted Advisor check.
String language
The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
com.amazonaws.internal.SdkInternalList<T> checks
Information about all available Trusted Advisor checks.
com.amazonaws.internal.SdkInternalList<T> checkIds
The IDs of the Trusted Advisor checks.
com.amazonaws.internal.SdkInternalList<T> summaries
The summary information for the requested Trusted Advisor checks.
com.amazonaws.internal.SdkInternalList<T> communications
The five most recent communications associated with the case.
String nextToken
A resumption point for pagination.
String checkId
The unique identifier for the Trusted Advisor check.
TrustedAdvisorCheckRefreshStatus status
The current refresh status for a check, including the amount of time until the check is eligible for refresh.
String caseId
The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
String initialCaseStatus
The status of the case when the ResolveCase request was sent.
String finalCaseStatus
The status of the case after the ResolveCase request was processed.
String code
The code for an AWS service returned by the DescribeServices
response. The Name
element contains the corresponding
friendly name.
String name
The friendly name for an AWS service. The Code
element
contains the corresponding code.
com.amazonaws.internal.SdkInternalList<T> categories
A list of categories that describe the type of support issue a case describes. Categories consist of a category name and a category code. Category names and codes are passed to AWS Support when you call CreateCase.
TrustedAdvisorCostOptimizingSummary costOptimizing
The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.
String id
The unique identifier for the Trusted Advisor check.
String name
The display name for the Trusted Advisor check.
String description
The description of the Trusted Advisor check, which includes the alert criteria and recommended actions (contains HTML markup).
String category
The category of the Trusted Advisor check.
com.amazonaws.internal.SdkInternalList<T> metadata
The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail for the check. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.
String checkId
The unique identifier for the Trusted Advisor check.
String status
The status of the Trusted Advisor check for which a refresh has been requested: "none", "enqueued", "processing", "success", or "abandoned".
Long millisUntilNextRefreshable
The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.
String checkId
The unique identifier for the Trusted Advisor check.
String timestamp
The time of the last refresh of the check.
String status
The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
TrustedAdvisorResourcesSummary resourcesSummary
TrustedAdvisorCategorySpecificSummary categorySpecificSummary
Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
com.amazonaws.internal.SdkInternalList<T> flaggedResources
The details about each resource listed in the check result.
String checkId
The unique identifier for the Trusted Advisor check.
String timestamp
The time of the last refresh of the check.
String status
The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
Boolean hasFlaggedResources
Specifies whether the Trusted Advisor check has flagged resources.
TrustedAdvisorResourcesSummary resourcesSummary
TrustedAdvisorCategorySpecificSummary categorySpecificSummary
Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
Double estimatedMonthlySavings
The estimated monthly savings that might be realized if the recommended actions are taken.
Double estimatedPercentMonthlySavings
The estimated percentage of savings that might be realized if the recommended actions are taken.
String status
The status code for the resource identified in the Trusted Advisor check.
String region
The AWS region in which the identified resource is located.
String resourceId
The unique identifier for the identified resource.
Boolean isSuppressed
Specifies whether the AWS resource was ignored by Trusted Advisor because it was marked as suppressed by the user.
com.amazonaws.internal.SdkInternalList<T> metadata
Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the TrustedAdvisorCheckDescription object returned by the call to DescribeTrustedAdvisorChecks. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.
Long resourcesProcessed
The number of AWS resources that were analyzed by the Trusted Advisor check.
Long resourcesFlagged
The number of AWS resources that were flagged (listed) by the Trusted Advisor check.
Long resourcesIgnored
The number of AWS resources ignored by Trusted Advisor because information was unavailable.
Long resourcesSuppressed
The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user.
String name
The name of the compute type for the bundle.
com.amazonaws.internal.SdkInternalList<T> workspaces
An array of structures that specify the WorkSpaces to create.
com.amazonaws.internal.SdkInternalList<T> failedRequests
An array of structures that represent the WorkSpaces that could not be created.
com.amazonaws.internal.SdkInternalList<T> pendingRequests
An array of structures that represent the WorkSpaces that were created.
Because this operation is asynchronous, the identifier in
WorkspaceId
is not immediately available. If you immediately
call DescribeWorkspaces with this identifier, no information will
be returned.
Boolean enableWorkDocs
Specifies if the directory is enabled for Amazon WorkDocs.
Boolean enableInternetAccess
A public IP address will be attached to all WorkSpaces that are created or rebuilt.
String defaultOu
The organizational unit (OU) in the directory that the WorkSpace machine accounts are placed in.
String customSecurityGroupId
The identifier of any custom security groups that are applied to the WorkSpaces when they are created.
Boolean userEnabledAsLocalAdministrator
The WorkSpace user is an administrator on the WorkSpace.
com.amazonaws.internal.SdkInternalList<T> bundleIds
An array of strings that contains the identifiers of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.
String owner
The owner of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.
This contains one of the following values:
AMAZON
- Retrieves the bundles that are provided by AWS.
String nextToken
The NextToken
value from a previous call to this operation.
Pass null if this is the first call.
com.amazonaws.internal.SdkInternalList<T> bundles
An array of structures that contain information about the bundles.
String nextToken
If not null, more results are available. Pass this value for the
NextToken
parameter in a subsequent call to this operation
to retrieve the next set of items. This token is valid for one day and
must be used within that timeframe.
com.amazonaws.internal.SdkInternalList<T> directoryIds
An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved.
String nextToken
The NextToken
value from a previous call to this operation.
Pass null if this is the first call.
com.amazonaws.internal.SdkInternalList<T> directories
An array of structures that contain information about the directories.
String nextToken
If not null, more results are available. Pass this value for the
NextToken
parameter in a subsequent call to this operation
to retrieve the next set of items. This token is valid for one day and
must be used within that timeframe.
com.amazonaws.internal.SdkInternalList<T> workspaceIds
An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information. This parameter cannot be combined with any other filter parameter.
Because the CreateWorkspaces operation is asynchronous, the identifier returned by CreateWorkspaces is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information will be returned.
String directoryId
Specifies the directory identifier to which to limit the WorkSpaces.
Optionally, you can specify a specific directory user with the
UserName
parameter. This parameter cannot be combined with
any other filter parameter.
String userName
Used with the DirectoryId
parameter to specify the directory
user for which to obtain the WorkSpace.
String bundleId
The identifier of a bundle to obtain the WorkSpaces for. All WorkSpaces that are created from this bundle will be retrieved. This parameter cannot be combined with any other filter parameter.
Integer limit
The maximum number of items to return.
String nextToken
The NextToken
value from a previous call to this operation.
Pass null if this is the first call.
com.amazonaws.internal.SdkInternalList<T> workspaces
An array of structures that contain the information about the WorkSpaces.
Because the CreateWorkspaces operation is asynchronous, some of this information may be incomplete for a newly-created WorkSpace.
String nextToken
If not null, more results are available. Pass this value for the
NextToken
parameter in a subsequent call to this operation
to retrieve the next set of items. This token is valid for one day and
must be used within that timeframe.
WorkspaceRequest workspaceRequest
A WorkspaceRequest object that contains the information about the WorkSpace that could not be created.
String errorCode
The error code.
String errorMessage
The textual error message.
String workspaceId
The identifier of the WorkSpace to reboot.
com.amazonaws.internal.SdkInternalList<T> rebootWorkspaceRequests
An array of structures that specify the WorkSpaces to reboot.
com.amazonaws.internal.SdkInternalList<T> failedRequests
An array of structures that represent any WorkSpaces that could not be rebooted.
String workspaceId
The identifier of the WorkSpace to rebuild.
com.amazonaws.internal.SdkInternalList<T> rebuildWorkspaceRequests
An array of structures that specify the WorkSpaces to rebuild.
com.amazonaws.internal.SdkInternalList<T> failedRequests
An array of structures that represent any WorkSpaces that could not be rebuilt.
String resourceId
The identifier of the resource that is not available.
String workspaceId
The identifier of the WorkSpace to terminate.
com.amazonaws.internal.SdkInternalList<T> terminateWorkspaceRequests
An array of structures that specify the WorkSpaces to terminate.
com.amazonaws.internal.SdkInternalList<T> failedRequests
An array of structures that represent any WorkSpaces that could not be terminated.
String capacity
The amount of user storage for the bundle.
String workspaceId
The identifier of the WorkSpace.
String directoryId
The identifier of the AWS Directory Service directory that the WorkSpace belongs to.
String userName
The user that the WorkSpace is assigned to.
String ipAddress
The IP address of the WorkSpace.
String state
The operational state of the WorkSpace.
String bundleId
The identifier of the bundle that the WorkSpace was created from.
String subnetId
The identifier of the subnet that the WorkSpace is in.
String errorMessage
If the WorkSpace could not be created, this contains a textual error message that describes the failure.
String errorCode
If the WorkSpace could not be created, this contains the error code.
String bundleId
The bundle identifier.
String name
The name of the bundle.
String owner
The owner of the bundle. This contains the owner's account identifier, or
AMAZON
if the bundle is provided by AWS.
String description
The bundle description.
UserStorage userStorage
A UserStorage object that specifies the amount of user storage that the bundle contains.
ComputeType computeType
A ComputeType object that specifies the compute type for the bundle.
String directoryId
The directory identifier.
String alias
The directory alias.
String directoryName
The name of the directory.
String registrationCode
The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
com.amazonaws.internal.SdkInternalList<T> subnetIds
An array of strings that contains the identifiers of the subnets used with the directory.
com.amazonaws.internal.SdkInternalList<T> dnsIpAddresses
An array of strings that contains the IP addresses of the DNS servers for the directory.
String customerUserName
The user name for the service account.
String iamRoleId
The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.
String directoryType
The directory type.
String workspaceSecurityGroupId
The identifier of the security group that is assigned to new WorkSpaces.
String state
The state of the directory's registration with Amazon WorkSpaces
DefaultWorkspaceCreationProperties workspaceCreationProperties
A structure that specifies the default creation properties for all WorkSpaces in the directory.
String directoryId
The identifier of the AWS Directory Service directory to create the WorkSpace in. You can use the DescribeWorkspaceDirectories operation to obtain a list of the directories that are available.
String userName
The username that the WorkSpace is assigned to. This username must exist
in the AWS Directory Service directory specified by the
DirectoryId
member.
String bundleId
The identifier of the bundle to create the WorkSpace from. You can use the DescribeWorkspaceBundles operation to obtain a list of the bundles that are available.
Throwable cause
Copyright © 2015. All rights reserved.