String requestId
String errorCode
AmazonServiceException.ErrorType errorType
AmazonServiceException.ErrorType
int statusCode
String serviceName
String activityId
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String description
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
String cause
Constraints:
Length: 1 - 1023
Pattern: [ --�𐀀-\r\n\t]*
Date startTime
Date endTime
String statusCode
Constraints:
Allowed Values: WaitingForSpotInstanceRequestId, WaitingForSpotInstanceId, WaitingForInstanceId, PreInService, InProgress, Successful, Failed, Cancelled
String statusMessage
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
Integer progress
String details
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
String adjustmentType
ChangeInCapacity
, ExactCapacity
, and
PercentChangeInCapacity
.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String autoScalingGroupARN
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
Integer minSize
Integer maxSize
Integer desiredCapacity
Integer defaultCooldown
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Constraints:
Length: 1 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
String healthCheckType
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\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: [ --�𐀀-\r\n\t]*
String vPCZoneIdentifier
When
you specify VPCZoneIdentifier
with
AvailabilityZones
, ensure that the subnets' Availability
Zones match the values you specify for AvailabilityZones
.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> enabledMetrics
String status
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> terminationPolicies
String instanceId
Constraints:
Length: 1 - 16
Pattern: [ --�𐀀-\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String availabilityZone
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String lifecycleState
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
String healthStatus
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String virtualName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String deviceName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
Ebs ebs
String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String launchConfigurationName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\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
or ELB
.
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
Integer healthCheckGracePeriod
String placementGroup
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String vPCZoneIdentifier
When you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> terminationPolicies
For more information on configuring a termination policy for your Auto Scaling group, go to Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String imageId
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String keyName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
websrv
. Specify Amazon VPC
security groups using security group IDs, such as
sg-12345678
. For more information about Amazon EC2
security groups, go to
Using Security Groups in the Amazon EC2 product documentation. For
more information about Amazon VPC security groups, go to
Security Groups in the Amazon VPC product documentation.String userData
Constraints:
Length: 0 - 21847
Pattern: [ --�𐀀-\r\n\t]*
String instanceType
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String kernelId
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String ramdiskId
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
InstanceMonitoring instanceMonitoring
When
detailed monitoring is enabled, CloudWatch will generate metrics every
minute and your account will be charged a fee. When you disable
detailed monitoring, by specifying False
, Cloudwatch will
generate metrics every 5 minutes. For information about monitoring,
see the Amazon
CloudWatch product page.
String spotPrice
Constraints:
Length: 1 - 255
String iamInstanceProfile
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
Boolean ebsOptimized
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
auto-scaling-group
is the only supported resource type.
The valid value for the resource ID is groupname. The
PropagateAtLaunch
flag defines whether the new tag will
be applied to instances launched by the Auto Scaling group. Valid
values are true
or false
. However, instances
that are already running will not get the new or updated tag.
Likewise, when you modify a tag, the updated version will be applied
only to new instances launched by the Auto Scaling group after the
change. Running instances that had the previous version of the tag
will continue to have the older tag.
When you create a tag and a tag of the same name already exists, the operation overwrites the previous tag definition, but you will not get an error message.
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
Boolean forceDelete
String launchConfigurationName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
String topicARN
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingGroupNames
String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
Integer maxRecords
Constraints:
Range: 1 - 50
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingGroups
String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
Integer maxRecords
Constraints:
Range: 1 - 50
String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingInstances
String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingNotificationTypes
com.amazonaws.internal.ListWithAutoConstructFlag<T> launchConfigurationNames
String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
Integer maxRecords
Constraints:
Range: 1 - 50
com.amazonaws.internal.ListWithAutoConstructFlag<T> launchConfigurations
String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> metrics
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupTotalInstances
com.amazonaws.internal.ListWithAutoConstructFlag<T> granularities
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingGroupNames
String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
Integer maxRecords
Constraints:
Range: 1 - 50
com.amazonaws.internal.ListWithAutoConstructFlag<T> notificationConfigurations
String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
Integer maxRecords
Constraints:
Range: 1 - 50
com.amazonaws.internal.ListWithAutoConstructFlag<T> scalingPolicies
String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> activityIds
AutoScalingGroupName
is provided, the results are limited
to that group. The list of requested activities cannot contain more
than 50 items. If unknown activities are requested, they are ignored
with no error.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
Integer maxRecords
Constraints:
Range: 1 - 50
String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> activities
String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> processes
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> scheduledActionNames
Date startTime
Date endTime
String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
Integer maxRecords
Constraints:
Range: 1 - 50
com.amazonaws.internal.ListWithAutoConstructFlag<T> scheduledUpdateGroupActions
String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
Integer maxRecords
Constraints:
Range: 1 - 50
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String nextToken
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> metrics
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupTotalInstances
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> metrics
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupTotalInstances
String granularity
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
String policyName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
Boolean honorCooldown
True
if you want Auto Scaling to reject this
request when the Auto Scaling group is in cooldown.String name
"auto-scaling-group"
, "key"
,
"value"
, and "propagate-at-launch"
.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
String instanceId
Constraints:
Length: 1 - 16
Pattern: [ --�𐀀-\r\n\t]*
String availabilityZone
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String lifecycleState
Constraints:
Allowed Values: Pending, Quarantined, InService, Terminating, Terminated
String healthStatus
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
Boolean enabled
True
, instance monitoring is enabled.String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String launchConfigurationARN
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
String imageId
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String keyName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
String userData
Constraints:
Length: 0 - 21847
Pattern: [ --�𐀀-\r\n\t]*
String instanceType
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String kernelId
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String ramdiskId
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
InstanceMonitoring instanceMonitoring
String spotPrice
Constraints:
Length: 1 - 255
String iamInstanceProfile
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
Date createdTime
Boolean ebsOptimized
String metric
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String granularity
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
String topicARN
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
String notificationType
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String processName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
String topicARN
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> notificationTypes
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
String policyName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
Integer scalingAdjustment
AdjustmentType
determines the interpretation of this number (e.g., as an absolute
number or as a percentage of the existing Auto Scaling group size). A
positive increment adds to the current capacity and a negative value
removes from the current capacity.String adjustmentType
ScalingAdjustment
is an absolute
number or a percentage of the current capacity. Valid values are
ChangeInCapacity
, ExactCapacity
, and
PercentChangeInCapacity
.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
Integer cooldown
Integer minAdjustmentStep
AdjustmentType
with the value
PercentChangeInCapacity
, the scaling policy changes the
DesiredCapacity
of the Auto Scaling group by at least the
number of instances specified in the value. You will get a
ValidationError
if you use MinAdjustmentStep
on a policy with an AdjustmentType
other than
PercentChangeInCapacity
.
String policyARN
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
String scheduledActionName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
Date time
Time
is deprecated. The time for this action to start.
Time
is an alias for StartTime
and can be
specified instead of StartTime
, or vice versa. If both
Time
and StartTime
are specified, their
values should be identical. Otherwise,
PutScheduledUpdateGroupAction
will return an error.
Date startTime
--start-time
2010-06-01T00:00:00Z
. When StartTime
and
EndTime
are specified with Recurrence
, they
form the boundaries of when the recurring action will start and stop.
Date endTime
String recurrence
When StartTime
and
EndTime
are specified with Recurrence
, they
form the boundaries of when the recurring action will start and stop.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
Integer minSize
Integer maxSize
Integer desiredCapacity
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> scalingProcesses
To suspend all process types, omit this parameter.
String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String policyName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
Integer scalingAdjustment
String adjustmentType
ScalingAdjustment
is an absolute
number or a percentage of the current capacity. Valid values are
ChangeInCapacity
, ExactCapacity
, and
PercentChangeInCapacity
.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
Integer cooldown
String policyARN
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> alarms
Integer minAdjustmentStep
DesiredCapacity
of the Auto Scaling group by
at least the specified number of instances.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String scheduledActionName
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String scheduledActionARN
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
Date time
Time
is deprecated. The time that the action is
scheduled to begin. Time
is an alias for
StartTime
.
Date startTime
When StartTime
and
EndTime
are specified with Recurrence
, they
form the boundaries of when the recurring action will start and stop.
Date endTime
String recurrence
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
Integer minSize
Integer maxSize
Integer desiredCapacity
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
Integer desiredCapacity
Boolean honorCooldown
SetDesiredCapacity
overrides any cooldown
period. Set to True
if you want Auto Scaling to reject
this request when the Auto Scaling group is in cooldown.String instanceId
Constraints:
Length: 1 - 16
Pattern: [ --�𐀀-\r\n\t]*
String healthStatus
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
Boolean shouldRespectGracePeriod
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> scalingProcesses
To suspend all process types, omit this parameter.
String resourceId
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
String resourceType
auto-scaling-group
resource type.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
String key
Constraints:
Length: 1 - 128
Pattern: [ --�𐀀-\r\n\t]*
String value
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
Boolean propagateAtLaunch
String resourceId
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
String resourceType
auto-scaling-group
resource type.
Constraints:
Pattern: [ --�𐀀-\r\n\t]*
String key
Constraints:
Length: 1 - 128
Pattern: [ --�𐀀-\r\n\t]*
String value
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
Boolean propagateAtLaunch
String instanceId
Constraints:
Length: 1 - 16
Pattern: [ --�𐀀-\r\n\t]*
Boolean shouldDecrementDesiredCapacity
Activity activity
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
String launchConfigurationName
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
Integer minSize
Integer maxSize
Integer desiredCapacity
Integer defaultCooldown
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Constraints:
Length: 1 -
String healthCheckType
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
Integer healthCheckGracePeriod
String placementGroup
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
String vPCZoneIdentifier
When
you specify VPCZoneIdentifier
with
AvailabilityZones
, ensure that the subnets' Availability
Zones match the values you specify for AvailabilityZones
.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> terminationPolicies
For more information on creating a termination policy for your Auto Scaling group, go to Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.
String stackName
String stackName
String templateBody
Conditional: You must pass
TemplateBody
or TemplateURL
. If both are
passed, only TemplateBody
is used.
Constraints:
Length: 1 - 51200
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 for the stack.Boolean disableRollback
true
to disable rollback of the stack if stack
creation failed. You can specify either DisableRollback
or OnFailure
, but not both. Default:
false
Integer timeoutInMinutes
DisableRollback
is not set or is set to
false
, the stack will be rolled back.
Constraints:
Range: 1 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> notificationARNs
Constraints:
Length: 0 - 5
com.amazonaws.internal.ListWithAutoConstructFlag<T> capabilities
String onFailure
OnFailure
or DisableRollback
, but not
both. Default: ROLLBACK
Constraints:
Allowed Values: DO_NOTHING, ROLLBACK, DELETE
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Tags
to associate with this stack,
represented by key/value pairs. Tags defined for the stack are
propogated to EC2 resources that are created as part of the stack. A
maximum number of 10 tags can be specified.String stackId
String stackName
com.amazonaws.internal.ListWithAutoConstructFlag<T> stackEvents
StackEvents
structures.String nextToken
Constraints:
Length: 1 - 1024
StackResourceDetail stackResourceDetail
StackResourceDetail
structure containing the
description of the specified resource in the specified stack.String stackName
Required: Conditional. If you do not specify
StackName
, you must specify
PhysicalResourceId
.
Default: There is no default value.
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> stacks
String nextToken
String templateBody
Conditional: You must pass
TemplateBody
or TemplateURL
. If both are
passed, only TemplateBody
is used.
Constraints:
Length: 1 - 51200
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 templateBody
Constraints:
Length: 1 - 51200
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 stackId
String stackName
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
Parameter
structures.Date creationTime
Date lastUpdatedTime
String stackStatus
Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE
String stackStatusReason
Boolean disableRollback
true
: disable rollbackfalse
: enable rollbackcom.amazonaws.internal.ListWithAutoConstructFlag<T> notificationARNs
Constraints:
Length: 0 - 5
Integer timeoutInMinutes
Constraints:
Range: 1 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> capabilities
com.amazonaws.internal.ListWithAutoConstructFlag<T> outputs
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Tag
s that specify cost allocation information
for the stack.String stackId
String eventId
String stackName
String logicalResourceId
String physicalResourceId
String resourceType
Date timestamp
String resourceStatus
Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE
String resourceStatusReason
String resourceProperties
String stackName
String stackId
String logicalResourceId
String physicalResourceId
String resourceType
Date timestamp
String resourceStatus
Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE
String resourceStatusReason
String description
String stackName
String stackId
String logicalResourceId
String physicalResourceId
String resourceType
Date lastUpdatedTimestamp
String resourceStatus
Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE
String resourceStatusReason
String description
String metadata
Metadata
attribute
declared for the resource. For more information, see Metadata
Attribute in the AWS CloudFormation User Guide.String logicalResourceId
String physicalResourceId
String resourceType
Date lastUpdatedTimestamp
String resourceStatus
Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE
String resourceStatusReason
String stackId
String stackName
String templateDescription
Date creationTime
Date lastUpdatedTime
Date deletionTime
String stackStatus
Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE
String stackStatusReason
String key
aws:
.String value
String parameterKey
String defaultValue
Boolean noEcho
String description
String stackName
String templateBody
Conditional: You must pass
TemplateBody
or TemplateURL
. If both are
passed, only TemplateBody
is used.
Constraints:
Length: 1 - 51200
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 for the stack.com.amazonaws.internal.ListWithAutoConstructFlag<T> capabilities
String stackId
String templateBody
Conditional: You must pass
TemplateURL
or TemplateBody
. If both are
passed, only TemplateBody
is used.
Constraints:
Length: 1 - 51200
String templateURL
Conditional: You must pass
TemplateURL
or TemplateBody
. If both are
passed, only TemplateBody
is used.
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
TemplateParameter
structures.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> capabilities
String capabilitiesReason
Boolean enabled
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String pathPattern
String targetOriginId
ForwardedValues forwardedValues
TrustedSigners trustedSigners
String viewerProtocolPolicy
Constraints:
Allowed Values: allow-all, https-only
Long minTTL
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
String targetOriginId
ForwardedValues forwardedValues
TrustedSigners trustedSigners
String viewerProtocolPolicy
Constraints:
Allowed Values: allow-all, https-only
Long minTTL
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
String comment
LoggingConfig logging
String priceClass
Constraints:
Allowed Values: PriceClass_100, PriceClass_200, PriceClass_All
Boolean enabled
ViewerCertificate viewerCertificate
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
String comment
String priceClass
Boolean enabled
ViewerCertificate viewerCertificate
Boolean queryString
CookiePreference cookies
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
String id
String status
Date createTime
InvalidationBatch invalidationBatch
Paths paths
String callerReference
String marker
String nextMarker
Integer maxItems
Boolean isTruncated
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String marker
String maxItems
CloudFrontOriginAccessIdentityList cloudFrontOriginAccessIdentityList
String marker
String maxItems
DistributionList distributionList
String distributionId
String marker
String maxItems
InvalidationList invalidationList
String marker
String maxItems
StreamingDistributionList streamingDistributionList
Boolean enabled
Boolean includeCookies
String bucket
String prefix
String id
String domainName
S3OriginConfig s3OriginConfig
CustomOriginConfig customOriginConfig
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
Constraints:
Length: 1 -
Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
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 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
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\-]+
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.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
DescribeIndexFields
response to the specified
fields.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> rankNames
DescribeRankExpressions
response to the
specified fields.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
Integer numSearchableDocs
Constraints:
Range: 0 -
ServiceEndpoint docService
ServiceEndpoint searchService
Boolean requiresIndexDocuments
Boolean processing
String searchInstanceType
Constraints:
Allowed Values: SearchInstance:t1.micro, SearchInstance:m1.small, SearchInstance:m1.large, SearchInstance:m2.xlarge
Integer searchPartitionCount
Constraints:
Range: 1 -
Integer searchInstanceCount
Constraints:
Range: 1 -
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
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 evaluting 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
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
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
Integer defaultValue
Constraints:
Range: 0 -
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String defaultSearchField
IndexField
to use for search requests issued with the
q
parameter. The default is an empty string, which
automatically searches all text fields.DefaultSearchFieldStatus defaultSearchField
DefaultSearchField
configured for this
search domain and its current status.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
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
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> 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
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 pipelineId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String name
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String uniqueId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String description
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> objectIds
Boolean evaluateExpressions
String marker
HasMoreResults
as True
,
you can call DescribeObjects again and pass the marker value
from the response to retrieve the next set of results.
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineObjects
String marker
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
Boolean hasMoreResults
True
, there are more pages of results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineIds
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String objectId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String expression
Constraints:
Length: 0 - 20971520
Pattern: [ --�𐀀-\r\n\t]*
String evaluatedExpression
Constraints:
Length: 0 - 20971520
Pattern: [ --�𐀀-\r\n\t]*
String key
Constraints:
Length: 1 - 256
Pattern: [ --�𐀀-\r\n\t]*
String stringValue
Constraints:
Length: 0 - 10240
Pattern: [ --�𐀀-\r\n\t]*
String refValue
Constraints:
Length: 1 - 256
Pattern: [ --�𐀀-\r\n\t]*
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String version
latest
(default) and
active
. Where latest
indicates the last
definition saved to the pipeline and active
indicates the
last definition of the pipeline that was activated.
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String document
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String signature
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String marker
HasMoreResults
as True
, you
can call ListPipelines again and pass the marker value from the
response to retrieve the next set of results.
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineIdList
String marker
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
Boolean hasMoreResults
True
, there are more results that can be obtained by a
subsequent call to ListPipelines.String type
EQ
), equal
reference (REF_EQ
), less than or equal (LE
),
greater than or equal (GE
), or between
(BETWEEN
). Equal reference (REF_EQ
) can be
used only with reference fields. The other comparison types can be
used only with String fields. The comparison types you can use apply
only to certain object fields, as detailed below. The comparison operators EQ and REF_EQ act on the following fields:
The
comparison operators GE
, LE
, and
BETWEEN
act on the following fields:
Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string "my".
Constraints:
Allowed Values: EQ, REF_EQ, LE, GE, BETWEEN
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
String pipelineId
df-297EG78HU43EEXAMPLE
.
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String name
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> fields
String description
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String id
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String name
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\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: [ --�𐀀-\r\n\t]*
String hostname
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
InstanceIdentity instanceIdentity
http://169.254.169.254/latest/meta-data/instance-id
, from
the EC2 instance. For more information, go to Instance
Metadata in the Amazon Elastic Compute Cloud User Guide.
Passing in this value proves that your task runner is running on an
EC2 instance, and ensures the proper AWS Data Pipeline service charges
are applied to your pipeline.TaskObject taskObject
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineObjects
com.amazonaws.internal.ListWithAutoConstructFlag<T> validationErrors
pipelineObjects
.com.amazonaws.internal.ListWithAutoConstructFlag<T> validationWarnings
pipelineObjects
.Boolean errored
True
, there were validation errors. If errored is
True
, the pipeline definition is stored but cannot be
activated until you correct the pipeline and call
PutPipelineDefinition to commit the corrected pipeline.String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
Query query
String sphere
COMPONENT
, INSTANCE
,
ATTEMPT
.
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String marker
HasMoreResults
as True
, you
can call QueryObjects again and pass the marker value from the
response to retrieve the next set of results.
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
Integer limit
com.amazonaws.internal.ListWithAutoConstructFlag<T> ids
String marker
HasMoreResults
as True
, you
can call QueryObjects again and pass the marker value from the
response to retrieve the next set of results.
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
Boolean hasMoreResults
True
, there are more results that can be obtained by a
subsequent call to QueryObjects.String taskId
Constraints:
Length: 1 - 2048
Pattern: [ --�𐀀-\r\n\t]*
Boolean canceled
True
, the calling task runner should cancel processing
of the task. The task runner does not need to call
SetTaskStatus for canceled tasks.String taskrunnerId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String workerGroup
workerGroup
in the call to
ReportTaskRunnerHeartbeat. There are no wildcard values
permitted in workerGroup
, the string must be an exact,
case-sensitive, match.
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String hostname
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
Boolean terminate
True
, the task runner that called
ReportTaskRunnerHeartbeat should terminate.String fieldName
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
Operator operator
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> objectIds
String status
objectIds
. For components, this can be either
PAUSE
or RESUME
. For instances, this can be
either CANCEL
, RERUN
, or
MARK_FINISHED
.
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String taskId
Constraints:
Length: 1 - 2048
Pattern: [ --�𐀀-\r\n\t]*
String taskStatus
FINISHED
, the task successfully completed. If
FAILED
the task ended unsuccessfully. The
FALSE
value is used by preconditions.
Constraints:
Allowed Values: FINISHED, FAILED, FALSE
String errorId
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String errorMessage
String errorStackTrace
Constraints:
Length: 0 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String taskId
Constraints:
Length: 1 - 2048
Pattern: [ --�𐀀-\r\n\t]*
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
String attemptId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
Map<K,V> objects
String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineObjects
com.amazonaws.internal.ListWithAutoConstructFlag<T> validationErrors
com.amazonaws.internal.ListWithAutoConstructFlag<T> validationWarnings
Boolean errored
True
, there were validation errors.String id
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> errors
String id
Constraints:
Length: 1 - 1024
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> warnings
String connectionId
Example: dxcon-fg5678gh
Default: None
String connectionName
Example: "1G Connection to AWS"
Default: None
String connectionState
Constraints:
Allowed Values: requested, pending, available, deleted
String region
Example: us-east-1
Default: None
String location
Example: EqSV5
Default: None
String name
Example: Inbound data transfer
String unit
Example: "Gbps," if the price is calculated based on Gbps.
String currencyCode
Example: "USD" for US dollar.
String amount
Example: 0.01
String number
Example: 1
String name
Example: Authorize cross connect
String description
Example: "AWS will prepare your connection and send you an email with an LOA to provide to the colocation provider"
String owner
Example: AWS, Customer
Integer sla
Example: 60
String stepState
Constraints:
Allowed Values: pending, completed
String connectionId
Example: dxcon-fg5678gh
Default: None
String connectionName
Example: "1G Connection to AWS"
Default: None
String connectionState
Constraints:
Allowed Values: requested, pending, available, deleted
String region
Example: us-east-1
Default: None
String location
Example: EqSV5
Default: None
String connectionId
Example: dxcon-fg5678gh
Default: None
NewPrivateVirtualInterface newPrivateVirtualInterface
Default: None
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, etc.)
String virtualInterfaceName
Example: "Dev VPC"
Integer vlan
Example: 101
Integer asn
Example: 65000
String authKey
Example: asdf34example
String amazonAddress
Example: 192.168.1.1
String customerAddress
Example: 192.168.1.2
String virtualInterfaceState
Constraints:
Allowed Values: verifying, pending, available, deleting, deleted
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 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, etc.)
String virtualInterfaceName
Example: "Dev VPC"
Integer vlan
Example: 101
Integer asn
Example: 65000
String authKey
Example: asdf34example
String amazonAddress
Example: 192.168.1.1
String customerAddress
Example: 192.168.1.2
String virtualInterfaceState
Constraints:
Allowed Values: verifying, pending, available, deleting, deleted
String customerRouterConfig
String virtualGatewayId
Example: vgw-123er56
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeFilterPrefixes
String connectionId
Example: dxcon-fg5678gh
Default: None
String connectionId
Example: dxcon-fg5678gh
Default: None
String connectionName
Example: "1G Connection to AWS"
Default: None
String connectionState
Constraints:
Allowed Values: requested, pending, available, deleted
String region
Example: us-east-1
Default: None
String location
Example: EqSV5
Default: None
String virtualInterfaceId
Example: dxvif-123dfg56
Default: None
String virtualInterfaceState
Constraints:
Allowed Values: verifying, pending, available, deleting, deleted
String connectionId
Example: dxcon-fg5678gh
Default: None
String connectionId
Example: dxcon-fg5678gh
Default: None
String connectionName
Example: "1G Connection to AWS"
Default: None
String connectionState
Constraints:
Allowed Values: requested, pending, available, deleted
String region
Example: us-east-1
Default: None
String location
Example: EqSV5
Default: None
String bandwidth
Example: 1Gbps
Default: None
com.amazonaws.internal.ListWithAutoConstructFlag<T> connectionCosts
com.amazonaws.internal.ListWithAutoConstructFlag<T> orderSteps
String connectionId
Example: dxcon-fg5678gh
Default: None
String offeringId
Example: us-west-1_EqSV5_1G
Default: None
String offeringId
Example: us-west-1_EqSV5_1G
Default: None
String region
Example: us-east-1
Default: None
String location
Example: EqSV5
Default: None
String offeringName
String description
Example: "1Gbps Cross Connect in us-east-1 via Equinix"
Default: None
String bandwidth
Example: 1Gbps
Default: None
com.amazonaws.internal.ListWithAutoConstructFlag<T> connectionCosts
com.amazonaws.internal.ListWithAutoConstructFlag<T> orderSteps
String virtualInterfaceName
Example: "Dev VPC"
Integer vlan
Example: 101
Integer asn
Example: 65000
String authKey
Example: asdf34example
String amazonAddress
Example: 192.168.1.1
String customerAddress
String virtualGatewayId
Example: vgw-123er56
String virtualInterfaceName
Example: "Dev VPC"
Integer vlan
Example: 101
Integer asn
Example: 65000
String authKey
Example: asdf34example
String amazonAddress
Example: 192.168.1.1
String customerAddress
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeFilterPrefixes
String offeringId
Example: us-west-1_EqSV5_1G
Default: None
String region
Example: us-east-1
Default: None
String location
Example: EqSV5
Default: None
String offeringName
Example: "1Gbps Cross Connect in us-east-1 via Equinix"
Default: None
String description
Example: "1Gbps Cross Connect in us-east-1 via Equinix"
Default: None
String bandwidth
Example: 1Gbps
Default: None
com.amazonaws.internal.ListWithAutoConstructFlag<T> connectionCosts
String number
Example: 1
String name
Example: Authorize cross connect
String description
Example: "AWS will prepare your connection and send you an email with an LOA to provide to the colocation provider"
String owner
Example: AWS
Integer sla
Example: 60
String cidr
Example: 10.10.10.0/24,10.10.11.0/24
String virtualGatewayId
Example: vgw-123er56
String virtualGatewayState
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, etc.)
String virtualInterfaceName
Example: "Dev VPC"
Integer vlan
Example: 101
Integer asn
Example: 65000
String authKey
Example: asdf34example
String amazonAddress
Example: 192.168.1.1
String customerAddress
Example: 192.168.1.2
String virtualInterfaceState
Constraints:
Allowed Values: verifying, pending, available, deleting, deleted
String customerRouterConfig
String virtualGatewayId
Example: vgw-123er56
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeFilterPrefixes
String s
String n
ByteBuffer b
List<E> sS
List<E> nS
List<E> bS
AttributeValue value
String
, Number
,
Binary
, StringSet
, NumberSet
,
BinarySet
.String action
Constraints:
Allowed Values: ADD, PUT, DELETE
Map<K,V> responses
Map<K,V> unprocessedKeys
UnprocessedKeys
value is in the
same form as a RequestItems
parameter (so the value can
be provided directly to a subsequent BatchGetItem
operation). For more information, see the above
RequestItems
parameter.
Constraints:
Length: 1 - 100
List<E> items
Double consumedCapacityUnits
GetItem
,
BatchGetItem
, BatchWriteItem
,
Query
, and Scan
operations consume
ReadCapacityUnits
, while PutItem
,
UpdateItem
, and DeleteItem
operations
consume WriteCapacityUnits
.Map<K,V> responses
BatchWriteItem
call.
This is essentially a map of table name to
ConsumedCapacityUnits
.Map<K,V> unprocessedItems
BatchWriteItem
call is returned as
UnprocessedItems
Constraints:
Length: 1 - 25
Double consumedCapacityUnits
GetItem
,
BatchGetItem
, BatchWriteItem
,
Query
, and Scan
operations consume
ReadCapacityUnits
, while PutItem
,
UpdateItem
, and DeleteItem
operations
consume WriteCapacityUnits
.List<E> attributeValueList
BETWEEN
comparison, the
AttributeValueList contains two attribute values and the comparison
operator.String comparisonOperator
EQ
for equal.NE
for
not equal.IN
checks for exact
matches.LE
for less than or equal
to.LT
for less than.GE
for greater than or equal to.GT
for greater than.BETWEEN
for between.NOT_NULL
for exists.NULL
for not exists.CONTAINS
for substring or value in a set.NOT_CONTAINS
for absence of a substring or absence of
a value in a set.BEGINS_WITH
for a substring
prefix.Scan operations support all available comparison operators.
Query operations support a subset of the available comparison operators: EQ, LE, LT, GE, GT, BETWEEN, and BEGINS_WITH.
Constraints:
Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH
String tableName
a-z
, A-Z
, 0-9
, _
(underscore), -
(hyphen) and .
(period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
KeySchema keySchema
HashKeyElement
. A composite hash-and-range primary key
contains two attribute values: a HashKeyElement
and a
RangeKeyElement
.ProvisionedThroughput provisionedThroughput
ReadCapacityUnits
and
WriteCapacityUnits
. Values for provisioned throughput
depend upon your expected read/write rates, item size, and
consistency. Provide the expected number of read and write operations,
assuming an item size of 1k and strictly consistent reads. For 2k item
size, double the value. For 3k, triple the value, etc.
Eventually-consistent reads consume half the resources of strictly
consistent reads.TableDescription tableDescription
String tableName
a-z
, A-Z
, 0-9
,
_
(underscore), -
(hyphen) and
.
(period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Key key
Map<K,V> expected
Expected
parameter allows you to provide an attribute
name, and whether or not Amazon DynamoDB should check to see if the
attribute has a particular value before modifying it.String returnValues
PUT
operations,
the possible parameter values are NONE
(default) or
ALL_OLD
. For update operations, the possible parameter
values are NONE
(default) or ALL_OLD
,
UPDATED_OLD
, ALL_NEW
or
UPDATED_NEW
. NONE
: Nothing is
returned.ALL_OLD
: Returns the attributes of the
item as they were before the operation.UPDATED_OLD
: Returns the values of the updated
attributes, only, as they were before the operation.ALL_NEW
: Returns all the attributes and their new
values after the operation.UPDATED_NEW
: Returns
the values of the updated attributes, only, as they are after the
operation.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
Map<K,V> attributes
ReturnValues
parameter is provided as
ALL_OLD
in the request, Amazon DynamoDB returns an array
of attribute name-value pairs (essentially, the deleted item).
Otherwise, the response contains an empty set.Double consumedCapacityUnits
GetItem
,
BatchGetItem
, BatchWriteItem
,
Query
, and Scan
operations consume
ReadCapacityUnits
, while PutItem
,
UpdateItem
, and DeleteItem
operations
consume WriteCapacityUnits
.Key key
String tableName
a-z
, A-Z
, 0-9
, _
(underscore), -
(hyphen) and .
(period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
TableDescription tableDescription
String tableName
a-z
, A-Z
, 0-9
, _
(underscore), -
(hyphen) and .
(period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
TableDescription table
AttributeValue value
Boolean exists
String tableName
a-z
, A-Z
, 0-9
,
_
(underscore), -
(hyphen) and
.
(period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Key key
List<E> attributesToGet
Attribute
names. If attribute names are not
specified then all attributes will be returned. If some attributes are
not found, they will not appear in the result.
Constraints:
Length: 1 -
Boolean consistentRead
true
, then a consistent read is issued.
Otherwise eventually-consistent is used.Map<K,V> item
Double consumedCapacityUnits
GetItem
,
BatchGetItem
, BatchWriteItem
,
Query
, and Scan
operations consume
ReadCapacityUnits
, while PutItem
,
UpdateItem
, and DeleteItem
operations
consume WriteCapacityUnits
.AttributeValue hashKeyElement
String
, Number
,
StringSet
, NumberSet
.AttributeValue rangeKeyElement
String
, Number
, StringSet
,
NumberSet
.List<E> keys
List<E> attributesToGet
Attribute
names. If attribute names are not
specified then all attributes will be returned. If some attributes are
not found, they will not appear in the result.
Constraints:
Length: 1 -
Boolean consistentRead
true
, then a consistent read is issued.
Otherwise eventually-consistent is used.KeySchemaElement hashKeyElement
String
, Number
,
StringSet
, NumberSet
.KeySchemaElement rangeKeyElement
String
, Number
, StringSet
,
NumberSet
.String exclusiveStartTableName
ListTables
operation and received a
LastEvaluatedTableName
value in the response, use that
value here to continue the list.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Integer limit
Constraints:
Range: 1 - 100
List<E> tableNames
String lastEvaluatedTableName
ExclusiveStartTableName
in a new request to continue the
list until all the table names are returned. If this value is null,
all table names have been returned.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Long readCapacityUnits
ReadCapacityUnits
are in terms of strictly consistent
reads, assuming items of 1k. 2k items require twice the
ReadCapacityUnits
. Eventually-consistent reads only
require half the ReadCapacityUnits
of stirctly consistent
reads.
Constraints:
Range: 1 -
Long writeCapacityUnits
WriteCapacityUnits
are in terms of strictly consistent
reads, assuming items of 1k. 2k items require twice the
WriteCapacityUnits
.
Constraints:
Range: 1 -
String tableName
a-z
, A-Z
, 0-9
,
_
(underscore), -
(hyphen) and
.
(period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Map<K,V> item
Map<K,V> expected
Expected
parameter allows you to provide an attribute
name, and whether or not Amazon DynamoDB should check to see if the
attribute has a particular value before modifying it.String returnValues
PUT
operations,
the possible parameter values are NONE
(default) or
ALL_OLD
. For update operations, the possible parameter
values are NONE
(default) or ALL_OLD
,
UPDATED_OLD
, ALL_NEW
or
UPDATED_NEW
. NONE
: Nothing is
returned.ALL_OLD
: Returns the attributes of the
item as they were before the operation.UPDATED_OLD
: Returns the values of the updated
attributes, only, as they were before the operation.ALL_NEW
: Returns all the attributes and their new
values after the operation.UPDATED_NEW
: Returns
the values of the updated attributes, only, as they are after the
operation.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
Map<K,V> attributes
ReturnValues
parameter is specified as
ALL_OLD
in the request.Double consumedCapacityUnits
GetItem
,
BatchGetItem
, BatchWriteItem
,
Query
, and Scan
operations consume
ReadCapacityUnits
, while PutItem
,
UpdateItem
, and DeleteItem
operations
consume WriteCapacityUnits
.String tableName
a-z
, A-Z
, 0-9
,
_
(underscore), -
(hyphen) and
.
(period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
List<E> attributesToGet
Attribute
names. If attribute names are not
specified then all attributes will be returned. If some attributes are
not found, they will not appear in the result.
Constraints:
Length: 1 -
Integer limit
LastEvaluatedKey
to apply in a subsequent operation to continue the query. Also, if the
result set size exceeds 1MB before Amazon DynamoDB hits this limit, it
stops the query and returns the matching values, and a
LastEvaluatedKey
to apply in a subsequent operation to
continue the query.
Constraints:
Range: 1 -
Boolean consistentRead
true
, then a consistent read is issued.
Otherwise eventually-consistent is used.Boolean count
true
, Amazon DynamoDB returns a total number of
items that match the query parameters, instead of a list of the
matching items and their attributes. Do not set Count
to
true
while providing a list of
AttributesToGet
, otherwise Amazon DynamoDB returns a
validation error.AttributeValue hashKeyValue
Condition rangeKeyCondition
Boolean scanIndexForward
true
(forward).Key exclusiveStartKey
LastEvaluatedKey
if that query operation was interrupted
before completing the query; either because of the result set size or
the Limit
parameter. The LastEvaluatedKey
can be passed back in a new query request to continue the operation
from that point.List<E> items
Integer count
Key lastEvaluatedKey
LastEvaluatedKey
is null when the entire query result set
is complete (i.e. the operation processed the "last page").Double consumedCapacityUnits
GetItem
,
BatchGetItem
, BatchWriteItem
,
Query
, and Scan
operations consume
ReadCapacityUnits
, while PutItem
,
UpdateItem
, and DeleteItem
operations
consume WriteCapacityUnits
.String tableName
a-z
, A-Z
, 0-9
,
_
(underscore), -
(hyphen) and
.
(period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
List<E> attributesToGet
Attribute
names. If attribute names are not
specified then all attributes will be returned. If some attributes are
not found, they will not appear in the result.
Constraints:
Length: 1 -
Integer limit
LastEvaluatedKey
to apply in a subsequent operation to continue the scan. Also, if the
scanned data set size exceeds 1 MB before Amazon DynamoDB hits this
limit, it stops the scan and returns the matching values up to the
limit, and a LastEvaluatedKey
to apply in a subsequent
operation to continue the scan.
Constraints:
Range: 1 -
Boolean count
true
, Amazon DynamoDB returns a total number of
items for the Scan
operation, even if the operation has
no matching items for the assigned filter. Do not set
Count
to true
while providing a list of
AttributesToGet
, otherwise Amazon DynamoDB returns a
validation error.Map<K,V> scanFilter
Key exclusiveStartKey
Limit
parameter. The
LastEvaluatedKey
can be passed back in a new scan request
to continue the operation from that point.List<E> items
Integer count
Integer scannedCount
ScannedCount
value with few, or no,
Count
results indicates an inefficient Scan
operation.Key lastEvaluatedKey
LastEvaluatedKey
is null when the entire
scan result set is complete (i.e. the operation processed the "last
page").Double consumedCapacityUnits
GetItem
,
BatchGetItem
, BatchWriteItem
,
Query
, and Scan
operations consume
ReadCapacityUnits
, while PutItem
,
UpdateItem
, and DeleteItem
operations
consume WriteCapacityUnits
.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
KeySchema keySchema
HashKeyElement
. A composite hash-and-range primary key
contains two attribute values: a HashKeyElement
and a
RangeKeyElement
.String tableStatus
Date creationDateTime
ProvisionedThroughputDescription provisionedThroughput
Long tableSizeBytes
Long itemCount
String tableName
a-z
, A-Z
, 0-9
,
_
(underscore), -
(hyphen) and
.
(period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Key key
Map<K,V> attributeUpdates
Map<K,V> expected
Expected
parameter allows you to provide an attribute
name, and whether or not Amazon DynamoDB should check to see if the
attribute has a particular value before modifying it.String returnValues
PUT
operations,
the possible parameter values are NONE
(default) or
ALL_OLD
. For update operations, the possible parameter
values are NONE
(default) or ALL_OLD
,
UPDATED_OLD
, ALL_NEW
or
UPDATED_NEW
. NONE
: Nothing is
returned.ALL_OLD
: Returns the attributes of the
item as they were before the operation.UPDATED_OLD
: Returns the values of the updated
attributes, only, as they were before the operation.ALL_NEW
: Returns all the attributes and their new
values after the operation.UPDATED_NEW
: Returns
the values of the updated attributes, only, as they are after the
operation.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
Map<K,V> attributes
ReturnValues
parameter is specified as something other
than NONE
in the request.Double consumedCapacityUnits
GetItem
,
BatchGetItem
, BatchWriteItem
,
Query
, and Scan
operations consume
ReadCapacityUnits
, while PutItem
,
UpdateItem
, and DeleteItem
operations
consume WriteCapacityUnits
.String tableName
a-z
, A-Z
, 0-9
, _
(underscore), -
(hyphen) and .
(period).
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
ProvisionedThroughput provisionedThroughput
ReadCapacityUnits
and
WriteCapacityUnits
. Values for provisioned throughput
depend upon your expected read/write rates, item size, and
consistency. Provide the expected number of read and write operations,
assuming an item size of 1k and strictly consistent reads. For 2k item
size, double the value. For 3k, triple the value, etc.
Eventually-consistent reads consume half the resources of strictly
consistent reads.TableDescription tableDescription
PutRequest putRequest
DeleteRequest deleteRequest
String s
String n
ByteBuffer b
com.amazonaws.internal.ListWithAutoConstructFlag<T> sS
com.amazonaws.internal.ListWithAutoConstructFlag<T> nS
com.amazonaws.internal.ListWithAutoConstructFlag<T> bS
AttributeValue value
String action
PUT
, DELETE
, and ADD
. The
behavior depends on whether the specified primary key already exists
in the table. If an item with the specified Key is found in the table:
PUT
- Adds the specified
attribute to the item. If the attribute already exists, it is replaced
by the new value.
DELETE
- If no value is
specified, the attribute and its value are removed from the item. The
data type of the specified value must match the existing value's data
type.
If a set of values is specified, then those values are
subtracted from the old set. For example, if the attribute value was
the set [a,b,c]
and the DELETE action specified
[a,c]
, then the final attribute value would be
[b]
. Specifying an empty set is an error.
ADD
- If the attribute does not already exist, then
the attribute and its values are added to the item. If the attribute
does exist, then the behavior of ADD
depends on the data
type of the attribute:
If the existing attribute is a
number, and if Value is also a number, then the Value is
mathematically added to the existing attribute. If Value is a
negative number, then it is subtracted from the existing attribute.
If you use In addition, if you use
ADD
to increment or decrement a
number value for an item that doesn't exist before the update, Amazon
DynamoDB uses 0 as the initial value. ADD
to update an existing item, and intend to increment
or decrement an attribute value which does not yet exist, Amazon
DynamoDB uses 0
as the initial value. For example,
suppose that the item you want to update does not yet have an
attribute named itemcount, but you decide to ADD
the number 3
to this attribute anyway, even though it
currently does not exist. Amazon DynamoDB will create the
itemcount attribute, set its initial value to 0
,
and finally add 3
to it. The result will be a new
itemcount attribute in the item, with a value of
3
.
If the existing data type is a
set, and if the Value is also a set, then the Value is
added to the existing set. (This is a set operation, not
mathematical addition.) For example, if the attribute value was the
set [1,2]
, and the ADD
action specified
[3]
, then the final attribute value would be
[1,2,3]
. An error occurs if an Add action is specified
for a set attribute and the attribute type specified does not match
the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid
for an existing attribute whose data type is number or is a set. Do
not use ADD
for any other data types.
If no item with the specified Key is found:
PUT
- Amazon DynamoDB creates a new item with the
specified primary key, and then adds the attribute.
DELETE
- Nothing happens; there is no attribute to
delete.
ADD
- Amazon DynamoDB creates an
item with the supplied primary key and number (or set of numbers) for
the attribute value. The only data types allowed are number and number
set; no other data types can be specified.
Constraints:
Allowed Values: ADD, PUT, DELETE
Map<K,V> requestItems
Each element in the map consists of the following:
Keys - An array of primary key attribute values that define specific items in the table.
AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.
ConsistentRead - If true
, a strongly
consistent read is used; if false
(the default), an
eventually consistent read is used.
Constraints:
Length: 1 - 100
String returnConsumedCapacity
TOTAL
, ConsumedCapacity is included in
the response; if set to NONE
(the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
Map<K,V> responses
Map<K,V> unprocessedKeys
Each element consists of:
Keys - An array of primary key attribute values that define specific items in the table.
AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.
If you are querying an index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
ConsistentRead - The consistency of a read operation. If set
to true
, then a strongly consistent read is used;
otherwise, an eventually consistent read is used.
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> consumedCapacity
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
Map<K,V> requestItems
DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:
Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
Constraints:
Length: 1 - 25
String returnConsumedCapacity
TOTAL
, ConsumedCapacity is included in
the response; if set to NONE
(the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
String returnItemCollectionMetrics
SIZE
, statistics about item collections, if
any, that were modified during the operation are returned in the
response. If set to NONE
(the default), no statistics are
returned..
Constraints:
Allowed Values: SIZE, NONE
Map<K,V> unprocessedItems
Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to perform (DeleteRequest or PutRequest).
DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:
Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
Constraints:
Length: 1 - 25
Map<K,V> itemCollectionMetrics
Each entry consists of the following subelements:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the secondary indexes on the table. Use this estimate to measure whether a secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
com.amazonaws.internal.ListWithAutoConstructFlag<T> consumedCapacity
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeValueList
BETWEEN
or IN
comparison, in which case the
list contains two values. For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or
less than are based on ASCII character code values. For example,
a
is greater than A
, and aa
is
greater than B
. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, Amazon DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
String comparisonOperator
Valid comparison operators for Query:
EQ | LE | LT | GE | GT | BEGINS_WITH |
BETWEEN
Valid comparison operators for Scan:
EQ |
NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS |
BEGINS_WITH | IN | BETWEEN
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
The following are descriptions of each comparison operator.
EQ
: Equal.
AttributeValueList can contain
only one AttributeValue of type String, Number, or Binary (not
a set). If an item contains an AttributeValue of a different
type than the one specified in the request, the value does not match.
For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not equal
{"NS":["6", "2", "1"]}
.
NE
: Not equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not equal {"NS":["6", "2",
"1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
GE
: Greater than or
equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
NOT_NULL
: The
attribute exists.
NULL
: The attribute does
not exist.
CONTAINS
: checks for a
subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for a member of the set (not as a substring).
NOT_CONTAINS
: checks for absence of a
subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for the absence of a member of the set (not as a substring).
BEGINS_WITH
: checks for a
prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
IN
:
checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
BETWEEN
: Greater than or equal to the
first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a
set). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue of a different
type than the one specified in the request, the value does not match.
For example, {"S":"6"}
does not compare to
{"N":"6"}
. Also, {"N":"6"}
does not compare
to {"NS":["6", "2", "1"]}
Constraints:
Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeDefinitions
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
Each KeySchemaElement in the array is composed of:
AttributeName - The name of this key attribute.
KeyType - Determines whether the key attribute is
HASH
or RANGE
.
For a primary
key that consists of a hash attribute, you must specify exactly one
element with a KeyType of HASH
.
For a primary
key that consists of hash and range attributes, you must specify
exactly two elements, in this order: The first element must have a
KeyType of HASH
, and the second element must have
a KeyType of RANGE
.
For more information, see Specifying the Primary Key in the Amazon DynamoDB Developer Guide.
Constraints:
Length: 1 - 2
com.amazonaws.internal.ListWithAutoConstructFlag<T> localSecondaryIndexes
Each secondary index in the array includes the following:
IndexName - The name of the secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the index. The key schema must begin with the same hash key attribute as the table.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY
- Only the index and primary keys are
projected into the index.
INCLUDE
- Only
the specified table attributes are projected into the index. The list
of projected attributes are in NonKeyAttributes.
ALL
- All of the table attributes are projected into
the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the index. The total count of attributes specified in NonKeyAttributes, summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput provisionedThroughput
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
TableDescription tableDescription
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Map<K,V> key
Map<K,V> expected
Expected allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it.
Each item in Expected represents an attribute name for Amazon DynamoDB to check, along with the following:
Value - The attribute value for Amazon DynamoDB to check.
Exists - Causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:
If Exists is
true
, Amazon DynamoDB will check to see if that attribute
value already exists in the table. If it is found, then the operation
succeeds. If it is not found, the operation fails with a
ConditionalCheckFailedException.
If Exists
is false
, Amazon DynamoDB assumes that the attribute
value does not exist in the table. If in fact the value does
not exist, then the assumption is valid and the operation succeeds. If
the value is found, despite the assumption that it does not exist, the
operation fails with a ConditionalCheckFailedException.
The default setting for Exists is true
.
If you supply a Value all by itself, Amazon DynamoDB assumes
the attribute exists: You don't have to set Exists to
true
, because it is implied.
Amazon DynamoDB returns a ValidationException if:
Exists is
true
but there is no Value to check. (You expect a
value to exist, but don't specify what that value is.)
Exists is false
but you also specify a
Value. (You cannot expect an attribute to have a value, while
also expecting it not to exist.)
If you specify more than one condition for Exists, then all of the conditions must evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the conditional operation will fail.
String returnValues
NONE
- If ReturnValues is
not specified, or if its value is NONE
, then nothing is
returned. (This is the default for ReturnValues.)
ALL_OLD
- The content of the old item is returned.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
String returnConsumedCapacity
TOTAL
, ConsumedCapacity is included in
the response; if set to NONE
(the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
String returnItemCollectionMetrics
SIZE
, statistics about item collections, if
any, that were modified during the operation are returned in the
response. If set to NONE
(the default), no statistics are
returned..
Constraints:
Allowed Values: SIZE, NONE
Map<K,V> attributes
ALL_OLD
in the
request.ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
Each ItemCollectionMetrics element consists of:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size, measured in gigabytes. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the secondary indexes on that table. Use this estimate to measure whether a secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
TableDescription tableDescription
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
TableDescription table
AttributeValue value
Boolean exists
If Exists is
true
, Amazon DynamoDB will check to see if that attribute
value already exists in the table. If it is found, then the operation
succeeds. If it is not found, the operation fails with a
ConditionalCheckFailedException.
If Exists
is false
, Amazon DynamoDB assumes that the attribute
value does not exist in the table. If in fact the value does
not exist, then the assumption is valid and the operation succeeds. If
the value is found, despite the assumption that it does not exist, the
operation fails with a ConditionalCheckFailedException.
The default setting for Exists is true
.
If you supply a Value all by itself, Amazon DynamoDB assumes
the attribute exists: You don't have to set Exists to
true
, because it is implied.
Amazon DynamoDB returns a ValidationException if:
Exists is
true
but there is no Value to check. (You expect a
value to exist, but don't specify what that value is.)
Exists is false
but you also specify a
Value. (You cannot expect an attribute to have a value, while
also expecting it not to exist.)
If you specify more than one condition for Exists, then all of the conditions must evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the conditional operation will fail.
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Map<K,V> key
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributesToGet
Constraints:
Length: 1 -
Boolean consistentRead
true
, then the operation uses strongly
consistent reads; otherwise, eventually consistent reads are used.String returnConsumedCapacity
TOTAL
, ConsumedCapacity is included in
the response; if set to NONE
(the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
Map<K,V> item
ConsumedCapacity consumedCapacity
Map<K,V> itemCollectionKey
com.amazonaws.internal.ListWithAutoConstructFlag<T> sizeEstimateRangeGB
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
com.amazonaws.internal.ListWithAutoConstructFlag<T> keys
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributesToGet
If you are querying an index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
Constraints:
Length: 1 -
Boolean consistentRead
true
, then a strongly consistent read is used; otherwise,
an eventually consistent read is used.String exclusiveStartTableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Integer limit
Constraints:
Range: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> tableNames
String lastEvaluatedTableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
HASH
or
RANGE
).
Constraints:
Length: 1 - 2
Projection projection
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
HASH
or
RANGE
).
Constraints:
Length: 1 - 2
Projection projection
Long indexSizeBytes
Long itemCount
String projectionType
KEYS_ONLY
- Only the index and primary keys
are projected into the index.
INCLUDE
-
Only the specified table attributes are projected into the index. The
list of projected attributes are in NonKeyAttributes.
ALL
- All of the table attributes are projected
into the index.
Constraints:
Allowed Values: ALL, KEYS_ONLY, INCLUDE
com.amazonaws.internal.ListWithAutoConstructFlag<T> nonKeyAttributes
The total count of attributes specified in NonKeyAttributes, summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
Constraints:
Length: 1 - 20
Long readCapacityUnits
Constraints:
Range: 1 -
Long writeCapacityUnits
Constraints:
Range: 1 -
Date lastIncreaseDateTime
Date lastDecreaseDateTime
Long numberOfDecreasesToday
Constraints:
Range: 1 -
Long readCapacityUnits
Constraints:
Range: 1 -
Long writeCapacityUnits
Constraints:
Range: 1 -
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Map<K,V> item
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item map is an AttributeValue object.
Map<K,V> expected
Expected allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it.
Each item in Expected represents an attribute name for Amazon DynamoDB to check, along with the following:
Value - The attribute value for Amazon DynamoDB to check.
Exists - Causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:
If Exists is
true
, Amazon DynamoDB will check to see if that attribute
value already exists in the table. If it is found, then the operation
succeeds. If it is not found, the operation fails with a
ConditionalCheckFailedException.
If Exists
is false
, Amazon DynamoDB assumes that the attribute
value does not exist in the table. If in fact the value does
not exist, then the assumption is valid and the operation succeeds. If
the value is found, despite the assumption that it does not exist, the
operation fails with a ConditionalCheckFailedException.
The default setting for Exists is true
.
If you supply a Value all by itself, Amazon DynamoDB assumes
the attribute exists: You don't have to set Exists to
true
, because it is implied.
Amazon DynamoDB returns a ValidationException if:
Exists is
true
but there is no Value to check. (You expect a
value to exist, but don't specify what that value is.)
Exists is false
but you also specify a
Value. (You cannot expect an attribute to have a value, while
also expecting it not to exist.)
If you specify more than one condition for Exists, then all of the conditions must evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the conditional operation will fail.
String returnValues
NONE
-
If ReturnValues is not specified, or if its value is
NONE
, then nothing is returned. (This is the default for
ReturnValues.)
ALL_OLD
- If
PutItem overwrote an attribute name-value pair, then the
content of the old item is returned.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
String returnConsumedCapacity
TOTAL
, ConsumedCapacity is included in
the response; if set to NONE
(the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
String returnItemCollectionMetrics
SIZE
, statistics about item collections, if
any, that were modified during the operation are returned in the
response. If set to NONE
(the default), no statistics are
returned..
Constraints:
Allowed Values: SIZE, NONE
Map<K,V> attributes
ALL_OLD
in the request. Each element consists of an
attribute name and an attribute value.ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
Each ItemCollectionMetrics element consists of:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size, measured in gigabytes. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the secondary indexes on that table. Use this estimate to measure whether a secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
Map<K,V> item
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
String select
ALL_ATTRIBUTES
: Returns all of
the item attributes. For a table, this is the default. For an index,
this mode causes Amazon DynamoDB to fetch the full item from the table
for each matching item in the index. If the index is configured to
project all item attributes, the matching items will not be fetched
from the table. Fetching items from the table incurs additional
throughput cost and latency.
ALL_PROJECTED_ATTRIBUTES
: Allowed only when querying
an index. Retrieves all attributes which have been projected into the
index. If the index is configured to project all attributes, this is
equivalent to specifying ALL_ATTRIBUTES.
COUNT
: Returns the number of matching items, rather
than the matching items themselves.
SPECIFIC_ATTRIBUTES
: Returns only the attributes listed
in AttributesToGet. This is equivalent to specifying
AttributesToGet without specifying any value for Select.
If you are querying an index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
When neither Select nor
AttributesToGet are specified, Amazon DynamoDB defaults to
ALL_ATTRIBUTES
when accessing a table, and
ALL_PROJECTED_ATTRIBUTES
when accessing an index. You
cannot use both Select and AttributesToGet together in a
single request, unless the value for Select is
SPECIFIC_ATTRIBUTES
. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributesToGet
If you are querying an index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
You cannot use both
AttributesToGet and Select together in a Query
request, unless the value for Select is
SPECIFIC_ATTRIBUTES
. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
Constraints:
Length: 1 -
Integer limit
Constraints:
Range: 1 -
Boolean consistentRead
true
, then the operation uses strongly
consistent reads; otherwise, eventually consistent reads are used.Map<K,V> keyConditions
For a query on a table, you
can only have conditions on the table primary key attributes. You must
specify the hash key attribute name and value as an EQ
condition. You can optionally specify a second condition, referring to
the range key attribute.
For a query on a secondary index, you can only have conditions on the index key attributes. You must specify the index hash attribute name and value as an EQ condition. You can optionally specify a second condition, referring to the index key range attribute.
Multiple conditions are evaluated using "AND"; in other words, all of the conditions must be met in order for an item to appear in the results results.
Each KeyConditions element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate
against the supplied attribute. This list contains exactly one value,
except for a For type Number,
value comparisons are numeric. String value comparisons for greater
than, equals, or less than are based on ASCII character code values.
For example, For Binary, Amazon DynamoDB treats each byte of the binary data as
unsigned when it compares binary values, for example when evaluating
query expressions. BETWEEN
or IN
comparison, in
which case the list contains two values. a
is greater than A
, and
aa
is greater than B
. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
Valid comparison operators for Query:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
The following are descriptions of each comparison operator.
EQ
: Equal.
AttributeValueList can contain
only one AttributeValue of type String, Number, or Binary (not
a set). If an item contains an AttributeValue of a different
type than the one specified in the request, the value does not match.
For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not equal
{"NS":["6", "2", "1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only
one AttributeValue of type String, Number, or Binary (not a
set). If an item contains an AttributeValue of a different type
than the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
GE
: Greater than or
equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
BEGINS_WITH
: checks
for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
BETWEEN
: Greater than or equal to the first value, and less than or equal to
the second value.
AttributeValueList must contain two
AttributeValue elements of the same type, either String,
Number, or Binary (not a set). A target attribute matches if the
target value is greater than, or equal to, the first element and less
than, or equal to, the second element. If an item contains an
AttributeValue of a different type than the one specified in
the request, the value does not match. For example,
{"S":"6"}
does not compare to {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
Boolean scanIndexForward
If ScanIndexForward is not specified, the results are returned in ascending order.
Map<K,V> exclusiveStartKey
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
String returnConsumedCapacity
TOTAL
, ConsumedCapacity is included in
the response; if set to NONE
(the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
Integer count
Map<K,V> lastEvaluatedKey
LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).
ConsumedCapacity consumedCapacity
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributesToGet
Constraints:
Length: 1 -
Integer limit
Constraints:
Range: 1 -
String select
ALL_ATTRIBUTES
: Returns all of
the item attributes. For a table, this is the default. For an index,
this mode causes Amazon DynamoDB to fetch the full item from the table
for each matching item in the index. If the index is configured to
project all item attributes, the matching items will not be fetched
from the table. Fetching items from the table incurs additional
throughput cost and latency.
ALL_PROJECTED_ATTRIBUTES
: Retrieves all attributes
which have been projected into the index. If the index is configured
to project all attributes, this is equivalent to specifying
ALL_ATTRIBUTES.
COUNT
: Returns the
number of matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
: Returns only the
attributes listed in AttributesToGet. This is equivalent to
specifying AttributesToGet without specifying any value for
Select.
If you are querying an index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
When neither
Select nor AttributesToGet are specified, Amazon
DynamoDB defaults to ALL_ATTRIBUTES
when accessing a
table, and ALL_PROJECTED_ATTRIBUTES
when accessing an
index. You cannot use both Select and AttributesToGet
together in a single request, unless the value for
Select is SPECIFIC_ATTRIBUTES
. (This usage is
equivalent to specifying AttributesToGet without any value for
Select.)
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
Map<K,V> scanFilter
Each ScanConditions element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate
against the supplied attribute. This list contains exactly one value,
except for a For type Number,
value comparisons are numeric. String value comparisons for greater
than, equals, or less than are based on ASCII character code values.
For example, For Binary, Amazon DynamoDB treats each byte of the binary data as
unsigned when it compares binary values, for example when evaluating
query expressions. BETWEEN
or IN
comparison, in
which case the list contains two values. a
is greater than A
, and
aa
is greater than B
. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
Valid comparison operators for Scan:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS |
NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
The following are descriptions of each comparison operator.
EQ
: Equal.
AttributeValueList can contain
only one AttributeValue of type String, Number, or Binary (not
a set). If an item contains an AttributeValue of a different
type than the one specified in the request, the value does not match.
For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not equal
{"NS":["6", "2", "1"]}
.
NE
: Not equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not equal {"NS":["6", "2",
"1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
GE
: Greater than or
equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified in the request, the value does not match. For
example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6",
"2", "1"]}
.
NOT_NULL
: The
attribute exists.
NULL
: The attribute does
not exist.
CONTAINS
: checks for a
subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for a member of the set (not as a substring).
NOT_CONTAINS
: checks for absence of a
subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for the absence of a member of the set (not as a substring).
BEGINS_WITH
: checks for a
prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
IN
:
checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
BETWEEN
: Greater than or equal to the
first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a
set). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue of a different
type than the one specified in the request, the value does not match.
For example, {"S":"6"}
does not compare to
{"N":"6"}
. Also, {"N":"6"}
does not compare
to {"NS":["6", "2", "1"]}
Map<K,V> exclusiveStartKey
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
String returnConsumedCapacity
TOTAL
, ConsumedCapacity is included in
the response; if set to NONE
(the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
Integer totalSegments
The value for TotalSegments must be greater than or equal to 1, and less than or equal to 4096. If you specify a TotalSegments value of 1, the Scan will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
Constraints:
Range: 1 - 4096
Integer segment
Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application threads, the first thread would specify a Segment value of 0, the second thread would specify 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same Segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
If you specify Segment, you must also specify TotalSegments.
Constraints:
Range: 0 - 4095
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
Integer count
Integer scannedCount
Map<K,V> lastEvaluatedKey
LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).
If there are no remaining table or segment items to be scanned, LastEvaluatedKey is returned as null.
ConsumedCapacity consumedCapacity
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeDefinitions
Each AttributeDefinition object in this array is composed of:
AttributeName - The name of the attribute.
AttributeType - The data type for the attribute.
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
AttributeName - The name of the attribute.
KeyType - The key type for the
attribute. Can be either HASH
or RANGE
.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Constraints:
Length: 1 - 2
String tableStatus
CREATING - The table is being created, as the result of a CreateTable operation.
UPDATING - The table is being updated, as the result of an UpdateTable operation.
DELETING - The table is being deleted, as the result of a DeleteTable operation.
ACTIVE - The table is ready for use.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
Date creationDateTime
ProvisionedThroughputDescription provisionedThroughput
Long tableSizeBytes
Long itemCount
com.amazonaws.internal.ListWithAutoConstructFlag<T> localSecondaryIndexes
IndexName - The name of the secondary index.
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY
- Only the index and primary keys are
projected into the index.
INCLUDE
- Only
the specified table attributes are projected into the index. The list
of projected attributes are in NonKeyAttributes.
ALL
- All of the table attributes are projected into
the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the index. The total count of attributes specified in NonKeyAttributes, summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
IndexSizeBytes - Represents the total size of the index, in bytes. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount - Represents the number of items in the index. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the
DELETING
state, no information about indexes will be
returned.
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Map<K,V> key
Map<K,V> attributeUpdates
Attribute values cannot be null. String and binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException.
Each AttributeUpdates element consists of an attribute name to modify, along with the following:
Value - The new value, if applicable, for this attribute.
Action - Specifies how to perform the
update. Valid values for Action are PUT
,
DELETE
, and ADD
. The behavior depends on
whether the specified primary key already exists in the table.
If an item with the specified Key is found in the table:
PUT
- Adds the specified attribute to the
item. If the attribute already exists, it is replaced by the new
value.
DELETE
- If no value is specified,
the attribute and its value are removed from the item. The data type
of the specified value must match the existing value's data type.
If a set of values is specified, then those values are
subtracted from the old set. For example, if the attribute value was
the set [a,b,c]
and the DELETE action specified
[a,c]
, then the final attribute value would be
[b]
. Specifying an empty set is an error.
ADD
- If the attribute does not already exist, then
the attribute and its values are added to the item. If the attribute
does exist, then the behavior of ADD
depends on the data
type of the attribute:
If the existing attribute is a
number, and if Value is also a number, then the Value is
mathematically added to the existing attribute. If Value is a
negative number, then it is subtracted from the existing attribute.
If you use In addition, if you use
ADD
to increment or decrement a
number value for an item that doesn't exist before the update, Amazon
DynamoDB uses 0 as the initial value. ADD
to update an existing item, and intend to increment
or decrement an attribute value which does not yet exist, Amazon
DynamoDB uses 0
as the initial value. For example,
suppose that the item you want to update does not yet have an
attribute named itemcount, but you decide to ADD
the number 3
to this attribute anyway, even though it
currently does not exist. Amazon DynamoDB will create the
itemcount attribute, set its initial value to 0
,
and finally add 3
to it. The result will be a new
itemcount attribute in the item, with a value of
3
.
If the existing data type is a
set, and if the Value is also a set, then the Value is
added to the existing set. (This is a set operation, not
mathematical addition.) For example, if the attribute value was the
set [1,2]
, and the ADD
action specified
[3]
, then the final attribute value would be
[1,2,3]
. An error occurs if an Add action is specified
for a set attribute and the attribute type specified does not match
the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid
for an existing attribute whose data type is number or is a set. Do
not use ADD
for any other data types.
If no item with the specified Key is found:
PUT
- Amazon DynamoDB creates a new item with the
specified primary key, and then adds the attribute.
DELETE
- Nothing happens; there is no attribute to
delete.
ADD
- Amazon DynamoDB creates an
item with the supplied primary key and number (or set of numbers) for
the attribute value. The only data types allowed are number and number
set; no other data types can be specified.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
Map<K,V> expected
Expected allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it.
Each item in Expected represents an attribute name for Amazon DynamoDB to check, along with the following:
Value - The attribute value for Amazon DynamoDB to check.
Exists - Causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:
If Exists is
true
, Amazon DynamoDB will check to see if that attribute
value already exists in the table. If it is found, then the operation
succeeds. If it is not found, the operation fails with a
ConditionalCheckFailedException.
If Exists
is false
, Amazon DynamoDB assumes that the attribute
value does not exist in the table. If in fact the value does
not exist, then the assumption is valid and the operation succeeds. If
the value is found, despite the assumption that it does not exist, the
operation fails with a ConditionalCheckFailedException.
The default setting for Exists is true
.
If you supply a Value all by itself, Amazon DynamoDB assumes
the attribute exists: You don't have to set Exists to
true
, because it is implied.
Amazon DynamoDB returns a ValidationException if:
Exists is
true
but there is no Value to check. (You expect a
value to exist, but don't specify what that value is.)
Exists is false
but you also specify a
Value. (You cannot expect an attribute to have a value, while
also expecting it not to exist.)
If you specify more than one condition for Exists, then all of the conditions must evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the conditional operation will fail.
String returnValues
NONE
- If ReturnValues is not specified, or if
its value is NONE
, then nothing is returned. (This is the
default for ReturnValues.)
ALL_OLD
-
If UpdateItem overwrote an attribute name-value pair, then the
content of the old item is returned.
UPDATED_OLD
- The old versions of only the updated
attributes are returned.
ALL_NEW
- All of
the attributes of the new version of the item are returned.
UPDATED_NEW
- The new versions of only the updated
attributes are returned.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
String returnConsumedCapacity
TOTAL
, ConsumedCapacity is included in
the response; if set to NONE
(the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
String returnItemCollectionMetrics
SIZE
, statistics about item collections, if
any, that were modified during the operation are returned in the
response. If set to NONE
(the default), no statistics are
returned..
Constraints:
Allowed Values: SIZE, NONE
Map<K,V> attributes
NONE
in the request.
Each element represents one attribute.ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
ProvisionedThroughput provisionedThroughput
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
TableDescription tableDescription
PutRequest putRequest
DeleteRequest deleteRequest
String attributeName
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeValues
String attributeValue
String domain
vpc
to allocate the address to your VPC. By
default, will allocate to EC2.
Constraints:
Allowed Values: vpc, standard
String instanceId
String publicIp
String allocationId
String networkInterfaceId
String privateIpAddress
Boolean allowReassociation
String associationId
String associationId
String attachmentId
String volumeId
String instanceId
String device
/dev/sdh
).VolumeAttachment attachment
VpcAttachment vpcAttachement
String groupId
String sourceSecurityGroupName
String sourceSecurityGroupOwnerId
String ipProtocol
Integer fromPort
Integer toPort
String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
String groupName
String groupId
String sourceSecurityGroupName
String sourceSecurityGroupOwnerId
String ipProtocol
Integer fromPort
Integer toPort
String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
String zoneName
String state
String regionName
com.amazonaws.internal.ListWithAutoConstructFlag<T> messages
String message
String virtualName
String deviceName
/dev/sdh
).EbsBlockDevice ebs
String noDevice
BundleTask bundleTask
String instanceId
String bundleId
String state
Date startTime
Date updateTime
Storage storage
String progress
BundleTaskError bundleTaskError
String bundleId
BundleTask bundleTask
String exportTaskId
String reservedInstancesListingId
String ownerId
String conversionTaskId
String expirationTime
ImportInstanceTaskDetails importInstance
ImportVolumeTaskDetails importVolume
String state
String statusMessage
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String imageId
String snapshotId
String type
String publicIp
Integer bgpAsn
CustomerGateway customerGateway
DhcpOptions dhcpOptions
String instanceId
String name
String description
Boolean noReboot
false
, which means
Amazon EC2 attempts to cleanly shut down the instance before image
creation and reboots the instance afterwards. When set to true, Amazon
EC2 will not shut down the instance before creating the image. When
this option is used, file system integrity on the created image cannot
be guaranteed.com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
String imageId
String description
String instanceId
String targetEnvironment
ExportToS3TaskSpecification exportToS3Task
ExportTask exportTask
InternetGateway internetGateway
String keyName
KeyPair keyPair
String networkAclId
Integer ruleNumber
String protocol
tcp
,
udp
, icmp
or an IP protocol number.String ruleAction
Constraints:
Allowed Values: allow, deny
Boolean egress
true
) or ingress traffic to the subnet
(false
).String cidrBlock
172.16.0.0/24
).IcmpTypeCode icmpTypeCode
PortRange portRange
String vpcId
NetworkAcl networkAcl
String subnetId
String description
String privateIpAddress
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
Integer secondaryPrivateIpAddressCount
NetworkInterface networkInterface
String routeTableId
String destinationCidrBlock
0.0.0.0/0
. Routing decisions are based on the most
specific match.String gatewayId
GatewayId
or InstanceId
, but
not both.String instanceId
GatewayId
or InstanceId
, but not both.String networkInterfaceId
String vpcId
RouteTable routeTable
String groupId
Snapshot snapshot
SpotDatafeedSubscription spotDatafeedSubscription
Subnet subnet
com.amazonaws.internal.ListWithAutoConstructFlag<T> resources
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Integer size
String snapshotId
String availabilityZone
String volumeType
Integer iops
Volume volume
Vpc vpc
String type
String customerGatewayId
String vpnGatewayId
VpnConnectionOptionsSpecification options
VpnConnection vpnConnection
VpnGateway vpnGateway
String customerGatewayId
String state
pending
, available
, deleting
,
and deleted
.String type
String ipAddress
String bgpAsn
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String customerGatewayId
String dhcpOptionsId
String internetGatewayId
String keyName
String networkAclId
String networkInterfaceId
String groupName
PlacementGroup
to delete.String routeTableId
String snapshotId
String subnetId
com.amazonaws.internal.ListWithAutoConstructFlag<T> resources
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
If a tag is specified without a value, the tag and all of its values are deleted.
String volumeId
String vpcId
String vpnConnectionId
String vpnGatewayId
String imageId
com.amazonaws.internal.ListWithAutoConstructFlag<T> publicIps
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> allocationIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> zoneNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> bundleIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> customerGatewayIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> dhcpOptionsIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
ImageAttribute imageAttribute
com.amazonaws.internal.ListWithAutoConstructFlag<T> imageIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> owners
self
: AMIs owned by you aws-marketplace
: AMIs owned by the AWS Marketplace amazon
: AMIs owned by Amazon all
: Do not scope the AMIs returned by owner The values self
, aws-marketplace
,
amazon
, and all
are literals.
com.amazonaws.internal.ListWithAutoConstructFlag<T> executableUsers
self
: AMIs for which you have explicit launch
permissions AWS account ID
: AMIs for which
this account ID has launch permissions all
:
AMIs that have public launch permissions The values
self
and all
are literals.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
String instanceId
String attribute
Available attribute names:
instanceType
, kernel
, ramdisk
,
userData
, disableApiTermination
,
instanceInitiatedShutdownBehavior
,
rootDeviceName
, blockDeviceMapping
Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized
InstanceAttribute instanceAttribute
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
String nextToken
Integer maxResults
Boolean includeAllInstances
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceStatuses
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> internetGatewayIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> keyNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> licenseIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkAclIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
String networkInterfaceId
String description
Boolean sourceDestCheck
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
NetworkInterfaceAttachment attachment
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
PlacementGroup
.com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> regionNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesModificationIds
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesModifications
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesOfferingIds
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.xlarge, m3.2xlarge, c1.medium, c1.xlarge, hi1.4xlarge, hs1.8xlarge, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge
String availabilityZone
String productDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
String instanceTenancy
String offeringType
String nextToken
Integer maxResults
Boolean includeMarketplace
Long minDuration
Long maxDuration
Integer maxInstanceCount
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesOfferings
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
String offeringType
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeTableIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
String snapshotId
com.amazonaws.internal.ListWithAutoConstructFlag<T> createVolumePermissions
Only available if the createVolumePermission attribute is requested.
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> ownerIds
self
: Snapshots
owned by you amazon
: Snapshots owned by
Amazon The values self
and
amazon
are literals.
com.amazonaws.internal.ListWithAutoConstructFlag<T> restorableByUserIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
SpotDatafeedSubscription spotDatafeedSubscription
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotInstanceRequestIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Date startTime
Date endTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceTypes
com.amazonaws.internal.ListWithAutoConstructFlag<T> productDescriptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
String availabilityZone
Integer maxResults
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotPriceHistory
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeStatuses
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpnConnectionIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpnGatewayIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
String volumeId
String instanceId
String device
Boolean force
This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance will not have an opportunity to flush file system caches nor file system meta data. If you use this option, you must perform file system check and repair procedures.
VolumeAttachment attachment
String key
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
String dhcpOptionsId
com.amazonaws.internal.ListWithAutoConstructFlag<T> dhcpConfigurations
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String associationId
DiskImageDetail image
String description
VolumeDetail volume
String snapshotId
Integer volumeSize
Boolean deleteOnTermination
String volumeType
Integer iops
String volumeId
String status
Date attachTime
Boolean deleteOnTermination
String volumeId
String exportTaskId
String description
String state
String statusMessage
InstanceExportDetails instanceExportDetails
ExportToS3Task exportToS3Task
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
String instanceId
String instanceId
String imageId
String imageLocation
String state
Constraints:
Allowed Values: available, deregistered
String ownerId
Boolean publicValue
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
String architecture
String imageType
String kernelId
String ramdiskId
String platform
StateReason stateReason
String imageOwnerAlias
String name
String description
String rootDeviceType
String rootDeviceName
/dev/sda1
).com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
String virtualizationType
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String hypervisor
String imageId
com.amazonaws.internal.ListWithAutoConstructFlag<T> launchPermissions
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
String kernelId
String ramdiskId
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
String architecture
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
String additionalInfo
String userData
String instanceType
Placement placement
Boolean monitoring
String subnetId
String instanceInitiatedShutdownBehavior
String privateIpAddress
String description
ImportInstanceLaunchSpecification launchSpecification
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskImages
String platform
ConversionTask conversionTask
Long bytesConverted
String availabilityZone
DiskImageDescription image
DiskImageVolumeDescription volume
String status
String statusMessage
String description
String availabilityZone
DiskImageDetail image
String description
VolumeDetail volume
ConversionTask conversionTask
Long bytesConverted
String availabilityZone
String description
DiskImageDescription image
DiskImageVolumeDescription volume
String instanceId
String imageId
InstanceState state
String privateDnsName
String publicDnsName
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, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.xlarge, m3.2xlarge, c1.medium, c1.xlarge, hi1.4xlarge, hs1.8xlarge, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge
Date launchTime
Placement placement
String kernelId
String ramdiskId
String platform
Monitoring monitoring
String subnetId
String vpcId
String privateIpAddress
String publicIpAddress
StateReason stateReason
String architecture
String rootDeviceType
String rootDeviceName
/dev/sda1
).com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
String virtualizationType
String instanceLifecycle
String spotInstanceRequestId
InstanceLicense license
String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
Boolean sourceDestCheck
String hypervisor
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfile iamInstanceProfile
Boolean ebsOptimized
String instanceId
String instanceType
m1.small
,
c1.medium
, m2.2xlarge
, and so on).String kernelId
String ramdiskId
String userData
Boolean disableApiTermination
String instanceInitiatedShutdownBehavior
String rootDeviceName
/dev/sda1
).com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
Boolean ebsOptimized
String deviceName
/dev/sdh
) at which the block
device is exposed on the instance.EbsInstanceBlockDevice ebs
String deviceName
/dev/sdh
) at which the block
device is exposed on the instance.EbsInstanceBlockDeviceSpecification ebs
String virtualName
String noDevice
String pool
'windows'
).String pool
RunInstances
request.String instanceId
Monitoring monitoring
String networkInterfaceId
String subnetId
String vpcId
String description
String ownerId
String status
String privateIpAddress
String privateDnsName
Boolean sourceDestCheck
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
InstanceNetworkInterfaceAttachment attachment
InstanceNetworkInterfaceAssociation association
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
String networkInterfaceId
Integer deviceIndex
Condition: If you are specifying a network interface in the request, you must provide the device index.
String subnetId
String description
String privateIpAddress
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
Boolean deleteOnTermination
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
Integer secondaryPrivateIpAddressCount
Boolean associatePublicIpAddress
true
, the following rules apply:
Can only be associated with a single network interface with the device index of 0. You can't associate a public IP address with a second network interface, and you can't associate a public IP address if you are launching more than one network interface.
Can only be associated with a new network interface, not an existing one.
Default: If launching into a default
subnet, the default value is true
. If launching into a
nondefault subnet, the default value is false
.
String privateIpAddress
String privateDnsName
Boolean primary
InstanceNetworkInterfaceAssociation association
Integer code
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
InstanceStatusSummary systemStatus
InstanceStatusSummary instanceStatus
String code
String description
Date notBefore
Date notAfter
String status
com.amazonaws.internal.ListWithAutoConstructFlag<T> details
String internetGatewayId
com.amazonaws.internal.ListWithAutoConstructFlag<T> attachments
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String ipProtocol
Valid protocol values:
tcp
, udp
, icmp
Integer fromPort
-1
indicates a wildcard
(i.e., any ICMP type number).Integer toPort
-1
indicates a wildcard (i.e., any ICMP
code).com.amazonaws.internal.ListWithAutoConstructFlag<T> userIdGroupPairs
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipRanges
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, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.xlarge, m3.2xlarge, c1.medium, c1.xlarge, hi1.4xlarge, hs1.8xlarge, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge
SpotPlacement placement
String kernelId
String ramdiskId
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
Boolean monitoringEnabled
String subnetId
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfileSpecification iamInstanceProfile
Boolean ebsOptimized
String licenseId
String type
String pool
com.amazonaws.internal.ListWithAutoConstructFlag<T> capacities
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Integer capacity
Integer instanceCapacity
String state
Date earliestAllowedDeactivationTime
String imageId
String attribute
Available
attributes: launchPermission
, productCodes
String operationType
Available operation types:
add
, remove
com.amazonaws.internal.ListWithAutoConstructFlag<T> userIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> userGroups
Available user
groups: all
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
String value
LaunchPermissionModifications launchPermission
String description
String instanceId
String attribute
Available attribute
names: instanceType
, kernel
,
ramdisk
, userData
,
disableApiTermination
,
instanceInitiatedShutdownBehavior
,
rootDevice
, blockDeviceMapping
Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized
String value
Only valid
when kernel
, ramdisk
, userData
,
disableApiTermination
or
instanceInitiateShutdownBehavior
is specified as the
attribute being modified.
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
Only valid when blockDeviceMapping is specified as the attribute being modified.
Boolean sourceDestCheck
Boolean disableApiTermination
String instanceType
String kernel
String ramdisk
String userData
String instanceInitiatedShutdownBehavior
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
Boolean ebsOptimized
String networkInterfaceId
String description
Boolean sourceDestCheck
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
Available attribute
names: createVolumePermission
Constraints:
Allowed Values: productCodes, createVolumePermission
String operationType
Available operation
names: add
, remove
com.amazonaws.internal.ListWithAutoConstructFlag<T> userIds
createVolumePermission
attribute is being modified.
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
createVolumePermission
attribute is being modified.
CreateVolumePermissionModifications createVolumePermission
String state
String networkInterfaceId
String subnetId
String vpcId
String availabilityZone
String description
String ownerId
String requesterId
Boolean requesterManaged
String status
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 privateIpAddress
String privateDnsName
Boolean primary
NetworkInterfaceAssociation association
String availabilityZone
String groupName
String tenancy
String groupName
PlacementGroup
.String strategy
PlacementGroup
.
Constraints:
Allowed Values: cluster
String state
PlacementGroup
.
Constraints:
Allowed Values: pending, available, deleting, deleted
String gatewayId
String reservedInstancesOfferingId
Integer instanceCount
ReservedInstanceLimitPrice limitPrice
String reservedInstancesId
String imageLocation
String name
Constraints: 3-128
alphanumeric characters, parenthesis (()
), commas
(,
), slashes (/
), dashes (-
),
or underscores(_
)
String description
String architecture
Valid Values: i386
,
x86_64
String kernelId
String ramdiskId
Some kernels require additional drivers at launch. Check the kernel requirements for information on whether you need to specify a RAM disk.
String rootDeviceName
/dev/sda1
).com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
String imageId
String newAssociationId
String networkAclId
Integer ruleNumber
String protocol
tcp
,
udp
, icmp
or an IP protocol number.String ruleAction
Constraints:
Allowed Values: allow, deny
Boolean egress
true
) or ingress traffic (false
).String cidrBlock
172.16.0.0/24
).IcmpTypeCode icmpTypeCode
PortRange portRange
String routeTableId
String destinationCidrBlock
0.0.0.0/0
. The value you provide must match the CIDR of
an existing route in the table.String gatewayId
String instanceId
String networkInterfaceId
String newAssociationId
String spotPrice
Integer instanceCount
String type
Constraints:
Allowed Values: one-time, persistent
Date validFrom
If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
Date validUntil
If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
String launchGroup
String availabilityZoneGroup
When specifying the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.
LaunchSpecification launchSpecification
String reservationId
String ownerId
String requesterId
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
String reservedInstancesId
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.xlarge, m3.2xlarge, c1.medium, c1.xlarge, hi1.4xlarge, hs1.8xlarge, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge
String availabilityZone
Date start
Date end
Long duration
Float usagePrice
Float fixedPrice
Integer instanceCount
String productDescription
String state
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String instanceTenancy
String currencyCode
String offeringType
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String availabilityZone
String platform
Integer instanceCount
String reservedInstancesId
String reservedInstancesListingId
String reservedInstancesId
Date createDate
Date updateDate
String status
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, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.xlarge, m3.2xlarge, c1.medium, c1.xlarge, hi1.4xlarge, hs1.8xlarge, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge
String availabilityZone
Long duration
Float usagePrice
Float fixedPrice
String productDescription
String instanceTenancy
String currencyCode
String offeringType
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
Boolean marketplace
com.amazonaws.internal.ListWithAutoConstructFlag<T> pricingDetails
String instanceId
String attribute
Available attribute names:
kernel
, ramdisk
Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized
String groupId
String sourceSecurityGroupName
String sourceSecurityGroupOwnerId
String ipProtocol
Integer fromPort
Integer toPort
String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
String groupName
String groupId
String sourceSecurityGroupName
String sourceSecurityGroupOwnerId
String ipProtocol
Integer fromPort
Integer toPort
String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
String routeTableId
String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> routes
com.amazonaws.internal.ListWithAutoConstructFlag<T> associations
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> propagatingVgws
String imageId
Integer minCount
Integer maxCount
Between 1 and the maximum number allowed for your account (default: 20).
String keyName
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
String userData
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.xlarge, m3.2xlarge, c1.medium, c1.xlarge, hi1.4xlarge, hs1.8xlarge, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge
Placement placement
String kernelId
String ramdiskId
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
Boolean monitoring
String subnetId
Boolean disableApiTermination
String instanceInitiatedShutdownBehavior
InstanceLicenseSpecification license
String privateIpAddress
String clientToken
String additionalInfo
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfileSpecification iamInstanceProfile
Boolean ebsOptimized
Reservation reservation
String bucket
If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
String prefix
String aWSAccessKeyId
String uploadPolicy
String uploadPolicySignature
String ownerId
String groupName
String groupId
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissionsEgress
String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String snapshotId
String volumeId
String state
Constraints:
Allowed Values: pending, completed, error
Date startTime
String progress
String ownerId
String description
Integer volumeSize
String ownerAlias
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String ownerId
String bucket
String prefix
String state
SpotInstanceStateFault fault
String spotInstanceRequestId
String spotPrice
String type
String state
SpotInstanceStateFault fault
SpotInstanceStatus status
Date validFrom
Date validUntil
String launchGroup
String availabilityZoneGroup
LaunchSpecification launchSpecification
String instanceId
Date createTime
String productDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String launchedAvailabilityZone
String availabilityZone
String groupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
String additionalInfo
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
Boolean force
S3Storage s3
String subnetId
String state
pending
or available
.String vpcId
String cidrBlock
Integer availableIpAddressCount
The IP addresses for any stopped instances are considered unavailable.
String availabilityZone
Boolean defaultForAz
Boolean mapPublicIpOnLaunch
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String resourceId
String resourceType
Constraints:
Allowed Values: customer-gateway, dhcp-options, image, instance, snapshot, spot-instances-request, subnet, volume, vpc, vpn-connection, vpn-gateway
String key
String value
String networkInterfaceId
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
String userId
String groupName
String groupId
String volumeId
Integer size
String snapshotId
String availabilityZone
String state
Constraints:
Allowed Values: creating, available, in-use, deleting, error
Date createTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> attachments
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String volumeType
Integer iops
String volumeId
String instanceId
String device
/dev/sdh
).String state
Constraints:
Allowed Values: attaching, attached, detaching, detached
Date attachTime
Boolean deleteOnTermination
Whether this volume will be deleted or not when the associated instance is terminated.
Long size
String status
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
pending
or available
.String cidrBlock
String dhcpOptionsId
default
if the default options are
associated with the VPC.com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String instanceTenancy
Boolean isDefault
String vpnConnectionId
String state
pending
, available
, deleting
,
and deleted
.String customerGatewayConfiguration
This element is always present
in the CreateVpnConnection response; however, it's present in the
DescribeVpnConnections response only if the VPN connection is in the
pending
or available
state.
String type
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
pending
, available
, deleting
,
and deleted
.String type
String availabilityZone
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcAttachments
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String cacheSecurityGroupName
String eC2SecurityGroupName
String eC2SecurityGroupOwnerId
String name
String cacheClusterId
Endpoint configurationEndpoint
String clientDownloadLandingPage
String cacheNodeType
String engine
String engineVersion
String cacheClusterStatus
Integer numCacheNodes
String preferredAvailabilityZone
Date cacheClusterCreateTime
String preferredMaintenanceWindow
PendingModifiedValues pendingModifiedValues
NotificationConfiguration notificationConfiguration
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroups
CacheParameterGroupStatus cacheParameterGroup
String cacheSubnetGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodes
Boolean autoMinorVersionUpgrade
true
, then minor version patches are applied
automatically; if false
, then automatic minor version
patches are disabled.com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
String replicationGroupId
String engine
String engineVersion
String cacheParameterGroupFamily
String cacheEngineDescription
String cacheEngineVersionDescription
String cacheNodeId
String cacheNodeStatus
Date cacheNodeCreateTime
Endpoint endpoint
String parameterGroupStatus
String sourceCacheNodeId
String parameterName
String description
String source
String dataType
String allowedValues
Boolean isModifiable
true
) or not (false
) the
parameter can be modified. Some parameters have security or
operational implications that prevent them from being changed.String minimumEngineVersion
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeTypeSpecificValues
String cacheParameterGroupName
String cacheParameterGroupFamily
String description
String cacheParameterGroupName
String parameterApplyStatus
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeIdsToReboot
String ownerId
String cacheSecurityGroupName
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> eC2SecurityGroups
String cacheSubnetGroupName
String cacheSubnetGroupDescription
String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
String cacheClusterId
Constraints:
String replicationGroupId
Integer numCacheNodes
For a Memcached cluster, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at .
For Redis, only single-node cache clusters are supported at this time, so the value for this parameter must be 1.
String cacheNodeType
Valid values for Memcached:
cache.t1.micro
|
cache.m1.small
| cache.m1.medium
|
cache.m1.large
| cache.m1.xlarge
|
cache.m3.xlarge
| cache.m3.2xlarge
|
cache.m2.xlarge
| cache.m2.2xlarge
|
cache.m2.4xlarge
| cache.c1.xlarge
Valid values for Redis:
cache.t1.micro
|
cache.m1.small
| cache.m1.medium
|
cache.m1.large
| cache.m1.xlarge
|
cache.m2.xlarge
| cache.m2.2xlarge
|
cache.m2.4xlarge
| cache.c1.xlarge
For a complete listing of cache node types and specifications, see .
String engine
Valid values for this parameter are:
memcached
|
redis
String engineVersion
String cacheParameterGroupName
String cacheSubnetGroupName
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroupNames
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotArns
Here is an example of an Amazon S3 ARN:
arn:aws:s3:::my_bucket/snapshot1.rdb
Note: This
parameter is only valid if the Engine
parameter is
redis
.
String preferredAvailabilityZone
All cache nodes belonging to a cache cluster are placed in the preferred availability zone.
Default: System chosen availability zone.
String preferredMaintenanceWindow
Example: sun:05:00-sun:09:00
Integer port
String notificationTopicArn
Boolean autoMinorVersionUpgrade
true
allows these upgrades to occur; false
disables automatic upgrades. Default: true
String cacheParameterGroupName
String cacheParameterGroupFamily
Valid values are: memcached1.4
|
redis2.6
String description
String cacheSecurityGroupName
Constraints: Must contain no more than 255 alphanumeric characters. Must not be the word "Default".
Example:
mysecuritygroup
String description
String cacheSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example: mysubnetgroup
String cacheSubnetGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
String replicationGroupId
Constraints:
String primaryClusterId
String replicationGroupDescription
String cacheClusterId
String cacheParameterGroupName
String cacheSecurityGroupName
String cacheSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
String replicationGroupId
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
Integer maxRecords
MaxRecords
value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String sourceIdentifier
String sourceType
Valid values are: cache-cluster
|
cache-parameter-group
| cache-security-group
| cache-subnet-group
Constraints:
Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
Date startTime
Date endTime
Integer duration
Integer maxRecords
MaxRecords
value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String replicationGroupId
If you do not specify this parameter, information about all replication groups is returned.
Integer maxRecords
MaxRecords
value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> replicationGroups
String reservedCacheNodesOfferingId
Example:
438012d3-4052-4cc7-b2e3-8d3372e0e706
String cacheNodeType
String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
String productDescription
String offeringType
Valid
Values: "Light Utilization" | "Medium Utilization" | "Heavy
Utilization"
Integer maxRecords
MaxRecords
value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedCacheNodesOfferings
String reservedCacheNodeId
String reservedCacheNodesOfferingId
String cacheNodeType
String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
String productDescription
String offeringType
Valid
values: "Light Utilization" | "Medium Utilization" | "Heavy
Utilization"
Integer maxRecords
MaxRecords
value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedCacheNodes
String cacheParameterGroupFamily
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeTypeSpecificParameters
String sourceIdentifier
String sourceType
Constraints:
Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
String message
Date date
String cacheClusterId
Integer numCacheNodes
If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to be removed.
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeIdsToRemove
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroupNames
This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).
String preferredMaintenanceWindow
String notificationTopicArn
String cacheParameterGroupName
String notificationTopicStatus
Valid values:
active
| inactive
Boolean applyImmediately
true
, this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the cache cluster. If
false
, then changes to the cache cluster are applied on
the next maintenance reboot, or the next failure reboot, whichever
occurs first.
Valid values: true
| false
Default: false
String engineVersion
Boolean autoMinorVersionUpgrade
true
, then minor engine upgrades will be applied
automatically to the cache cluster during the maintenance window.
Valid values: true
| false
Default:
true
String cacheParameterGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterNameValues
String cacheParameterGroupName
String cacheSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example:
mysubnetgroup
String cacheSubnetGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
String replicationGroupId
String replicationGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroupNames
This parameter can be used only with replication groups containing cache clusters running outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
This parameter can be used only with replication groups containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
String preferredMaintenanceWindow
String notificationTopicArn
String cacheParameterGroupName
String notificationTopicStatus
Valid values: active
| inactive
Boolean applyImmediately
true
, this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the replication group.
If false
, then changes to the nodes in the replication
group are applied on the next maintenance reboot, or the next failure
reboot, whichever occurs first.
Valid values: true
|
false
Default: false
String engineVersion
Boolean autoMinorVersionUpgrade
true
allows these upgrades
to occur; false
disables automatic upgrades.String primaryClusterId
String nodeGroupId
String status
Endpoint primaryEndpoint
com.amazonaws.internal.ListWithAutoConstructFlag<T> nodeGroupMembers
String cacheClusterId
String cacheNodeId
Endpoint readEndpoint
String preferredAvailabilityZone
String currentRole
String parameterName
String parameterValue
String description
String source
String dataType
String allowedValues
Boolean isModifiable
true
) or not (false
) the
parameter can be modified. Some parameters have security or
operational implications that prevent them from being changed.String minimumEngineVersion
Integer numCacheNodes
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeIdsToRemove
String engineVersion
String reservedCacheNodesOfferingId
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
String reservedCacheNodeId
Example: myreservationID
Integer cacheNodeCount
Default:
1
String cacheClusterId
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeIdsToReboot
String replicationGroupId
String description
String status
ReplicationGroupPendingModifiedValues pendingModifiedValues
com.amazonaws.internal.ListWithAutoConstructFlag<T> memberClusters
com.amazonaws.internal.ListWithAutoConstructFlag<T> nodeGroups
String primaryClusterId
--apply-immediately
was specified), or during the next
maintenance window.String reservedCacheNodeId
String reservedCacheNodesOfferingId
String cacheNodeType
Date startTime
Integer duration
Double fixedPrice
Double usagePrice
Integer cacheNodeCount
String productDescription
String offeringType
String state
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String reservedCacheNodesOfferingId
String cacheNodeType
Integer duration
Double fixedPrice
Double usagePrice
String productDescription
String offeringType
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String cacheParameterGroupName
Boolean resetAllParameters
Valid values: true
| false
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterNameValues
String cacheParameterGroupName
String cacheSecurityGroupName
String eC2SecurityGroupName
String eC2SecurityGroupOwnerId
String subnetIdentifier
AvailabilityZone subnetAvailabilityZone
String applicationName
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
Date dateCreated
Date dateUpdated
com.amazonaws.internal.ListWithAutoConstructFlag<T> versions
com.amazonaws.internal.ListWithAutoConstructFlag<T> configurationTemplates
String applicationName
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
String versionLabel
Constraints:
Length: 1 - 100
S3Location sourceBundle
Date dateCreated
Date dateUpdated
String name
AutoScalingGroup
.String cNAMEPrefix
Constraints:
Length: 4 - 63
Boolean available
true
: The CNAME is available.
true
: The CNAME is not
available.
true
:
The CNAME is available. false
: The CNAME is
not available. String fullyQualifiedCNAME
Constraints:
Length: 1 - 255
String namespace
String name
String defaultValue
String changeSeverity
NoInterruption - There is no interruption to the environment or application availability.
RestartEnvironment - The environment is restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.
RestartApplicationServer - The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.
NoInterruption
: There is no interruption to the
environment or application availability. RestartEnvironment
: The environment is entirely
restarted, all AWS resources are deleted and recreated, and the
environment is unavailable during the process. RestartApplicationServer
: The environment is available
the entire time. However, a short application outage occurs when the
application servers on the running Amazon EC2 instances are restarted.
Boolean userDefined
true
: This
configuration option was defined by the user. It is a valid choice for
specifying this as an Option to Remove when updating configuration
settings.
false
: This
configuration was not defined by the user.
true
: This configuration option was defined by
the user. It is a valid choice for specifying if this as an
Option to Remove
when updating configuration settings.
false
: This configuration was not defined by
the user. Constraint: You can remove only
UserDefined
options from a configuration.
Valid
Values: true
| false
String valueType
Scalar
: Values
for this option are a single selection from the possible values, or a
unformatted string or numeric value governed by the MIN/MAX/Regex
constraints:
List
:
Values for this option are multiple selections of the possible values.
Boolean
: Values for
this option are either true
or false
.
Scalar
: Values for
this option are a single selection from the possible values, or an
unformatted string, or numeric value governed by the
MIN/MAX/Regex
constraints. List
:
Values for this option are multiple selections from the possible
values. Boolean
: Values for this option are
either true
or false
.
Constraints:
Allowed Values: Scalar, List
com.amazonaws.internal.ListWithAutoConstructFlag<T> valueOptions
Integer minValue
Integer maxValue
Integer maxLength
OptionRestrictionRegex regex
String solutionStackName
Constraints:
Length: 0 - 100
String applicationName
Constraints:
Length: 1 - 100
String templateName
null
, the name of the configuration template for
this configuration set.
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
String environmentName
null
, the name of the environment for this
configuration set.
Constraints:
Length: 4 - 23
String deploymentStatus
DeploymentStatus
parameter indicates the deployment
status of this configuration set:
null
: This configuration is not associated with a running
environment.
pending
:
This is a draft configuration that is not deployed to the associated
environment but is in the process of deploying.
deployed
: This is the configuration
that is currently deployed to the associated running environment.
failed
: This is a
draft configuration, that failed to successfully deploy.
null
: This configuration is not
associated with a running environment. pending
: This is a draft configuration that is not
deployed to the associated environment but is in the process of
deploying. deployed
: This is the configuration
that is currently deployed to the associated running environment.
failed
: This is a draft configuration that
failed to successfully deploy.
Constraints:
Allowed Values: deployed, pending, failed
Date dateCreated
Date dateUpdated
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
String applicationName
Constraint: This name must be unique
within your account. If the specified name already exists, the action
returns an InvalidParameterValue
error.
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
ApplicationDescription application
String applicationName
AutoCreateApplication
is false
,
returns an InvalidParameterValue
error.
Constraints:
Length: 1 - 100
String versionLabel
Constraint: Must be unique per
application. If an application version already exists with this label
for the specified application, AWS Elastic Beanstalk returns an
InvalidParameterValue
error.
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
S3Location sourceBundle
If data found at the Amazon S3 location
exceeds the maximum allowed source bundle size, AWS Elastic Beanstalk
returns an InvalidParameterValue
error.
Default: If
not specified, AWS Elastic Beanstalk uses a sample application. If
only partially specified (for example, a bucket is provided but not
the key) or if no data is found at the Amazon S3 location, AWS Elastic
Beanstalk returns an InvalidParameterCombination
error.
Boolean autoCreateApplication
true
: Automatically creates the specified application
for this version if it does not already exist.
false
: Returns an
InvalidParameterValue
if the specified application for
this version does not already exist.
true
: Automatically creates the specified application
for this release if it does not already exist. false
: Throws an InvalidParameterValue
if
the specified application for this release does not already exist.
Default: false
Valid Values:
true
| false
ApplicationVersionDescription applicationVersion
String applicationName
InvalidParameterValue
error.
Constraints:
Length: 1 - 100
String templateName
Constraint: This name must be unique per application.
Default: If a configuration template
already exists with this name, AWS Elastic Beanstalk returns an
InvalidParameterValue
error.
Constraints:
Length: 1 - 100
String solutionStackName
Use ListAvailableSolutionStacks to obtain a list of available solution stacks.
Default: If the
SolutionStackName
is not specified and the source
configuration parameter is blank, AWS Elastic Beanstalk uses the
default solution stack.
If not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.
Constraints:
Length: 0 - 100
SourceConfiguration sourceConfiguration
Values specified in the OptionSettings
parameter of
this call overrides any values obtained from the
SourceConfiguration
.
If no configuration template is
found, returns an InvalidParameterValue
error.
Constraint: If both the solution stack name parameter and the source
configuration parameters are specified, the solution stack of the
source configuration template must match the specified solution stack
name or else AWS Elastic Beanstalk returns an
InvalidParameterCombination
error.
String environmentId
String description
Constraints:
Length: 0 - 200
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
String solutionStackName
Constraints:
Length: 0 - 100
String applicationName
Constraints:
Length: 1 - 100
String templateName
null
, the name of the configuration template for
this configuration set.
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
String environmentName
null
, the name of the environment for this
configuration set.
Constraints:
Length: 4 - 23
String deploymentStatus
DeploymentStatus
parameter indicates the deployment
status of this configuration set:
null
: This configuration is not associated with a running
environment.
pending
:
This is a draft configuration that is not deployed to the associated
environment but is in the process of deploying.
deployed
: This is the configuration
that is currently deployed to the associated running environment.
failed
: This is a
draft configuration, that failed to successfully deploy.
null
: This configuration is not
associated with a running environment. pending
: This is a draft configuration that is not
deployed to the associated environment but is in the process of
deploying. deployed
: This is the configuration
that is currently deployed to the associated running environment.
failed
: This is a draft configuration that
failed to successfully deploy.
Constraints:
Allowed Values: deployed, pending, failed
Date dateCreated
Date dateUpdated
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
String applicationName
If no application is found with this name,
CreateEnvironment
returns an
InvalidParameterValue
error.
Constraints:
Length: 1 - 100
String versionLabel
If the specified
application has no associated application versions, AWS Elastic
Beanstalk UpdateEnvironment
returns an
InvalidParameterValue
error.
Default: If not specified, AWS Elastic Beanstalk attempts to launch the most recently created application version.
Constraints:
Length: 1 - 100
String environmentName
Constraint: Must be from 4 to 23 characters in length. The
name can contain only letters, numbers, and hyphens. It cannot start
or end with a hyphen. This name must be unique in your account. If the
specified name already exists, AWS Elastic Beanstalk returns an
InvalidParameterValue
error.
Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
Constraints:
Length: 4 - 23
String templateName
InvalidParameterValue
error. Condition:
You must specify either this parameter or a
SolutionStackName
, but not both. If you specify both, AWS
Elastic Beanstalk returns an InvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns a
MissingRequiredParameter
error.
Constraints:
Length: 1 - 100
String solutionStackName
Condition: You must specify either this or a
TemplateName
, but not both. If you specify both, AWS
Elastic Beanstalk returns an InvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns a
MissingRequiredParameter
error.
Constraints:
Length: 0 - 100
String cNAMEPrefix
Constraints:
Length: 4 - 63
String description
Constraints:
Length: 0 - 200
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsToRemove
String environmentName
Constraints:
Length: 4 - 23
String environmentId
String applicationName
Constraints:
Length: 1 - 100
String versionLabel
Constraints:
Length: 1 - 100
String solutionStackName
SolutionStack
deployed with this
environment.
Constraints:
Length: 0 - 100
String templateName
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
String endpointURL
String cNAME
Constraints:
Length: 1 - 255
Date dateCreated
Date dateUpdated
String status
Launching
: Environment is in the process of initial
deployment. Updating
: Environment is in the
process of updating its configuration settings or application version.
Ready
: Environment is available to have an
action performed on it, such as update or terminate. Terminating
: Environment is in the shut-down process.
Terminated
: Environment is not running.
Constraints:
Allowed Values: Launching, Updating, Ready, Terminating, Terminated
String health
Red
: Indicates the environment is
not working.
Yellow
:
Indicates that something is wrong, the application might not be
available, but the instances appear running.
Green
: Indicates the environment is
healthy and fully functional.
Red
: Indicates the environment is not responsive. Occurs
when three or more consecutive failures occur for an environment.
Yellow
: Indicates that something is wrong.
Occurs when two consecutive failures occur for an environment. Green
: Indicates the environment is healthy and
fully functional. Grey
: Default health for a
new environment. The environment is not fully launched and health
checks have not started or health checks are suspended during an
UpdateEnvironment
or RestartEnvironement
request. Default: Grey
Constraints:
Allowed Values: Green, Yellow, Red, Grey
EnvironmentResourcesDescription resources
String s3Bucket
Constraints:
Length: 0 - 255
String applicationName
Constraints:
Length: 1 - 100
String applicationName
Constraints:
Length: 1 - 100
String versionLabel
Constraints:
Length: 1 - 100
Boolean deleteSourceBundle
true
: An attempt is made to delete the
associated Amazon S3 source bundle specified at time of creation.
false
: No action is taken on the Amazon S3
source bundle specified at time of creation. Valid
Values: true
| false
com.amazonaws.internal.ListWithAutoConstructFlag<T> applications
String applicationName
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> versionLabels
com.amazonaws.internal.ListWithAutoConstructFlag<T> applicationVersions
String applicationName
Constraints:
Length: 1 - 100
String templateName
Constraints:
Length: 1 - 100
String environmentName
Constraints:
Length: 4 - 23
String solutionStackName
Constraints:
Length: 0 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> options
String solutionStackName
Constraints:
Length: 0 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> options
String applicationName
Constraints:
Length: 1 - 100
String templateName
Conditional:
You must specify either this parameter or an EnvironmentName, but not
both. If you specify both, AWS Elastic Beanstalk returns an
InvalidParameterCombination
error. If you do not specify
either, AWS Elastic Beanstalk returns a
MissingRequiredParameter
error.
Constraints:
Length: 1 - 100
String environmentName
Condition: You must
specify either this or a TemplateName, but not both. If you specify
both, AWS Elastic Beanstalk returns an
InvalidParameterCombination
error. If you do not specify
either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
Constraints:
Length: 4 - 23
com.amazonaws.internal.ListWithAutoConstructFlag<T> configurationSettings
String environmentId
Condition: You must specify either this or an EnvironmentName, or
both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
String environmentName
Condition: You must specify either this or an EnvironmentId, or both.
If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
Constraints:
Length: 4 - 23
EnvironmentResourceDescription environmentResources
String applicationName
Constraints:
Length: 1 - 100
String versionLabel
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> environmentIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> environmentNames
Boolean includeDeleted
true
: Environments that have been deleted after
IncludedDeletedBackTo
are displayed.
false
: Do not include deleted environments.
Date includedDeletedBackTo
IncludeDeleted
is set to
true
, then environments deleted after this date are
displayed.com.amazonaws.internal.ListWithAutoConstructFlag<T> environments
String applicationName
Constraints:
Length: 1 - 100
String versionLabel
Constraints:
Length: 1 - 100
String templateName
Constraints:
Length: 1 - 100
String environmentId
String environmentName
Constraints:
Length: 4 - 23
String requestId
String severity
Constraints:
Allowed Values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL
Date startTime
Date endTime
EndTime
.Integer maxRecords
Constraints:
Range: 1 - 1000
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String nextToken
String environmentName
Constraints:
Length: 4 - 23
String environmentId
String applicationName
Constraints:
Length: 1 - 100
String versionLabel
Constraints:
Length: 1 - 100
String solutionStackName
SolutionStack
deployed with this
environment.
Constraints:
Length: 0 - 100
String templateName
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
String endpointURL
String cNAME
Constraints:
Length: 1 - 255
Date dateCreated
Date dateUpdated
String status
Launching
: Environment is in the process of initial
deployment. Updating
: Environment is in the
process of updating its configuration settings or application version.
Ready
: Environment is available to have an
action performed on it, such as update or terminate. Terminating
: Environment is in the shut-down process.
Terminated
: Environment is not running.
Constraints:
Allowed Values: Launching, Updating, Ready, Terminating, Terminated
String health
Red
: Indicates the environment is
not working.
Yellow
:
Indicates that something is wrong, the application might not be
available, but the instances appear running.
Green
: Indicates the environment is
healthy and fully functional.
Red
: Indicates the environment is not responsive. Occurs
when three or more consecutive failures occur for an environment.
Yellow
: Indicates that something is wrong.
Occurs when two consecutive failures occur for an environment. Green
: Indicates the environment is healthy and
fully functional. Grey
: Default health for a
new environment. The environment is not fully launched and health
checks have not started or health checks are suspended during an
UpdateEnvironment
or RestartEnvironement
request. Default: Grey
Constraints:
Allowed Values: Green, Yellow, Red, Grey
EnvironmentResourcesDescription resources
String infoType
Constraints:
Allowed Values: tail
String ec2InstanceId
Date sampleTimestamp
String message
String environmentName
Constraints:
Length: 4 - 23
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingGroups
AutoScalingGroups
used by this environment.com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
com.amazonaws.internal.ListWithAutoConstructFlag<T> launchConfigurations
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancers
com.amazonaws.internal.ListWithAutoConstructFlag<T> triggers
AutoScaling
triggers in use by this environment.LoadBalancerDescription loadBalancer
Date eventDate
String message
String applicationName
Constraints:
Length: 1 - 100
String versionLabel
Constraints:
Length: 1 - 100
String templateName
Constraints:
Length: 1 - 100
String environmentName
Constraints:
Length: 4 - 23
String requestId
String severity
Constraints:
Allowed Values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL
String id
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> solutionStacks
com.amazonaws.internal.ListWithAutoConstructFlag<T> solutionStackDetails
String name
String environmentId
Condition: You must specify
either this or an EnvironmentName, or both. If you do not specify
either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
String environmentName
Condition: You must
specify either this or an EnvironmentId, or both. If you do not
specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
Constraints:
Length: 4 - 23
String environmentId
If no such
environment is found, RequestEnvironmentInfo
returns an
InvalidParameterValue
error.
Condition: You must
specify either this or an EnvironmentName, or both. If you do not
specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
String environmentName
If no such
environment is found, RequestEnvironmentInfo
returns an
InvalidParameterValue
error.
Condition: You must
specify either this or an EnvironmentId, or both. If you do not
specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
Constraints:
Length: 4 - 23
String infoType
Constraints:
Allowed Values: tail
String environmentId
Condition:
You must specify either this or an EnvironmentName, or both. If you do
not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
String environmentName
Condition:
You must specify either this or an EnvironmentId, or both. If you do
not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
Constraints:
Length: 4 - 23
String environmentId
If no such environment is found,
returns an InvalidParameterValue
error.
Condition:
You must specify either this or an EnvironmentName, or both. If you do
not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
String environmentName
If no such environment is
found, returns an InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentId, or both.
If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
Constraints:
Length: 4 - 23
String infoType
Constraints:
Allowed Values: tail
com.amazonaws.internal.ListWithAutoConstructFlag<T> environmentInfo
String solutionStackName
Constraints:
Length: 0 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> permittedFileTypes
String sourceEnvironmentId
Condition: You must specify at
least the SourceEnvironmentID
or the
SourceEnvironmentName
. You may also specify both. If you
specify the SourceEnvironmentId
, you must specify the
DestinationEnvironmentId
.
String sourceEnvironmentName
Condition: You must specify at
least the SourceEnvironmentID
or the
SourceEnvironmentName
. You may also specify both. If you
specify the SourceEnvironmentName
, you must specify the
DestinationEnvironmentName
.
Constraints:
Length: 4 - 23
String destinationEnvironmentId
Condition: You must specify
at least the DestinationEnvironmentID
or the
DestinationEnvironmentName
. You may also specify both.
You must specify the SourceEnvironmentId
with the
DestinationEnvironmentId
.
String destinationEnvironmentName
Condition: You must
specify at least the DestinationEnvironmentID
or the
DestinationEnvironmentName
. You may also specify both.
You must specify the SourceEnvironmentName
with the
DestinationEnvironmentName
.
Constraints:
Length: 4 - 23
String environmentId
Condition: You must
specify either this or an EnvironmentName, or both. If you do not
specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
String environmentName
Condition: You must
specify either this or an EnvironmentId, or both. If you do not
specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
Constraints:
Length: 4 - 23
Boolean terminateResources
true
: (default) The user AWS resources (for example, the
Auto Scaling group, LoadBalancer, etc.) are terminated along with the
environment.
false
: The
environment is removed from the AWS Elastic Beanstalk but the AWS
resources continue to operate.
true
: The specified environment as well as the associated
AWS resources, such as Auto Scaling group and LoadBalancer, are
terminated. false
: AWS Elastic Beanstalk
resource management is removed from the environment, but the AWS
resources continue to operate. For more information, see the AWS Elastic Beanstalk User Guide.
Default: true
Valid Values: true
| false
String environmentName
Constraints:
Length: 4 - 23
String environmentId
String applicationName
Constraints:
Length: 1 - 100
String versionLabel
Constraints:
Length: 1 - 100
String solutionStackName
SolutionStack
deployed with this
environment.
Constraints:
Length: 0 - 100
String templateName
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
String endpointURL
String cNAME
Constraints:
Length: 1 - 255
Date dateCreated
Date dateUpdated
String status
Launching
: Environment is in the process of initial
deployment. Updating
: Environment is in the
process of updating its configuration settings or application version.
Ready
: Environment is available to have an
action performed on it, such as update or terminate. Terminating
: Environment is in the shut-down process.
Terminated
: Environment is not running.
Constraints:
Allowed Values: Launching, Updating, Ready, Terminating, Terminated
String health
Red
: Indicates the environment is
not working.
Yellow
:
Indicates that something is wrong, the application might not be
available, but the instances appear running.
Green
: Indicates the environment is
healthy and fully functional.
Red
: Indicates the environment is not responsive. Occurs
when three or more consecutive failures occur for an environment.
Yellow
: Indicates that something is wrong.
Occurs when two consecutive failures occur for an environment. Green
: Indicates the environment is healthy and
fully functional. Grey
: Default health for a
new environment. The environment is not fully launched and health
checks have not started or health checks are suspended during an
UpdateEnvironment
or RestartEnvironement
request. Default: Grey
Constraints:
Allowed Values: Green, Yellow, Red, Grey
EnvironmentResourcesDescription resources
String name
String applicationName
UpdateApplication
returns an
InvalidParameterValue
error.
Constraints:
Length: 1 - 100
String description
Default: If not specified, AWS Elastic Beanstalk does not update the description.
Constraints:
Length: 0 - 200
ApplicationDescription application
String applicationName
If no
application is found with this name, UpdateApplication
returns an InvalidParameterValue
error.
Constraints:
Length: 1 - 100
String versionLabel
If no application version is
found with this label, UpdateApplication
returns an
InvalidParameterValue
error.
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
ApplicationVersionDescription applicationVersion
String applicationName
If no application is found with this name,
UpdateConfigurationTemplate
returns an
InvalidParameterValue
error.
Constraints:
Length: 1 - 100
String templateName
If no
configuration template is found with this name,
UpdateConfigurationTemplate
returns an
InvalidParameterValue
error.
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsToRemove
Constraint: You can remove only UserDefined
configuration options.
String solutionStackName
Constraints:
Length: 0 - 100
String applicationName
Constraints:
Length: 1 - 100
String templateName
null
, the name of the configuration template for
this configuration set.
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
String environmentName
null
, the name of the environment for this
configuration set.
Constraints:
Length: 4 - 23
String deploymentStatus
DeploymentStatus
parameter indicates the deployment
status of this configuration set:
null
: This configuration is not associated with a running
environment.
pending
:
This is a draft configuration that is not deployed to the associated
environment but is in the process of deploying.
deployed
: This is the configuration
that is currently deployed to the associated running environment.
failed
: This is a
draft configuration, that failed to successfully deploy.
null
: This configuration is not
associated with a running environment. pending
: This is a draft configuration that is not
deployed to the associated environment but is in the process of
deploying. deployed
: This is the configuration
that is currently deployed to the associated running environment.
failed
: This is a draft configuration that
failed to successfully deploy.
Constraints:
Allowed Values: deployed, pending, failed
Date dateCreated
Date dateUpdated
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
String environmentId
If no environment with this
ID exists, AWS Elastic Beanstalk returns an
InvalidParameterValue
error.
Condition: You must
specify either this or an EnvironmentName, or both. If you do not
specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
String environmentName
InvalidParameterValue
error. Condition: You must
specify either this or an EnvironmentId, or both. If you do not
specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
Constraints:
Length: 4 - 23
String versionLabel
InvalidParameterValue
error.
Constraints:
Length: 1 - 100
String templateName
InvalidParameterValue
error.
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsToRemove
String environmentName
Constraints:
Length: 4 - 23
String environmentId
String applicationName
Constraints:
Length: 1 - 100
String versionLabel
Constraints:
Length: 1 - 100
String solutionStackName
SolutionStack
deployed with this
environment.
Constraints:
Length: 0 - 100
String templateName
Constraints:
Length: 1 - 100
String description
Constraints:
Length: 0 - 200
String endpointURL
String cNAME
Constraints:
Length: 1 - 255
Date dateCreated
Date dateUpdated
String status
Launching
: Environment is in the process of initial
deployment. Updating
: Environment is in the
process of updating its configuration settings or application version.
Ready
: Environment is available to have an
action performed on it, such as update or terminate. Terminating
: Environment is in the shut-down process.
Terminated
: Environment is not running.
Constraints:
Allowed Values: Launching, Updating, Ready, Terminating, Terminated
String health
Red
: Indicates the environment is
not working.
Yellow
:
Indicates that something is wrong, the application might not be
available, but the instances appear running.
Green
: Indicates the environment is
healthy and fully functional.
Red
: Indicates the environment is not responsive. Occurs
when three or more consecutive failures occur for an environment.
Yellow
: Indicates that something is wrong.
Occurs when two consecutive failures occur for an environment. Green
: Indicates the environment is healthy and
fully functional. Grey
: Default health for a
new environment. The environment is not fully launched and health
checks have not started or health checks are suspended during an
UpdateEnvironment
or RestartEnvironement
request. Default: Grey
Constraints:
Allowed Values: Green, Yellow, Red, Grey
EnvironmentResourcesDescription resources
String applicationName
Constraints:
Length: 1 - 100
String templateName
Condition: You cannot specify both this and an environment name.
Constraints:
Length: 1 - 100
String environmentName
Condition: You cannot specify both this and a configuration template name.
Constraints:
Length: 4 - 23
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
com.amazonaws.internal.ListWithAutoConstructFlag<T> messages
String message
String severity
error: This message indicates that this is not a valid setting for an option.
warning: This message is providing information you should take into account.
Constraints:
Allowed Values: error, warning
String namespace
String optionName
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
Integer instancePort
Constraints:
Range: 1 - 65535
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
String loadBalancerName
HealthCheck healthCheck
HealthCheck healthCheck
String loadBalancerName
String policyName
String cookieName
String loadBalancerName
String policyName
Long cookieExpirationPeriod
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> listeners
LoadBalancerPort
, InstancePort
,
Protocol
, and SSLCertificateId
items.String loadBalancerName
String policyName
String policyTypeName
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyAttributes
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> listeners
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
At least one Availability Zone must be specified. Specified Availability Zones must be in the same EC2 Region as the LoadBalancer. Traffic will be equally distributed across all zones.
This list can be modified after the creation of the LoadBalancer.
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
String scheme
String dNSName
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerPorts
String loadBalancerName
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyTypeDescriptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerDescriptions
String nextMarker
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
String target
TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case a healthcheck simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP or HTTPS protocol, the situation is different. You have to include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target needs to be 1024 16-bit Unicode characters or less.
Integer interval
Constraints:
Range: 1 - 300
Integer timeout
Constraints:
Range: 1 - 300
Integer unhealthyThreshold
Constraints:
Range: 2 - 10
Integer healthyThreshold
Constraints:
Range: 2 - 10
String instanceId
String instanceId
String state
String reasonCode
String description
String policyName
Long cookieExpirationPeriod
String protocol
Integer loadBalancerPort
String instanceProtocol
InstanceProtocol
has to be at the same
protocol layer, i.e., HTTP or HTTPS. Likewise, if the front-end
protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL. InstancePort
whose InstanceProtocol
is
secure, i.e., HTTPS or SSL, the listener's
InstanceProtocol
has to be secure, i.e., HTTPS or SSL. If
there is another listener with the same InstancePort
whose InstanceProtocol
is HTTP or TCP, the listener's
InstanceProtocol
must be either HTTP or TCP. Integer instancePort
Constraints:
Range: 1 - 65535
String sSLCertificateId
Listener listener
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
String loadBalancerName
String dNSName
String canonicalHostedZoneName
String canonicalHostedZoneNameID
com.amazonaws.internal.ListWithAutoConstructFlag<T> listenerDescriptions
Policies policies
com.amazonaws.internal.ListWithAutoConstructFlag<T> backendServerDescriptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
String vPCId
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
HealthCheck healthCheck
SourceSecurityGroup sourceSecurityGroup
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
Date createdTime
String scheme
com.amazonaws.internal.ListWithAutoConstructFlag<T> appCookieStickinessPolicies
com.amazonaws.internal.ListWithAutoConstructFlag<T> lBCookieStickinessPolicies
com.amazonaws.internal.ListWithAutoConstructFlag<T> otherPolicies
String attributeName
String attributeType
String description
String defaultValue
String cardinality
String policyName
String policyTypeName
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyAttributeDescriptions
String policyTypeName
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyAttributeTypeDescriptions
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
String loadBalancerName
Integer loadBalancerPort
String sSLCertificateId
String loadBalancerName
Integer instancePort
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
String loadBalancerName
Integer loadBalancerPort
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
String ownerAlias
--source-group-user
parameter of the
ec2-authorize
command in the Amazon EC2 command line
tool.String groupName
--source-group
parameter of the
ec2-authorize
command in the Amazon EC2 command line
tool.com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceGroups
String jobFlowId
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
String jobFlowId
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceGroupIds
String jobFlowId
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> steps
String name
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
ScriptBootstrapActionConfig scriptBootstrapAction
BootstrapActionConfig bootstrapActionConfig
Date createdAfter
Date createdBefore
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobFlowIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobFlowStates
com.amazonaws.internal.ListWithAutoConstructFlag<T> properties
String jar
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
String mainClass
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> args
String name
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\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: [ --�𐀀-\r\n\t]*
String instanceType
Constraints:
Length: 1 - 256
Pattern: [ --�𐀀-\r\n\t]*
Integer instanceCount
String instanceGroupId
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
String name
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\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: [ --�𐀀-\r\n\t]*
String instanceType
Constraints:
Length: 1 - 256
Pattern: [ --�𐀀-\r\n\t]*
Integer instanceRequestCount
Integer instanceRunningCount
String state
Constraints:
Allowed Values: PROVISIONING, STARTING, BOOTSTRAPPING, RUNNING, RESIZING, ARRESTED, SHUTTING_DOWN, TERMINATED, FAILED, ENDED
String lastStateChangeReason
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
Date creationDateTime
Date startDateTime
Date readyDateTime
Date endDateTime
String jobFlowId
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
String name
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
String logUri
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
String amiVersion
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\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: [ --�𐀀-\r\n\t]*
String state
Constraints:
Allowed Values: COMPLETED, FAILED, TERMINATED, RUNNING, SHUTTING_DOWN, STARTING, WAITING, BOOTSTRAPPING
Date creationDateTime
Date startDateTime
Date readyDateTime
Date endDateTime
String lastStateChangeReason
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
String masterInstanceType
Constraints:
Length: 1 - 256
Pattern: [ --�𐀀-\r\n\t]*
String slaveInstanceType
Constraints:
Length: 1 - 256
Pattern: [ --�𐀀-\r\n\t]*
Integer instanceCount
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceGroups
String ec2KeyName
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
PlacementType placement
Boolean keepJobFlowAliveWhenNoSteps
Boolean terminationProtected
String hadoopVersion
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\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: [ --�𐀀-\r\n\t]*
String masterInstanceType
Constraints:
Length: 1 - 256
Pattern: [ --�𐀀-\r\n\t]*
String masterPublicDnsName
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
String masterInstanceId
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
String slaveInstanceType
Constraints:
Length: 1 - 256
Pattern: [ --�𐀀-\r\n\t]*
Integer instanceCount
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceGroups
Integer normalizedInstanceHours
String ec2KeyName
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
String ec2SubnetId
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
PlacementType placement
Boolean keepJobFlowAliveWhenNoSteps
Boolean terminationProtected
String hadoopVersion
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
String availabilityZone
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
String name
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
String logUri
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
String additionalInfo
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
String amiVersion
If this value is not specified, the job flow uses the default of (AMI 1.0, Hadoop 0.18).
If the AMI supports multiple versions of Hadoop (for example, AMI
1.0 supports both Hadoop 0.18 and 0.20) you can use the
JobFlowInstancesConfig HadoopVersion
parameter to
modify the version of Hadoop from the defaults shown above.
For details about the AMI versions currently supported by Amazon ElasticMapReduce, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer's Guide.
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
JobFlowInstancesConfig instances
com.amazonaws.internal.ListWithAutoConstructFlag<T> steps
com.amazonaws.internal.ListWithAutoConstructFlag<T> bootstrapActions
com.amazonaws.internal.ListWithAutoConstructFlag<T> supportedProducts
com.amazonaws.internal.ListWithAutoConstructFlag<T> newSupportedProducts
Boolean visibleToAllUsers
true
, all IAM users of that AWS account can view and (if
they have the proper policy permissions set) manage the job flow. If
it is set to false
, only the IAM user that created the
job flow can view and manage it.String jobFlowRole
EMRJobflowDefault
. In
order to use the default role, you must have already created it using
the CLI.
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\r\n\t]*
String jobFlowId
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
String path
Constraints:
Length: 0 - 10280
Pattern: [ --�𐀀-\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 name
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
String actionOnFailure
Constraints:
Allowed Values: TERMINATE_JOB_FLOW, 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: [ --�𐀀-\r\n\t]*
String name
Constraints:
Length: 0 - 256
Pattern: [ --�𐀀-\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> args
String codec
AAC
.
Constraints:
Pattern: (^AAC$)|(^vorbis$)
String sampleRate
auto
, 22050
,
32000
, 44100
, 48000
,
96000
If you specify auto
, Elastic
Transcoder automatically detects the sample rate.
Constraints:
Pattern: (^auto$)|(^22050$)|(^32000$)|(^44100$)|(^48000$)|(^96000$)
String bitRate
Constraints:
Pattern: ^\d{1,3}$
String channels
auto
, 0
, 1
, 2
If you specify auto
, Elastic Transcoder automatically
detects the number of channels in the input file.
Constraints:
Pattern: (^auto$)|(^0$)|(^1$)|(^2$)
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 key
OutputBucket
object in the pipeline that is specified by
the pipeline ID. If a file with the specified name already exists in
the output bucket, the job fails.
Constraints:
Length: 1 - 255
String thumbnailPattern
If you don't want Elastic Transcoder to create thumbnails, specify "".
If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
{count}
(Required): If you want to
create thumbnails, you must include {count}
in the
ThumbnailPattern
object. Wherever you specify
{count}
, Elastic Transcoder adds a five-digit sequence
number (beginning with 00001) to thumbnail file names. The
number indicates where a given thumbnail appears in the sequence of
thumbnails for a transcoded file. {resolution}
but you omit
{count}
, Elastic Transcoder returns a validation error
and does not create the job.
Literal
values (Optional): You can specify literal values anywhere in the
ThumbnailPattern
object. For example, you can include
them as a file name prefix or as a delimiter between
{resolution}
and {count}
.
{resolution}
(Optional): If you want Elastic
Transcoder to include the resolution in the file name, include
{resolution}
in the ThumbnailPattern
object.
When creating thumbnails, Elastic Transcoder
automatically saves the files in the format (.jpg or .png) that
appears in the preset that you specified in the PresetID
value of CreateJobOutput
. Elastic Transcoder also appends
the applicable file name extension.
Constraints:
Pattern: (^$)|(^.*\{count\}.*$)
String rotate
auto
, 0
, 90
,
180
, 270
. The value auto
generally works only if the file that you're transcoding contains
rotation metadata.
Constraints:
Pattern: (^auto$)|(^0$)|(^90$)|(^180$)|(^270$)
String presetId
Id
of the preset to use for this job. The preset
determines the audio, video, and thumbnail settings that Elastic
Transcoder uses for transcoding.
Constraints:
Pattern: ^\d{13}-\w{6}$
String segmentDuration
PresetId
for which the value
of Container
is ts (MPEG-TS), SegmentDuration is the
duration of each .ts file in seconds. The range of valid values is 1
to 60 seconds.
Constraints:
Pattern: ^\d{1,5}([.]\d{0,5})?$
com.amazonaws.internal.ListWithAutoConstructFlag<T> watermarks
String name
Name
objects must be
unique. Elastic Transcoder automatically appends .m3u8 to the file
name. If you include .m3u8 in Name
, it will appear twice
in the file name.
Constraints:
Length: 1 - 255
String format
Constraints:
Pattern: (^HLSv3$)
com.amazonaws.internal.ListWithAutoConstructFlag<T> outputKeys
Outputs:Key
object. If you
include more than one output in a playlist, the value of
SegmentDuration
for all of the outputs must be the same.
Constraints:
Length: 0 - 30
String pipelineId
Id
of the pipeline that you want Elastic Transcoder
to use for transcoding. The pipeline determines several settings,
including the Amazon S3 bucket from which Elastic Transcoder gets the
files to transcode and the bucket into which Elastic Transcoder puts
the transcoded files.
Constraints:
Pattern: ^\d{13}-\w{6}$
JobInput input
CreateJobOutput output
CreateJobOutput
structure.com.amazonaws.internal.ListWithAutoConstructFlag<T> outputs
Outputs
syntax instead of the Output
syntax.
Constraints:
Length: 0 - 30
String outputKeyPrefix
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> playlists
PresetId
for which the value
of Container
is ts (MPEG-TS), Playlists contains
information about the master playlists that you want Elastic
Transcoder to create. We recommend that you create only one master playlist. The maximum number of master playlists in a job is 30.
Constraints:
Length: 0 - 30
Job job
String name
Constraints: Maximum 40 characters.
Constraints:
Length: 1 - 40
String inputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
String outputBucket
Specify this value when all of the following are true:
OutputBucket
, it grants full control over the files only
to the AWS account that owns the role that is specified by
Role
.If you want to save transcoded files and
playlists in one bucket and thumbnails in another bucket, specify
which users can access the transcoded files or the permissions the
users have, or change the Amazon S3 storage class, omit
OutputBucket
and specify values for
ContentConfig
and ThumbnailConfig
instead.
Constraints:
Pattern: ^(\w|\.|-){1,255}$
String role
Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$
Notifications notifications
PipelineOutputConfig contentConfig
ContentConfig
object specifies information
about the Amazon S3 bucket in which you want Elastic Transcoder to
save transcoded files and playlists: which bucket to use, which users
you want to have access to the files, the type of access you want
users to have, and the storage class that you want to assign to the
files. If you specify values for ContentConfig
, you
must also specify values for ThumbnailConfig
.
If you
specify values for ContentConfig
and
ThumbnailConfig
, omit the OutputBucket
object.
Grantee
object: Grantee
object is either the canonical user ID for an
AWS account or an origin access identity for an Amazon CloudFront
distribution. For more information about canonical user IDs, see
Access Control List (ACL) Overview in the Amazon Simple Storage
Service Developer Guide. For more information about using CloudFront
origin access identities to require that users use CloudFront URLs
instead of Amazon S3 URLs, see Using an Origin Access Identity to
Restrict Access to Your Amazon S3 Content. Grantee
object is the
registered email address of an AWS account.Grantee
object is one of the following
predefined Amazon S3 groups: AllUsers
,
AuthenticatedUsers
, or LogDelivery
.Grantee
. Permissions are
granted on the files that Elastic Transcoder adds to the bucket,
including playlists and video files. Valid values include: READ
: The grantee can read the objects and metadata
for objects that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for
objects that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP
: The grantee can write the ACL for the
objects that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ
,
READ_ACP
, and WRITE_ACP
permissions for the
objects that Elastic Transcoder adds to the Amazon S3 bucket.Standard
or ReducedRedundancy
, that you want
Elastic Transcoder to assign to the video files and playlists that it
stores in your Amazon S3 bucket.PipelineOutputConfig thumbnailConfig
ThumbnailConfig
object specifies several values,
including the Amazon S3 bucket in which you want Elastic Transcoder to
save thumbnail files, which users you want to have access to the
files, the type of access you want users to have, and the storage
class that you want to assign to the files. If you specify values
for ContentConfig
, you must also specify values for
ThumbnailConfig
even if you don't want to create
thumbnails.
If you specify values for ContentConfig
and ThumbnailConfig
, omit the OutputBucket
object.
Permissions
object
specifies which users and/or predefined Amazon S3 groups you want to
have access to thumbnail files, and the type of access you want them
to have. You can grant permissions to a maximum of 30 users and/or
predefined Amazon S3 groups.Grantee
object is
either the canonical user ID for an AWS account or an origin access
identity for an Amazon CloudFront distribution. Grantee
object is the
registered email address of an AWS account. Grantee
object is one of the following
predefined Amazon S3 groups: AllUsers
,
AuthenticatedUsers
, or LogDelivery
.Grantee
. Permissions are granted on
the thumbnail files that Elastic Transcoder adds to the bucket. Valid
values include: READ
: The grantee can read the
thumbnails and metadata for objects that Elastic Transcoder adds to
the Amazon S3 bucket.READ_ACP
: The grantee can
read the object ACL for thumbnails that Elastic Transcoder adds to the
Amazon S3 bucket. WRITE_ACP
: The grantee can
write the ACL for the thumbnails that Elastic Transcoder adds to the
Amazon S3 bucket.FULL_CONTROL
: The grantee has
READ
, READ_ACP
, and WRITE_ACP
permissions for the thumbnails that Elastic Transcoder adds to the
Amazon S3 bucket. Standard
or
ReducedRedundancy
, that you want Elastic Transcoder to
assign to the thumbnails that it stores in your Amazon S3 bucket.Pipeline pipeline
String name
Constraints:
Length: 1 - 40
String description
Constraints:
Length: 0 - 255
String container
mp4
.
Constraints:
Pattern: (^mp4$)|(^ts$)|(^webm$)
VideoParameters video
AudioParameters audio
Thumbnails thumbnails
Preset preset
String warning
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
String pipelineId
Id
of the pipeline that you want Elastic Transcoder
to use for transcoding. The pipeline determines several settings,
including the Amazon S3 bucket from which Elastic Transcoder gets the
files to transcode and the bucket into which Elastic Transcoder puts
the transcoded files.
Constraints:
Pattern: ^\d{13}-\w{6}$
JobInput input
JobOutput output
com.amazonaws.internal.ListWithAutoConstructFlag<T> outputs
Outputs
syntax for all jobs, even when you want Elastic
Transcoder to transcode a file into only one format. Do not use both
the Outputs
and Output
syntaxes in the same
request. You can create a maximum of 30 outputs per job. If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.
String outputKeyPrefix
OutputKeyPrefix
.
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> playlists
PresetId
for which the value of
Container
is ts (MPEG-TS), Playlists
contains information about the master playlists that you want Elastic
Transcoder to create. We recommend that you create only one master playlist. The maximum number of master playlists in a job is 30.
String status
Submitted
,
Progressing
, Complete
,
Canceled
, or Error
.
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
String 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$)|(^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
,
asf
, avi
, divx
,
flv
, mkv
, mov
,
mp4
, mpeg
, mpeg-ps
,
mpeg-ts
, mxf
, ogg
,
vob
, wav
, webm
Constraints:
Pattern: (^auto$)|(^3gp$)|(^asf$)|(^avi$)|(^divx$)|(^flv$)|(^mkv$)|(^mov$)|(^mp4$)|(^mpeg$)|(^mpeg-ps$)|(^mpeg-ts$)|(^mxf$)|(^ogg$)|(^ts$)|(^vob$)|(^wav$)|(^webm$)
String id
String key
OutputBucket
object in the pipeline that is specified by
the pipeline ID.
Constraints:
Length: 1 - 255
String thumbnailPattern
If you don't want Elastic Transcoder to create thumbnails, specify "".
If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
{count}
(Required): If you want to
create thumbnails, you must include {count}
in the
ThumbnailPattern
object. Wherever you specify
{count}
, Elastic Transcoder adds a five-digit sequence
number (beginning with 00001) to thumbnail file names. The
number indicates where a given thumbnail appears in the sequence of
thumbnails for a transcoded file. {resolution}
but you omit
{count}
, Elastic Transcoder returns a validation error
and does not create the job.
Literal
values (Optional): You can specify literal values anywhere in the
ThumbnailPattern
object. For example, you can include
them as a file name prefix or as a delimiter between
{resolution}
and {count}
.
{resolution}
(Optional): If you want Elastic
Transcoder to include the resolution in the file name, include
{resolution}
in the ThumbnailPattern
object.
When creating thumbnails, Elastic Transcoder
automatically saves the files in the format (.jpg or .png) that
appears in the preset that you specified in the PresetID
value of CreateJobOutput
. Elastic Transcoder also appends
the applicable file name extension.
Constraints:
Pattern: (^$)|(^.*\{count\}.*$)
String rotate
auto
, 0
, 90
,
180
, 270
The value auto
generally works only if the file that you're transcoding contains
rotation metadata.
Constraints:
Pattern: (^auto$)|(^0$)|(^90$)|(^180$)|(^270$)
String presetId
Id
object for the preset that you want
to use for this job. The preset determines the audio, video, and
thumbnail settings that Elastic Transcoder uses for transcoding. To
use a preset that you created, specify the preset ID that Elastic
Transcoder returned in the response when you created the preset. You
can also use the Elastic Transcoder system presets, which you can get
with ListPresets
.
Constraints:
Pattern: ^\d{13}-\w{6}$
String segmentDuration
PresetId
for which the value of
Container
is ts
(MPEG-TS),
SegmentDuration
is the maximum duration of each .ts file
in seconds. The range of valid values is 1 to 60 seconds. If the
duration of the video is not evenly divisible by
SegmentDuration
, the duration of the last segment is the
remainder of total length/SegmentDuration. Elastic Transcoder creates
an output-specific playlist for each output that you specify in
OutputKeys. To add an output to the master playlist for this job,
include it in OutputKeys
.
Constraints:
Pattern: ^\d{1,5}([.]\d{0,5})?$
String status
Outputs:Status
is always the same as
Job:Status
. If you specified more than one output: Job:Status
and Outputs:Status
for all of
the outputs is Submitted until Elastic Transcoder starts to process
the first output.Outputs:Status
for that output and
Job:Status
both change to Progressing. For each output,
the value of Outputs:Status
remains Submitted until
Elastic Transcoder starts to process the output.Job:Status
changes to Complete only if
Outputs:Status
for all of the outputs is
Complete
. If Outputs:Status
for one or more
outputs is Error
, the terminal status for
Job:Status
is also Error
.Status
is one of the following:
Submitted
, Progressing
,
Complete
, Canceled
, or Error
.
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
String statusDetail
Status
.
Constraints:
Length: 0 - 255
Long duration
Integer width
Integer height
com.amazonaws.internal.ListWithAutoConstructFlag<T> watermarks
Preset
for the
current output. Watermarks are added to the output video in the sequence in which you list them in the job output���the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add will cover the first one, the third one will cover the second, and the fourth one will cover the third.
String presetWatermarkId
Constraints:
Length: 1 - 40
String inputKey
Pipeline
; the Input Bucket
object in that
pipeline identifies the bucket. If the file name includes a prefix, for example, logos/128x64.png, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.
Constraints:
Length: 1 - 255
Pattern: (^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)
String pipelineId
Constraints:
Pattern: ^\d{13}-\w{6}$
String ascending
true
. To list jobs in reverse
chronological order, enter false
.
Constraints:
Pattern: (^true$)|(^false$)
String pageToken
pageToken
in subsequent GET
requests to get
each successive page of results.
Constraints:
Pattern: ^\d{13}-\w{6}$
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobs
Job
objects that are in the specified
pipeline.String nextPageToken
NextPageToken
is null
.
Constraints:
Pattern: ^\d{13}-\w{6}$
String status
Submitted
, Progressing
,
Complete
, Canceled
, or Error
.
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
String ascending
true
. To list jobs in reverse
chronological order, enter false
.
Constraints:
Pattern: (^true$)|(^false$)
String pageToken
pageToken
in subsequent GET
requests to get
each successive page of results.
Constraints:
Pattern: ^\d{13}-\w{6}$
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobs
Job
objects that have the specified status.String nextPageToken
NextPageToken
is null
.
Constraints:
Pattern: ^\d{13}-\w{6}$
String progressing
Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)
String completed
Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)
String warning
Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)
String error
Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)
String granteeType
Canonical
: Either the canonical user ID for an AWS
account or an origin access identity for an Amazon CloudFront
distribution. Email
: The
registered email address of an AWS account.Group
: One of the following predefined Amazon S3
groups: AllUsers
, AuthenticatedUsers
, or
LogDelivery
.
Constraints:
Pattern: (^Canonical$)|(^Email$)|(^Group$)
String grantee
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> access
READ
: The grantee
can read the thumbnails and metadata for thumbnails that Elastic
Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for
thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the
thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and
WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds
to the Amazon S3 bucket.
Constraints:
Length: 0 - 30
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
String arn
String name
Constraints: Maximum 40 characters
Constraints:
Length: 1 - 40
String status
Active
: The
pipeline is processing jobs.Paused
: The
pipeline is not currently processing jobs.
Constraints:
Pattern: (^Active$)|(^Paused$)
String inputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
String outputBucket
ContentConfig
and
ThumbnailConfig
.
Constraints:
Pattern: ^(\w|\.|-){1,255}$
String role
Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$
Notifications notifications
PipelineOutputConfig contentConfig
ContentConfig
and ThumbnailConfig
, or
you specify OutputBucket
. Grantee
object: Canonical
: Either the canonical user ID for an AWS
account or an origin access identity for an Amazon CloudFront
distribution.Email
: The registered email
address of an AWS account.Group
: One of the
following predefined Amazon S3 groups: AllUsers
,
AuthenticatedUsers
, or LogDelivery
.Grantee
: The AWS user or group that you
want to have access to transcoded files and playlists.Access
: The permission that you want to give to the
AWS user that is listed in Grantee
. Valid values include:
READ
: The grantee can read the objects and
metadata for objects that Elastic Transcoder adds to the Amazon S3
bucket.READ_ACP
: The grantee can read the
object ACL for objects that Elastic Transcoder adds to the Amazon S3
bucket.WRITE_ACP
: The grantee can write the ACL
for the objects that Elastic Transcoder adds to the Amazon S3
bucket.FULL_CONTROL
: The grantee has
READ
, READ_ACP
, and WRITE_ACP
permissions for the objects that Elastic Transcoder adds to the Amazon
S3 bucket.PipelineOutputConfig thumbnailConfig
ContentConfig
and ThumbnailConfig
, or you
specify OutputBucket
. Bucket
: The
Amazon S3 bucket in which you want Elastic Transcoder to save
thumbnail files. Permissions
: A list of the
users and/or predefined Amazon S3 groups you want to have access to
thumbnail files, and the type of access that you want them to have.
Canonical
: Either the canonical user ID
for an AWS account or an origin access identity for an Amazon
CloudFront distribution. Email
: The registered email address of an AWS
account.Group
: One of the following predefined
Amazon S3 groups: AllUsers
,
AuthenticatedUsers
, or LogDelivery
.Grantee
: The AWS user or group that you
want to have access to thumbnail files.READ
: The grantee
can read the thumbnails and metadata for thumbnails that Elastic
Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for
thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the
thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and
WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds
to the Amazon S3 bucket.StorageClass
: The Amazon S3 storage class,
Standard
or ReducedRedundancy
, that you want
Elastic Transcoder to assign to the thumbnails that it stores in your
Amazon S3 bucket.String bucket
ContentConfig
and ThumbnailConfig
instead.
Constraints:
Pattern: ^(\w|\.|-){1,255}$
String storageClass
Standard
or
ReducedRedundancy
, that you want Elastic Transcoder to
assign to the video files and playlists that it stores in your Amazon
S3 bucket.
Constraints:
Pattern: (^ReducedRedundancy$)|(^Standard$)
com.amazonaws.internal.ListWithAutoConstructFlag<T> permissions
Permissions
object specifies which users
and/or predefined Amazon S3 groups you want to have access to
transcoded files and playlists, and the type of access you want them
to have. You can grant permissions to a maximum of 30 users and/or
predefined Amazon S3 groups. If you include
Permissions
, Elastic Transcoder grants only the
permissions that you specify. It does not grant full permissions to
the owner of the role specified by Role
. If you want that
user to have full control, you must explicitly grant full control to
the user.
If you omit Permissions
, Elastic Transcoder
grants full control over the transcoded files and playlists to the
owner of the role specified by Role
, and grants no other
permissions to any other user or group.
Constraints:
Length: 0 - 30
String name
Name
objects must be
unique. Note: Elastic Transcoder automatically appends .m3u8 to
the file name. If you include .m3u8 in Name
, it will
appear twice in the file name.
Constraints:
Length: 1 - 255
String format
HLSv3
.
Constraints:
Pattern: (^HLSv3$)
com.amazonaws.internal.ListWithAutoConstructFlag<T> outputKeys
SegmentDuration
for all of the outputs must be the same.
Constraints:
Length: 0 - 30
String status
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
String statusDetail
Constraints:
Length: 0 - 255
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
String name
Constraints:
Length: 1 - 40
String description
Constraints:
Length: 0 - 255
String container
mp4
.
Constraints:
Pattern: (^mp4$)|(^ts$)|(^webm$)
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{2,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{2,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{2,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{2,4}?px$)
String opacity
Opacity
is float. Elastic Transcoder supports transparent .png graphics. If
you use a transparent .png, the transparent portion of the video
appears as if you had specified a value of 0 for Opacity
.
The .jpg file format doesn't support transparency.
Constraints:
Pattern: ^\d{1,3}([.]\d{0,20})?$
String target
HorizontalOffset
,
VerticalOffset
, MaxWidth
, and
MaxHeight
: HorizontalOffset
and VerticalOffset
values
are calculated based on the borders of the video excluding black bars
added by Elastic Transcoder, if any. In addition,
MaxWidth
and MaxHeight
, if specified as a
percentage, are calculated based on the borders of the video excluding
black bars added by Elastic Transcoder, if any.HorizontalOffset
and VerticalOffset
values
are calculated based on the borders of the video including black bars
added by Elastic Transcoder, if any.MaxWidth
and MaxHeight
, if specified as a
percentage, are calculated based on the borders of the video including
black bars added by Elastic Transcoder, if any.
Constraints:
Pattern: (^Content$)|(^Frame$)
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
Job job
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
Pipeline pipeline
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
Preset preset
String role
Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$
String inputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
String outputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
com.amazonaws.internal.ListWithAutoConstructFlag<T> topics
Constraints:
Length: 0 - 30
String success
true
;
otherwise, the value is false
.
Constraints:
Pattern: (^true$)|(^false$)
com.amazonaws.internal.ListWithAutoConstructFlag<T> messages
Success
element contains false
, this
value is an array of one or more error messages that were generated
during the test process.String format
jpg
and png
. You specify whether you want Elastic Transcoder to create thumbnails when you create a job.
Constraints:
Pattern: (^jpg$)|(^png$)
String interval
Constraints:
Pattern: ^\d{1,5}$
String resolution
To better control resolution and aspect ratio of
thumbnails, we recommend that you use the values
MaxWidth
, MaxHeight
,
SizingPolicy
, and PaddingPolicy
instead of
Resolution
and AspectRatio
. The two groups
of settings are mutually exclusive. Do not use them together.
The width and height of thumbnail files in pixels.
Specify a value in the format width
x
height
where both values are even integers. The
values cannot exceed the width and height that you specified in the
Video:Resolution
object.
Constraints:
Pattern: ^\d{1,5}x\d{1,5}$
String aspectRatio
To better control resolution and aspect ratio of
thumbnails, we recommend that you use the values
MaxWidth
, MaxHeight
,
SizingPolicy
, and PaddingPolicy
instead of
Resolution
and AspectRatio
. The two groups
of settings are mutually exclusive. Do not use them together.
The aspect ratio of thumbnails. Valid values include:
auto
, 1:1
, 4:3
,
3:2
, 16:9
If you specify
auto
, Elastic Transcoder tries to preserve the aspect
ratio of the video in the output file.
Constraints:
Pattern: (^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)
String maxWidth
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
String maxHeight
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
String sizingPolicy
Fit
: Elastic Transcoder scales thumbnails so
they match the value that you specified in thumbnail MaxWidth or
MaxHeight settings without exceeding the other value. Fill
: Elastic Transcoder scales thumbnails so they
match the value that you specified in thumbnail MaxWidth
or MaxHeight
settings and matches or exceeds the other
value. Elastic Transcoder centers the image in thumbnails and then
crops in the dimension (if any) that exceeds the maximum value.Stretch
: Elastic Transcoder stretches thumbnails to
match the values that you specified for thumbnail
MaxWidth
and MaxHeight
settings. If the
relative proportions of the input video and thumbnails are different,
the thumbnails will be distorted.Keep
: Elastic
Transcoder does not scale thumbnails. If either dimension of the input
video exceeds the values that you specified for thumbnail
MaxWidth
and MaxHeight
settings, Elastic
Transcoder crops the thumbnails.ShrinkToFit
:
Elastic Transcoder scales thumbnails down so that their dimensions
match the values that you specified for at least one of thumbnail
MaxWidth
and MaxHeight
without exceeding
either value. If you specify this option, Elastic Transcoder does not
scale thumbnails up.ShrinkToFill
: Elastic
Transcoder scales thumbnails down so that their dimensions match the
values that you specified for at least one of MaxWidth
and MaxHeight
without dropping below either value. If you
specify this option, Elastic Transcoder does not scale thumbnails
up.
Constraints:
Pattern: (^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)
String paddingPolicy
PaddingPolicy
to Pad
, Elastic
Transcoder may add black bars to the top and bottom and/or left and
right sides of thumbnails to make the total size of the thumbnails
match the values that you specified for thumbnail
MaxWidth
and MaxHeight
settings.
Constraints:
Pattern: (^Pad$)|(^NoPad$)
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
Notifications notifications
Pipeline pipeline
String id
Constraints:
Pattern: ^\d{13}-\w{6}$
String name
Constraints: Maximum 40 characters
Constraints:
Length: 1 - 40
String inputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
String role
Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$
Notifications notifications
PipelineOutputConfig contentConfig
ContentConfig
object specifies information
about the Amazon S3 bucket in which you want Elastic Transcoder to
save transcoded files and playlists: which bucket to use, which users
you want to have access to the files, the type of access you want
users to have, and the storage class that you want to assign to the
files. If you specify values for ContentConfig
, you
must also specify values for ThumbnailConfig
.
If you
specify values for ContentConfig
and
ThumbnailConfig
, omit the OutputBucket
object.
Grantee
object: Grantee
object is either the canonical user ID for an
AWS account or an origin access identity for an Amazon CloudFront
distribution. For more information about canonical user IDs, see
Access Control List (ACL) Overview in the Amazon Simple Storage
Service Developer Guide. For more information about using CloudFront
origin access identities to require that users use CloudFront URLs
instead of Amazon S3 URLs, see Using an Origin Access Identity to
Restrict Access to Your Amazon S3 Content. Grantee
object is the
registered email address of an AWS account.Grantee
object is one of the following
predefined Amazon S3 groups: AllUsers
,
AuthenticatedUsers
, or LogDelivery
.Grantee
. Permissions are
granted on the files that Elastic Transcoder adds to the bucket,
including playlists and video files. Valid values include: READ
: The grantee can read the objects and metadata
for objects that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for
objects that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP
: The grantee can write the ACL for the
objects that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ
,
READ_ACP
, and WRITE_ACP
permissions for the
objects that Elastic Transcoder adds to the Amazon S3 bucket.Standard
or ReducedRedundancy
, that you want
Elastic Transcoder to assign to the video files and playlists that it
stores in your Amazon S3 bucket.PipelineOutputConfig thumbnailConfig
ThumbnailConfig
object specifies several values,
including the Amazon S3 bucket in which you want Elastic Transcoder to
save thumbnail files, which users you want to have access to the
files, the type of access you want users to have, and the storage
class that you want to assign to the files. If you specify values
for ContentConfig
, you must also specify values for
ThumbnailConfig
even if you don't want to create
thumbnails.
If you specify values for ContentConfig
and ThumbnailConfig
, omit the OutputBucket
object.
Permissions
object
specifies which users and/or predefined Amazon S3 groups you want to
have access to thumbnail files, and the type of access you want them
to have. You can grant permissions to a maximum of 30 users and/or
predefined Amazon S3 groups.Grantee
object is
either the canonical user ID for an AWS account or an origin access
identity for an Amazon CloudFront distribution. Grantee
object is the
registered email address of an AWS account. Grantee
object is one of the following
predefined Amazon S3 groups: AllUsers
,
AuthenticatedUsers
, or LogDelivery
.Grantee
. Permissions are granted on
the thumbnail files that Elastic Transcoder adds to the bucket. Valid
values include: READ
: The grantee can read the
thumbnails and metadata for objects that Elastic Transcoder adds to
the Amazon S3 bucket.READ_ACP
: The grantee can
read the object ACL for thumbnails that Elastic Transcoder adds to the
Amazon S3 bucket. WRITE_ACP
: The grantee can
write the ACL for the thumbnails that Elastic Transcoder adds to the
Amazon S3 bucket.FULL_CONTROL
: The grantee has
READ
, READ_ACP
, and WRITE_ACP
permissions for the thumbnails that Elastic Transcoder adds to the
Amazon S3 bucket. Standard
or
ReducedRedundancy
, that you want Elastic Transcoder to
assign to the thumbnails that it stores in your Amazon S3 bucket.Pipeline pipeline
Pipeline pipeline
String codec
H.264
and vp8
. You can only specify
vp8
when the container type is webm
.
Constraints:
Pattern: (^H\.264$)|(^vp8$)
Map<K,V> codecOptions
The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following profiles:
baseline
: The profile most commonly used for
videoconferencing and for mobile applications.main
: The profile used for standard-definition
digital TV broadcasts.high
: The profile used
for high-definition digital TV broadcasts and for Blu-ray discs.Level (H.264 Only)
The H.264 level that you want to use for the output file. Elastic Transcoder supports the following levels:
1
, 1b
, 1.1
,
1.2
, 1.3
, 2
, 2.1
,
2.2
, 3
, 3.1
, 3.2
,
4
, 4.1
MaxReferenceFrames (H.264 Only)
Applicable only when the value of Video:Codec is H.264. The maximum number of previously decoded frames to use as a reference for decoding future frames. Valid values are integers 0 through 16, but we recommend that you not use a value greater than the following:
Min(Floor(Maximum decoded picture buffer in macroblocks *
256 / (Width in pixels * Height in pixels)), 16)
where
Width in pixels and Height in pixels represent either
MaxWidth and MaxHeight, or Resolution. Maximum decoded picture
buffer in macroblocks depends on the value of the
Level
object. See the list below. (A macroblock is a
block of pixels measuring 16x16.)
MaxBitRate
The maximum number
of bits per second in a video buffer; the size of the buffer is
specified by BufferSize
. Specify a value between 16 and
62,500. You can reduce the bandwidth required to stream a video by
reducing the maximum bit rate, but this also reduces the quality of
the video.
BufferSize
The maximum number of bits in any
x seconds of the output video. This window is commonly 10 seconds, the
standard segment duration when you���re using MPEG-TS for the
container type of the output video. Specify an integer greater than 0.
If you specify MaxBitRate
and omit
BufferSize
, Elastic Transcoder sets
BufferSize
to 10 times the value of
MaxBitRate
.
Constraints:
Length: 0 - 30
String keyframesMaxDist
Constraints:
Pattern: ^\d{1,6}$
String fixedGOP
FixedGOP
. Valid values
are true
and false
: true
: Elastic Transcoder uses the value of
KeyframesMaxDist
for the distance between key frames (the
number of frames in a group of pictures, or GOP).false
: The distance between key frames can vary.
Constraints:
Pattern: (^true$)|(^false$)
String bitRate
Level
and Profile
. If you specify
auto
, Elastic Transcoder uses the detected bit rate of
the input source. If you specify a value other than auto
,
we recommend that you specify a value less than or equal to the
maximum H.264-compliant value listed for your level and profile: Level - Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum video bit rate in kilobits/second (high Profile)
Constraints:
Pattern: (^\d{2,5}$)|(^auto$)
String frameRate
auto
, 10
,
15
, 23.97
, 24
, 25
,
29.97
, 30
, 60
If you specify
auto
, Elastic Transcoder uses the detected frame rate of
the input source. If you specify a frame rate, we recommend that you
perform the following calculation:
Frame rate = maximum
recommended decoding speed in luma samples/second / (width in pixels *
height in pixels)
where:
The maximum recommended decoding speed in Luma samples/second for each level is described in the following list (Level - Decoding speed):
Constraints:
Pattern: (^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^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$)|(^60$)
String resolution
To better control resolution and aspect ratio of output
videos, we recommend that you use the values MaxWidth
,
MaxHeight
, SizingPolicy
,
PaddingPolicy
, and DisplayAspectRatio
instead of Resolution
and AspectRatio
. The
two groups of settings are mutually exclusive. Do not use them
together.
The width and height of the video in the
output file, in pixels. Valid values are auto
and
width x height:
auto
: Elastic
Transcoder attempts to preserve the width and height of the input
file, subject to the following rules.width x
height
: The width and height of the output video in
pixels.Note the following about specifying the width and height:
Constraints:
Pattern: (^auto$)|(^\d{1,5}x\d{1,5}$)
String aspectRatio
To better control resolution and aspect ratio of output
videos, we recommend that you use the values MaxWidth
,
MaxHeight
, SizingPolicy
,
PaddingPolicy
, and DisplayAspectRatio
instead of Resolution
and AspectRatio
. The
two groups of settings are mutually exclusive. Do not use them
together.
The display aspect ratio of the video in the output file. Valid values include:
auto
,
1:1
, 4:3
, 3:2
,
16:9
If you specify auto
, Elastic
Transcoder tries to preserve the aspect ratio of the input file.
If you specify an aspect ratio for the output file that differs from aspect ratio of the input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars on the top and bottom) to maintain the aspect ratio of the active region of the video.
Constraints:
Pattern: (^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)
String maxWidth
auto
, Elastic Transcoder uses 1920 (Full HD) as the
default value. If you specify a numeric value, enter an even integer
between 128 and 4096.
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
String maxHeight
auto
, Elastic Transcoder uses 1080 (Full HD) as the
default value. If you specify a numeric value, enter an even integer
between 96 and 3072.
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
String displayAspectRatio
Constraints:
Pattern: (^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)
String sizingPolicy
Fit
: Elastic Transcoder scales the
output video so it matches the value that you specified in either
MaxWidth
or MaxHeight
without exceeding the
other value.Fill
: Elastic Transcoder scales the
output video so it matches the value that you specified in either
MaxWidth
or MaxHeight
and matches or exceeds
the other value. Elastic Transcoder centers the output video and then
crops it in the dimension (if any) that exceeds the maximum
value.Stretch
: Elastic Transcoder stretches the
output video to match the values that you specified for
MaxWidth
and MaxHeight
. If the relative
proportions of the input video and the output video are different, the
output video will be distorted.Keep
: Elastic
Transcoder does not scale the output video. If either dimension of the
input video exceeds the values that you specified for
MaxWidth
and MaxHeight
, Elastic Transcoder
crops the output video.ShrinkToFit
: Elastic
Transcoder scales the output video down so that its dimensions match
the values that you specified for at least one of
MaxWidth
and MaxHeight
without exceeding
either value. If you specify this option, Elastic Transcoder does not
scale the video up.ShrinkToFill
: Elastic
Transcoder scales the output video down so that its dimensions match
the values that you specified for at least one of
MaxWidth
and MaxHeight
without dropping
below either value. If you specify this option, Elastic Transcoder
does not scale the video up.
Constraints:
Pattern: (^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)
String paddingPolicy
PaddingPolicy
to Pad
, Elastic
Transcoder may add black bars to the top and bottom and/or left and
right sides of the output video to make the total size of the output
video match the values that you specified for MaxWidth
and MaxHeight
.
Constraints:
Pattern: (^Pad$)|(^NoPad$)
com.amazonaws.internal.ListWithAutoConstructFlag<T> watermarks
Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.
When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions.
String accountId
AccountId
is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.String vaultName
String uploadId
String accountId
AccountId
is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.String vaultName
String uploadId
String archiveSize
String checksum
String accountId
AccountId
is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.String vaultName
String location
String accountId
AccountId
is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.String vaultName
String archiveId
String accountId
AccountId
is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.String vaultName
String accountId
AccountId
is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.String vaultName
String accountId
AccountId
is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.String vaultName
String jobId
String jobId
String jobDescription
String action
Constraints:
Allowed Values: ArchiveRetrieval, InventoryRetrieval
String archiveId
String vaultARN
String creationDate
Boolean completed
String statusCode
Constraints:
Allowed Values: InProgress, Succeeded, Failed
String statusMessage
Long archiveSizeInBytes
Long inventorySizeInBytes
String sNSTopic
String completionDate
String sHA256TreeHash
String archiveSHA256TreeHash
String retrievalByteRange
String vaultARN
String vaultName
String creationDate
String lastInventoryDate
Long numberOfArchives
null
if an inventory has not yet
run on the vault, for example, if you just created the vault.Long sizeInBytes
String accountId
AccountId
is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.String vaultName
String vaultARN
String vaultName
String creationDate
String lastInventoryDate
Long numberOfArchives
null
if an inventory has not yet
run on the vault, for example, if you just created the vault.Long sizeInBytes
String accountId
AccountId
is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.String vaultName
String jobId
String range
InputStream body
String checksum
Integer status
String contentRange
String acceptRanges
String contentType
String archiveDescription
String accountId
AccountId
is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.String vaultName
VaultNotificationConfig vaultNotificationConfig
String jobId
String jobDescription
String action
Constraints:
Allowed Values: ArchiveRetrieval, InventoryRetrieval
String archiveId
String vaultARN
String creationDate
Boolean completed
String statusCode
Constraints:
Allowed Values: InProgress, Succeeded, Failed
String statusMessage
Long archiveSizeInBytes
Long inventorySizeInBytes
String sNSTopic
String completionDate
String sHA256TreeHash
String archiveSHA256TreeHash
String retrievalByteRange
String accountId
AccountId
is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.String vaultName
JobParameters jobParameters
String accountId
AccountId
is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.String vaultName
String archiveDescription
The part size must be a megabyte (1024 KB) multiplied by a power of 2���for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).
String partSize
String format
String 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
String accountId
AccountId
is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.String vaultName
String limit
String marker
String statuscode
String completed
true
or false
.com.amazonaws.internal.ListWithAutoConstructFlag<T> jobList
String marker
null
.String accountId
AccountId
is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.String vaultName
String uploadIdMarker
String limit
com.amazonaws.internal.ListWithAutoConstructFlag<T> uploadsList
String marker
null
.String accountId
AccountId
is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.String vaultName
String uploadId
String marker
String limit
String multipartUploadId
String vaultARN
String archiveDescription
Long partSizeInBytes
String creationDate
com.amazonaws.internal.ListWithAutoConstructFlag<T> parts
String marker
null
.String accountId
AccountId
is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.String marker
String limit
com.amazonaws.internal.ListWithAutoConstructFlag<T> vaultList
String marker
String accountId
AccountId
is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.String vaultName
VaultNotificationConfig vaultNotificationConfig
Long contentLength
String vaultName
String accountId
AccountId
is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.String archiveDescription
String checksum
InputStream body
String multipartUploadId
String vaultARN
String archiveDescription
Long partSizeInBytes
String creationDate
String accountId
AccountId
is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.String vaultName
String uploadId
String checksum
String range
InputStream body
String checksum
String sNSTopic
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String accessKeyId
Constraints:
Length: 16 - 32
Pattern: [\w]*
String status
Active
means the key is
valid for API calls, while Inactive
means it is not.
Constraints:
Allowed Values: Active, Inactive
String secretAccessKey
Date createDate
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String accessKeyId
Constraints:
Length: 16 - 32
Pattern: [\w]*
String status
Active
means the key is
valid for API calls, while Inactive
means it is not.
Constraints:
Allowed Values: Active, Inactive
Date createDate
String 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: (/)|(/[!-]+/)
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: (/)|(/[!-]+/)
InstanceProfile instanceProfile
LoginProfile loginProfile
String path
This parameter is optional. If it is not included, it defaults to a slash (/).
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String assumeRolePolicyDocument
Constraints:
Length: 1 - 131072
Pattern: [
-ÿ]+
Role role
String path
This parameter is optional. If it is not included, it defaults to a slash (/).
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
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: (/)|(/[!-]+/)
String virtualMFADeviceName
Constraints:
Length: 1 -
Pattern: [\w+=,.@-]*
VirtualMFADevice virtualMFADevice
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String serialNumber
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
String accountAlias
Constraints:
Length: 3 - 63
Pattern: ^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$
String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String instanceProfileName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String serverCertificateName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String serialNumber
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String serialNumber
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
String authenticationCode1
Constraints:
Length: 6 - 6
Pattern: [\d]*
String authenticationCode2
Constraints:
Length: 6 - 6
Pattern: [\d]*
PasswordPolicy passwordPolicy
This data type is used as a response element in the action GetAccountPasswordPolicy.
Map<K,V> summaryMap
SummaryMap
contains the following keys:
AccessKeysPerUserQuota
- Maximum number of access
keys that can be created per user
AccountMFAEnabled
- 1 if the root account has an
MFA device assigned to it, 0 otherwise
AssumeRolePolicySizeQuota
- Maximum allowed size
for assume role policy documents (in kilobytes)
GroupPolicySizeQuota
- Maximum allowed size for
Group policy documents (in kilobytes)
Groups
- Number of Groups for the AWS account
GroupsPerUserQuota
- Maximum number of groups a
user can belong to
GroupsQuota
- Maximum
groups allowed for the AWS account
InstanceProfiles
- Number of instance profiles for
the AWS account
InstanceProfilesQuota
-
Maximum instance profiles allowed for the AWS account
MFADevices
- Number of MFA devices, either
assigned or unassigned
MFADevicesInUse
-
Number of MFA devices that have been assigned to an IAM user or to the
root account
RolePolicySizeQuota
- Maximum
allowed size for role policy documents (in kilobytes)
Roles
- Number of roles for the AWS account
RolesQuota
- Maximum roles allowed for the AWS
account
ServerCertificates
- Number of server
certificates for the AWS account
ServerCertificatesQuota
- Maximum server
certificates allowed for the AWS account
SigningCertificatesPerUserQuota
- Maximum number
of X509 certificates allowed for a user
UserPolicySizeQuota
- Maximum allowed size for
user policy documents (in kilobytes)
Users
-
Number of users for the AWS account
UsersQuota
- Maximum users allowed for the AWS
account
String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [
-ÿ]+
String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String marker
Marker
element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
Integer maxItems
IsTruncated
response element is true
.
Constraints:
Range: 1 - 1000
Group group
com.amazonaws.internal.ListWithAutoConstructFlag<T> users
Boolean isTruncated
Marker
request parameter to retrieve
more user names in the list.String marker
true
, then this element is present and
contains the value to use for the Marker
parameter in a
subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
String instanceProfileName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
InstanceProfile instanceProfile
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
LoginProfile loginProfile
String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [
-ÿ]+
String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
Role role
String serverCertificateName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
ServerCertificate serverCertificate
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [
-ÿ]+
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: (/)|(/[!-]+/)
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: (/)|(/[!-]+/)
String instanceProfileName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String instanceProfileId
Constraints:
Length: 16 - 32
Pattern: [\w]*
String arn
Constraints:
Length: 20 - 2048
Date createDate
com.amazonaws.internal.ListWithAutoConstructFlag<T> roles
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String marker
Marker
element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
Integer maxItems
IsTruncated
response element is true
.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> accessKeyMetadata
Boolean isTruncated
Marker
request parameter to retrieve more keys
in the list.String marker
IsTruncated
is true
, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
String marker
Marker
element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
Integer maxItems
IsTruncated
response element is true
.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> accountAliases
Boolean isTruncated
Marker
request parameter to retrieve
more account aliases in the list.String marker
Marker
element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String marker
Marker
element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
Integer maxItems
IsTruncated
response element is true
.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
Boolean isTruncated
Marker
request parameter to retrieve
more policy names in the list.String marker
IsTruncated
is true
, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String marker
Marker
element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
Integer maxItems
IsTruncated
response
element is true
.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
Boolean isTruncated
Marker
request parameter to retrieve more
groups in the list.String marker
IsTruncated
is true
, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
String pathPrefix
/division_abc/subdivision_xyz/
, which would get all
groups whose path starts with
/division_abc/subdivision_xyz/
. This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups.
Constraints:
Length: 1 - 512
Pattern: /[!-]*
String marker
Marker
element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
Integer maxItems
IsTruncated
response
element is true
.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
Boolean isTruncated
Marker
request parameter to retrieve more
groups in the list.String marker
IsTruncated
is true
, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String marker
Marker
element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
Integer maxItems
IsTruncated
response element is true
.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceProfiles
Boolean isTruncated
Marker
request parameter to
retrieve more instance profiles in the list.String marker
IsTruncated
is true
, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
String pathPrefix
/application_abc/component_xyz/
, which would get all
instance profiles whose path starts with
/application_abc/component_xyz/
. This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles.
Constraints:
Length: 1 - 512
Pattern: /[!-]*
String marker
Marker
element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
Integer maxItems
IsTruncated
response element is true
.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceProfiles
Boolean isTruncated
Marker
request parameter to
retrieve more instance profiles in the list.String marker
IsTruncated
is true
, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String marker
Marker
element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
Integer maxItems
IsTruncated
response element is true
.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> mFADevices
Boolean isTruncated
Marker
request parameter to retrieve
more MFA devices in the list.String marker
IsTruncated
is true
, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String marker
Marker
element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
Integer maxItems
IsTruncated
response element is true
.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
Boolean isTruncated
Marker
request parameter to retrieve
more policy names in the list.String marker
IsTruncated
is true
, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
String pathPrefix
/application_abc/component_xyz/
, which would get all
roles whose path starts with
/application_abc/component_xyz/
. This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles.
Constraints:
Length: 1 - 512
Pattern: /[!-]*
String marker
Marker
element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
Integer maxItems
IsTruncated
response element is true
.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> roles
Boolean isTruncated
Marker
request parameter to retrieve more roles
in the list.String marker
IsTruncated
is true
, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
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: /[!-]*
String marker
Marker
element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
Integer maxItems
IsTruncated
response element will be set to
true
.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> serverCertificateMetadataList
Boolean isTruncated
Marker
request parameter to
retrieve more server certificates in the list.String marker
IsTruncated
is true
, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String marker
Marker
element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
Integer maxItems
IsTruncated
response element is true
.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> certificates
Boolean isTruncated
Marker
request parameter to retrieve
more certificates in the list.String marker
IsTruncated
is true
, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String marker
Marker
element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
Integer maxItems
IsTruncated
response element is true
.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
Boolean isTruncated
Marker
request parameter to retrieve
more policy names in the list.String marker
IsTruncated
is true
, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
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: /[!-]*
String marker
Marker
element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
Integer maxItems
IsTruncated
response element is true
.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> users
Boolean isTruncated
Marker
request parameter to retrieve
more users in the list.String marker
IsTruncated
is true
, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
String assignmentStatus
AssignmentStatus
, the action defaults to
Any
which lists both assigned and unassigned virtual MFA
devices.
Constraints:
Allowed Values: Assigned, Unassigned, Any
String marker
Marker
element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
Integer maxItems
IsTruncated
response element is true
.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> virtualMFADevices
Boolean isTruncated
Marker
request parameter to retrieve more items
the list.String marker
IsTruncated
is true
, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String serialNumber
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
Date enableDate
Integer minimumPasswordLength
Constraints:
Range: 6 - 128
Boolean requireSymbols
Boolean requireNumbers
Boolean requireUppercaseCharacters
Boolean requireLowercaseCharacters
Boolean allowUsersToChangePassword
String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [
-ÿ]+
String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [
-ÿ]+
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [
-ÿ]+
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: (/)|(/[!-]+/)
String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String roleId
Constraints:
Length: 16 - 32
Pattern: [\w]*
String arn
Constraints:
Length: 20 - 2048
Date createDate
String assumeRolePolicyDocument
The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.
Constraints:
Length: 1 - 131072
Pattern: [
-ÿ]+
ServerCertificateMetadata serverCertificateMetadata
String certificateBody
Constraints:
Length: 1 - 16384
Pattern: [
-ÿ]+
String certificateChain
Constraints:
Length: 1 - 2097152
Pattern: [
-ÿ]*
String path
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
String serverCertificateName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String serverCertificateId
Constraints:
Length: 16 - 32
Pattern: [\w]*
String arn
Constraints:
Length: 20 - 2048
Date uploadDate
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String certificateId
Constraints:
Length: 24 - 128
Pattern: [\w]*
String certificateBody
Constraints:
Length: 1 - 16384
Pattern: [
-ÿ]+
String status
Active
means the
key is valid for API calls, while Inactive
means it is
not.
Constraints:
Allowed Values: Active, Inactive
Date uploadDate
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String accessKeyId
Constraints:
Length: 16 - 32
Pattern: [\w]*
String status
Active
means the key can be used for API calls to AWS,
while Inactive
means the key cannot be used.
Constraints:
Allowed Values: Active, Inactive
Integer minimumPasswordLength
Boolean requireSymbols
Boolean requireNumbers
Boolean requireUppercaseCharacters
Boolean requireLowercaseCharacters
Boolean allowUsersToChangePassword
String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String newPath
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
String newGroupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String serverCertificateName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String newPath
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
String newServerCertificateName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String certificateId
Constraints:
Length: 24 - 128
Pattern: [\w]*
String status
Active
means the certificate can be used for API calls to AWS, while
Inactive
means the certificate cannot be used.
Constraints:
Allowed Values: Active, Inactive
String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String newPath
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
String newUserName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String path
This parameter is optional. If it is not included, it defaults to a slash (/).
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
String serverCertificateName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
String certificateBody
Constraints:
Length: 1 - 16384
Pattern: [
-ÿ]+
String privateKey
Constraints:
Length: 1 - 16384
Pattern: [
-ÿ]*
String certificateChain
Constraints:
Length: 1 - 2097152
Pattern: [
-ÿ]*
ServerCertificateMetadata serverCertificateMetadata
SigningCertificate certificate
String path
Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)
String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
String userId
Constraints:
Length: 16 - 32
Pattern: [\w]*
String arn
Constraints:
Length: 20 - 2048
Date createDate
String serialNumber
VirtualMFADevice
.
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
ByteBuffer base32StringSeed
Base32StringSeed
is
Base64-encoded.ByteBuffer qRCodePNG
Base32String
is Base64-encoded.User user
This data type is used as a response element in the following actions:
Date enableDate
String jobId
Boolean success
String jobType
Constraints:
Allowed Values: Import, Export
String manifest
String manifestAddendum
Boolean validateOnly
String jobId
String jobType
Constraints:
Allowed Values: Import, Export
String awsShippingAddress
String signature
String signatureFileContents
String warningMessage
String jobId
String jobId
String jobType
Constraints:
Allowed Values: Import, Export
String awsShippingAddress
String locationCode
String locationMessage
String progressCode
String progressMessage
String carrier
String trackingNumber
String logBucket
String logKey
Integer errorCount
String signature
String signatureFileContents
String currentManifest
Date creationDate
String jobId
Date creationDate
Boolean isCanceled
String jobType
Constraints:
Allowed Values: Import, Export
Integer maxJobs
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobs
Boolean isTruncated
String jobId
String manifest
String jobType
Constraints:
Allowed Values: Import, Export
Boolean validateOnly
String appId
String stackId
String shortname
String name
String description
String type
Constraints:
Allowed Values: 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
Integer instanceCount
Integer thresholdsWaitTime
Constraints:
Range: 1 - 100
Integer ignoreMetricsTime
IgnoreMetricsTime
allows you to direct
AWS OpsWorks to not raise any scaling events long enough to get the
new instances online.
Constraints:
Range: 1 - 100
Double cpuThreshold
Double memoryThreshold
Double loadThreshold
String sourceStackId
String name
String region
String vpcId
If the VPC ID corresponds
to a default VPC and you have specified either the
DefaultAvailabilityZone
or the
DefaultSubnetId
parameter only, AWS OpsWorks infers the
value of the other parameter. If you specify neither parameter, AWS
OpsWorks sets these parameters to the first valid Availability Zone
for the specified region and the corresponding default VPC subnet ID,
respectively.
If you specify a nondefault VPC ID, note the following:
DefaultSubnetId
.For more information on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2 Classic, see Supported Platforms.
Map<K,V> attributes
String serviceRoleArn
String defaultInstanceProfileArn
String defaultOs
Amazon Linux
or Ubuntu 12.04 LTS
. The
default option is Amazon Linux
.String hostnameTheme
HostnameTheme
is set to Layer_Dependent, which
creates host names by appending integers to the layer's short name.
The other themes are: 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
DefaultAvailabilityZone
,
the subnet must be in the same zone. For information on default values
and when this parameter is required, see the VpcId
parameter description.String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON
StackConfigurationManager configurationManager
Boolean useCustomCookbooks
Source customCookbooksSource
String defaultSshKeyName
Boolean clonePermissions
com.amazonaws.internal.ListWithAutoConstructFlag<T> cloneAppIds
String defaultRootDeviceType
Constraints:
Allowed Values: ebs, instance-store
String stackId
String commandId
String instanceId
String deploymentId
String createdAt
String acknowledgedAt
String completedAt
String status
Integer exitCode
String logUrl
String type
String stackId
String shortname
String name
String description
String type
Constraints:
Allowed Values: 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
String appId
String stackId
String appId
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
DeploymentCommand command
DeploymentCommand
object that specifies the deployment
command and any associated arguments.String comment
String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
String deploymentId
String stackId
com.amazonaws.internal.ListWithAutoConstructFlag<T> layerIds
String instanceType
String autoScalingType
Constraints:
Allowed Values: load, timer
String hostname
String os
Amazon
Linux
or Ubuntu 12.04 LTS
Custom
The default option is Amazon
Linux
. If you set this parameter to Custom
, you
must use the CreateInstance action's AmiId parameter to specify
the custom AMI that you want to use. For more information on the
standard operating systems, see Operating
SystemsFor more information on how to use custom AMIs with
OpsWorks, see Using
Custom AMIs.
String amiId
String sshKeyName
String availabilityZone
String subnetId
String architecture
Constraints:
Allowed Values: x86_64, i386
String rootDeviceType
Constraints:
Allowed Values: ebs, instance-store
Boolean installUpdatesOnBoot
true
. To control
when updates are installed, set this value to false
. You
must then update your instances manually by using
CreateDeployment to run the update_dependencies
stack command or manually running yum
(Amazon Linux) or
apt-get
(Ubuntu) on the instances. true
, to ensure that
your instances have the latest security updates.String instanceId
String stackId
String type
Constraints:
Allowed Values: lb, web, php-app, rails-app, nodejs-app, memcached, db-master, monitoring-master, custom
String name
String shortname
Map<K,V> attributes
String customInstanceProfileArn
com.amazonaws.internal.ListWithAutoConstructFlag<T> customSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> packages
Package
objects that describe the layer
packages.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeConfigurations
VolumeConfigurations
object that describes the layer
Amazon EBS volumes.Boolean enableAutoHealing
Boolean autoAssignElasticIps
Boolean autoAssignPublicIps
Recipes customRecipes
LayerCustomRecipes
object that specifies the layer
custom recipes.Boolean installUpdatesOnBoot
true
. To control
when updates are installed, set this value to false
. You
must then update your instances manually by using
CreateDeployment to run the update_dependencies
stack command or manually running yum
(Amazon Linux) or
apt-get
(Ubuntu) on the instances. true
, to ensure that
your instances have the latest security updates.String layerId
String name
String region
String vpcId
If the VPC ID corresponds to a
default VPC and you have specified either the
DefaultAvailabilityZone
or the
DefaultSubnetId
parameter only, AWS OpsWorks infers the
value of the other parameter. If you specify neither parameter, AWS
OpsWorks sets these parameters to the first valid Availability Zone
for the specified region and the corresponding default VPC subnet ID,
respectively.
If you specify a nondefault VPC ID, note the following:
DefaultSubnetId
.For more information on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2 Classic, see Supported Platforms.
Map<K,V> attributes
String serviceRoleArn
String defaultInstanceProfileArn
String defaultOs
Amazon Linux
or Ubuntu 12.04 LTS
. The
default option is Amazon Linux
.String hostnameTheme
HostnameTheme
is set to Layer_Dependent, which
creates host names by appending integers to the layer's short name.
The other themes are: 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
DefaultAvailabilityZone
,
the subnet must be in that zone. For information on default values and
when this parameter is required, see the VpcId
parameter
description.String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
StackConfigurationManager configurationManager
Boolean useCustomCookbooks
Source customCookbooksSource
String defaultSshKeyName
String defaultRootDeviceType
Constraints:
Allowed Values: ebs, instance-store
String stackId
DescribeStacks
.String iamUserArn
String appId
String layerId
String stackId
String iamUserArn
String deploymentId
String stackId
String appId
String createdAt
String completedAt
Integer duration
String iamUserArn
String comment
DeploymentCommand command
String status
String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
String name
For stacks, the available commands are:
execute_recipes: Execute the recipes that are
specified by the Args
parameter.
install_dependencies: Installs the stack's
dependencies.
update_custom_cookbooks: Update
the stack's custom cookbooks.
update_dependencies: Update the stack's
dependencies.For apps, the available commands are:
deploy
: Deploy the app.rollback
Roll the app back to the previous version.
When you update an app, AWS OpsWorks stores the previous version, up
to a maximum of five versions. You can use this command to roll an app
back as many as four versions.start
: Start the
app's web or application server.stop
: Stop the
app's web or application server.restart
:
Restart the app's web or application server.undeploy
: Undeploy the app.
Constraints:
Allowed Values: install_dependencies, update_dependencies, update_custom_cookbooks, execute_recipes, deploy, rollback, start, stop, restart, undeploy
Map<K,V> args
ExecuteRecipes
command.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.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.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.String instanceId
DescribeElasticIps
returns a description of the Elastic
IP addresses associated with the specified instance.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.String stackId
com.amazonaws.internal.ListWithAutoConstructFlag<T> layerIds
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.String stackId
com.amazonaws.internal.ListWithAutoConstructFlag<T> layerIds
DescribeLayers
returns a description
of every layer in the specified stack.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.com.amazonaws.internal.ListWithAutoConstructFlag<T> raidArrayIds
DescribeRaidArrays
returns descriptions of the specified
arrays. Otherwise, it returns a description of every array.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.String instanceId
DescribeVolumes
returns descriptions of the volumes
associated with the specified instance.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.String ip
String name
String domain
String region
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 layerId
String instanceId
String ec2InstanceId
String hostname
String stackId
com.amazonaws.internal.ListWithAutoConstructFlag<T> layerIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
String instanceType
String instanceProfileArn
String status
String os
String amiId
String availabilityZone
String subnetId
String publicDns
String privateDns
String publicIp
String privateIp
String elasticIp
String autoScalingType
Constraints:
Allowed Values: load, timer
String sshKeyName
String sshHostRsaKeyFingerprint
String sshHostDsaKeyFingerprint
String createdAt
String lastServiceErrorId
String architecture
Constraints:
Allowed Values: x86_64, i386
String rootDeviceType
Constraints:
Allowed Values: ebs, instance-store
String rootDeviceVolumeId
Boolean installUpdatesOnBoot
true
. If this value
is set to false
, you must then update your instances
manually by using CreateDeployment to run the
update_dependencies
stack command or manually running
yum
(Amazon Linux) or apt-get
(Ubuntu) on
the instances. true
, to ensure that your instances have the latest
security updates.String stackId
String layerId
String type
Constraints:
Allowed Values: lb, web, php-app, rails-app, nodejs-app, memcached, db-master, monitoring-master, custom
String name
String shortname
Map<K,V> attributes
String customInstanceProfileArn
com.amazonaws.internal.ListWithAutoConstructFlag<T> customSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> defaultSecurityGroupNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> packages
Package
objects that describe the layer's
packages.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeConfigurations
VolumeConfigurations
object that describes the layer's
Amazon EBS volumes.Boolean enableAutoHealing
Boolean autoAssignElasticIps
Boolean autoAssignPublicIps
Recipes defaultRecipes
LayerCustomRecipes
specifies the custom recipes for a particular layer to be run in
response to each of the five events. To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.
Recipes customRecipes
LayerCustomRecipes
object that specifies the layer's
custom recipes.String createdAt
Boolean installUpdatesOnBoot
true
. If this value
is set to false
, you must then update your instances
manually by using CreateDeployment to run the
update_dependencies
stack command or manually running
yum
(Amazon Linux) or apt-get
(Ubuntu) on
the instances. true
, to ensure that your instances have the latest
security updates.String layerId
Boolean enable
AutoScalingThresholds upScaling
LoadBasedAutoscalingInstruction
object that describes
the upscaling configuration, which defines how and when AWS OpsWorks
increases the number of instances.AutoScalingThresholds downScaling
LoadBasedAutoscalingInstruction
object that describes
the downscaling configuration, which defines how and when AWS OpsWorks
reduces the number of instances.String stackId
String iamUserArn
Boolean allowSsh
Boolean allowSudo
String raidArrayId
String instanceId
String name
Integer raidLevel
Integer numberOfDisks
Integer size
String device
String mountPoint
String availabilityZone
String createdAt
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 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 instanceId
WeeklyAutoScalingSchedule autoScalingSchedule
AutoScalingSchedule
with the instance schedule.String type
Constraints:
Allowed Values: git, svn, archive, s3
String url
String username
Username
to the appropriate AWS access
key.Username
to the user name.String password
Password
to the appropriate AWS secret
key.Password
to the password.String sshKey
String revision
String stackId
String name
String region
String vpcId
Map<K,V> attributes
String serviceRoleArn
String defaultInstanceProfileArn
String defaultOs
Amazon Linux
or Ubuntu 12.04 LTS
. The
default option is Amazon Linux
.String hostnameTheme
String defaultAvailabilityZone
String defaultSubnetId
String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
StackConfigurationManager configurationManager
Boolean useCustomCookbooks
Source customCookbooksSource
String defaultSshKeyName
String createdAt
String defaultRootDeviceType
Constraints:
Allowed Values: ebs, instance-store
String instanceId
String stackId
String instanceId
String stackId
String instanceId
WeeklyAutoScalingSchedule autoScalingSchedule
WeeklyAutoScalingSchedule
object with the instance
schedule.String appId
String name
String description
String type
Constraints:
Allowed Values: 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
String instanceId
com.amazonaws.internal.ListWithAutoConstructFlag<T> layerIds
String instanceType
String autoScalingType
Constraints:
Allowed Values: load, timer
String hostname
String os
Amazon
Linux
or Ubuntu 12.04 LTS
Custom
The default option is Amazon
Linux
. If you set this parameter to Custom
, you
must use the CreateInstance action's AmiId parameter to specify
the custom AMI that you want to use. For more information on the
standard operating systems, see Operating
SystemsFor more information on how to use custom AMIs with
OpsWorks, see Using
Custom AMIs.
String amiId
String sshKeyName
String architecture
Constraints:
Allowed Values: x86_64, i386
Boolean installUpdatesOnBoot
true
. To control
when updates are installed, set this value to false
. You
must then update your instances manually by using
CreateDeployment to run the update_dependencies
stack command or manually running yum
(Amazon Linux) or
apt-get
(Ubuntu) on the instances. true
, to ensure that
your instances have the latest security updates.String layerId
String name
String shortname
Map<K,V> attributes
String customInstanceProfileArn
com.amazonaws.internal.ListWithAutoConstructFlag<T> customSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> packages
Package
objects that describe the layer's
packages.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeConfigurations
VolumeConfigurations
object that describes the layer's
Amazon EBS volumes.Boolean enableAutoHealing
Boolean autoAssignElasticIps
Boolean autoAssignPublicIps
Recipes customRecipes
LayerCustomRecipes
object that specifies the layer's
custom recipes.Boolean installUpdatesOnBoot
true
. To control
when updates are installed, set this value to false
. You
must then update your instances manually by using
CreateDeployment to run the update_dependencies
stack command or manually running yum
(Amazon Linux) or
apt-get
(Ubuntu) on the instances. true
, to ensure that
your instances have the latest security updates.String stackId
String name
Map<K,V> attributes
String serviceRoleArn
String defaultInstanceProfileArn
String defaultOs
Amazon Linux
or Ubuntu 12.04 LTS
. The
default option is Amazon Linux
.String hostnameTheme
HostnameTheme
is set to
Layer_Dependent, which creates host names by appending integers to the
layer's short name. The other themes are: 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
DefaultAvailabilityZone
,
the subnet must be in that zone. For more information, see
CreateStack.String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
StackConfigurationManager configurationManager
Boolean useCustomCookbooks
Source customCookbooksSource
String defaultSshKeyName
String defaultRootDeviceType
Constraints:
Allowed Values: ebs, instance-store
String volumeId
String ec2VolumeId
String name
String raidArrayId
String instanceId
String status
Integer size
String device
String mountPoint
String region
String availabilityZone
String mountPoint
Integer raidLevel
Integer numberOfDisks
Integer size
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:
String resourceName
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBSecurityGroupName
String cIDRIP
String eC2SecurityGroupName
EC2SecurityGroupId
must be provided. Otherwise,
EC2SecurityGroupOwnerId and either EC2SecurityGroupName
or EC2SecurityGroupId
must be provided.String eC2SecurityGroupId
EC2SecurityGroupId
must be provided. Otherwise,
EC2SecurityGroupOwnerId and either EC2SecurityGroupName
or EC2SecurityGroupId
must be provided.String eC2SecurityGroupOwnerId
EC2SecurityGroupId
must be provided. Otherwise,
EC2SecurityGroupOwnerId and either EC2SecurityGroupName
or EC2SecurityGroupId
must be provided.String sourceDBSnapshotIdentifier
Constraints:
Example:
rds:mydb-2012-04-02-00-01
String targetDBSnapshotIdentifier
Constraints:
Example: my-db-snapshot
String dBInstanceIdentifier
String sourceDBInstanceIdentifier
Constraints: Must be the identifier of an existing DB Instance that is not already a Read Replica DB Instance.
String dBInstanceClass
Valid Values:
db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge |
db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge
Default: Inherits from the source DB Instance.
String availabilityZone
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
Integer port
Default: Inherits from the source DB Instance
Valid Values:
1150-65535
Boolean autoMinorVersionUpgrade
Default: Inherits from the source DB Instance
Integer iops
String optionGroupName
Boolean publiclyAccessible
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
String dBName
MySQL
The name of the database to create when the DB Instance is created. If this parameter is not specified, no database is created in the DB Instance.
Constraints:
Type: String
Oracle
The Oracle System ID (SID) of the created DB Instance.
Default: ORCL
Constraints:
SQL Server
Not applicable. Must be null.
String dBInstanceIdentifier
Constraints:
Example:
mydbinstance
Integer allocatedStorage
MySQL
Constraints: Must be an integer from 5 to 1024.
Type: Integer
Oracle
Constraints: Must be an integer from 10 to 1024.
SQL Server
Constraints: Must be an integer from 200 to 1024 (Standard Edition and Enterprise Edition) or from 30 to 1024 (Express Edition and Web Edition)
String dBInstanceClass
Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large |
db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge
String engine
Valid Values: MySQL
| oracle-se1
|
oracle-se
| oracle-ee
|
sqlserver-ee
| sqlserver-se
|
sqlserver-ex
| sqlserver-web
String masterUsername
MySQL
Constraints:
Type: String
Oracle
Constraints:
SQL Server
Constraints:
String masterUserPassword
Type: String
MySQL
Constraints: Must contain from 8 to 41 alphanumeric characters.
Oracle
Constraints: Must contain from 8 to 30 alphanumeric characters.
SQL Server
Constraints: Must contain from 8 to 128 alphanumeric characters.
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
Default: The default DB Security Group for the database engine.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Default: The default EC2 VPC Security Group for the DB Subnet group's VPC.
String availabilityZone
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter cannot be specified if the
MultiAZ parameter is set to true
. The specified
Availability Zone must be in the same region as the current endpoint.
String dBSubnetGroupName
If there is no DB Subnet Group, then it is a non-VPC DB instance.
String preferredMaintenanceWindow
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
String dBParameterGroupName
Constraints:
Integer backupRetentionPeriod
Default: 1
Constraints:
String preferredBackupWindow
BackupRetentionPeriod
parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned.
Constraints: Must be in the format
hh24:mi-hh24:mi
. Times should be Universal Time
Coordinated (UTC). Must not conflict with the preferred maintenance
window. Must be at least 30 minutes.
Integer port
MySQL
Default: 3306
Valid Values:
1150-65535
Type: Integer
Oracle
Default:
1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values:
1150-65535
except for 1434
and
3389
.
Boolean multiAZ
String engineVersion
MySQL
Example: 5.1.42
Type: String
Oracle
Example: 11.2.0.2.v2
Type: String
SQL Server
Example: 10.50.2789.0.v1
Boolean autoMinorVersionUpgrade
Default:
true
String licenseModel
Valid values:
license-included
| bring-your-own-license
|
general-public-license
Integer iops
Constraints: Must be an integer greater than 1000.
String optionGroupName
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
String characterSetName
Boolean publiclyAccessible
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
String dBParameterGroupName
Constraints:
String dBParameterGroupFamily
String description
String dBSecurityGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".
Example:
mysecuritygroup
String dBSecurityGroupDescription
String dBSnapshotIdentifier
Constraints:
Example: my-snapshot-id
String dBInstanceIdentifier
Constraints:
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
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:
Boolean enabled
String optionGroupName
Constraints:
Example:
myOptiongroup
String engineName
String majorEngineVersion
String optionGroupDescription
String engine
String engineVersion
String dBParameterGroupFamily
String dBEngineDescription
String dBEngineVersionDescription
CharacterSet defaultCharacterSet
CharacterSetName
parameter of the CreateDBInstance
API is not specified.com.amazonaws.internal.ListWithAutoConstructFlag<T> supportedCharacterSets
CharacterSetName
parameter of the CreateDBInstance API.String dBInstanceIdentifier
String dBInstanceClass
String engine
String dBInstanceStatus
String masterUsername
String dBName
MySQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created. This same name is returned for the life of the DB Instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB Instance.
Endpoint endpoint
Integer allocatedStorage
Date instanceCreateTime
String preferredBackupWindow
BackupRetentionPeriod
.Integer backupRetentionPeriod
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBParameterGroups
String availabilityZone
DBSubnetGroup dBSubnetGroup
String preferredMaintenanceWindow
PendingModifiedValues pendingModifiedValues
Date latestRestorableTime
Boolean multiAZ
String engineVersion
Boolean autoMinorVersionUpgrade
String readReplicaSourceDBInstanceIdentifier
com.amazonaws.internal.ListWithAutoConstructFlag<T> readReplicaDBInstanceIdentifiers
String licenseModel
Integer iops
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupMemberships
String characterSetName
String secondaryAvailabilityZone
Boolean publiclyAccessible
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
com.amazonaws.internal.ListWithAutoConstructFlag<T> statusInfos
String statusType
Boolean normal
String status
String message
String dBParameterGroupName
String dBParameterGroupFamily
String description
String ownerId
String dBSecurityGroupName
String dBSecurityGroupDescription
String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> eC2SecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> iPRanges
String dBSnapshotIdentifier
String dBInstanceIdentifier
Date snapshotCreateTime
String engine
Integer allocatedStorage
String status
Integer port
String availabilityZone
String vpcId
Date instanceCreateTime
String masterUsername
String engineVersion
String licenseModel
String snapshotType
Integer iops
String optionGroupName
String dBSubnetGroupName
String dBSubnetGroupDescription
String vpcId
String subnetGroupStatus
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
String dBInstanceIdentifier
Constraints:
Boolean skipFinalSnapshot
true
is specified, no DBSnapshot
is created. If false is specified, a DB Snapshot is created before the
DB Instance is deleted. false
.Default: false
String finalDBSnapshotIdentifier
false
. Constraints:
String dBParameterGroupName
Constraints:
String dBSecurityGroupName
Constraints:
String dBSnapshotIdentifier
Constraints: Must be the name of an
existing DB Snapshot in the available
state.
String dBSubnetGroupName
Constraints:
String subscriptionName
String optionGroupName
String engine
String engineVersion
Example: 5.1.49
String dBParameterGroupFamily
Constraints:
Integer maxRecords
MaxRecords
value is available, a pagination token
called a marker is included in the response so that the following
results can be retrieved. Default: 100
Constraints: minimum 20, maximum 100
String marker
MaxRecords
.Boolean defaultOnly
Boolean listSupportedCharacterSets
String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBEngineVersions
DBEngineVersion
elements.String dBInstanceIdentifier
Constraints:
Integer maxRecords
MaxRecords
value, a
pagination token called a marker is included in the response so that
the remaining results may be retrieved. Default: 100
Constraints: minimum 20, maximum 100
String marker
MaxRecords
.String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBInstances
String dBInstanceIdentifier
Constraints:
String filenameContains
Long fileLastWritten
Long fileSize
Integer maxRecords
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> describeDBLogFiles
String marker
String dBParameterGroupName
Constraints:
Integer maxRecords
MaxRecords
value, a
pagination token called a marker is included in the response so that
the remaining results may be retrieved. Default: 100
Constraints: minimum 20, maximum 100
String marker
MaxRecords
.String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBParameterGroups
String dBParameterGroupName
Constraints:
String source
Default: All parameter types returned
Valid Values: user | system | engine-default
Integer maxRecords
MaxRecords
value, a
pagination token called a marker is included in the response so that
the remaining results may be retrieved. Default: 100
Constraints: minimum 20, maximum 100
String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
String marker
MaxRecords
.String dBSecurityGroupName
Integer maxRecords
MaxRecords
value, a
pagination token called a marker is included in the response so that
the remaining results may be retrieved. Default: 100
Constraints: minimum 20, maximum 100
String marker
MaxRecords
.String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
String dBInstanceIdentifier
Constraints:
String dBSnapshotIdentifier
Constraints:
SnapshotType
parameter must also be specified.String snapshotType
Integer maxRecords
MaxRecords
value, a
pagination token called a marker is included in the response so that
the remaining results may be retrieved. Default: 100
Constraints: minimum 20, maximum 100
String marker
MaxRecords
.String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSnapshots
String dBSubnetGroupName
Integer maxRecords
MaxRecords
value, a
pagination token called a marker is included in the response so that
the remaining results may be retrieved. Default: 100
Constraints: minimum 20, maximum 100
String marker
MaxRecords
.String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSubnetGroups
String dBParameterGroupFamily
Integer maxRecords
MaxRecords
value, a
pagination token called a marker is included in the response so that
the remaining results may be retrieved. Default: 100
Constraints: minimum 20, maximum 100
String marker
MaxRecords
.String sourceType
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
String sourceIdentifier
Constraints:
String sourceType
Constraints:
Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot
Date startTime
Example: 2009-07-08T18:00Z
Date endTime
Example: 2009-07-08T18:00Z
Integer duration
Default: 60
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
Integer maxRecords
MaxRecords
value, a
pagination token called a marker is included in the response so that
the remaining results may be retrieved. Default: 100
Constraints: minimum 20, maximum 100
String marker
MaxRecords
.String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String subscriptionName
Integer maxRecords
MaxRecords
value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: minimum 20, maximum 100
String marker
MaxRecords
.String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> eventSubscriptionsList
String engineName
String majorEngineVersion
Integer maxRecords
MaxRecords
value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: minimum 20, maximum 100
String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupOptions
String marker
MaxRecords
.String optionGroupName
String marker
MaxRecords
.Integer maxRecords
MaxRecords
value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: minimum 20, maximum 100
String engineName
String majorEngineVersion
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupsList
String marker
MaxRecords
.String engine
String engineVersion
String dBInstanceClass
String licenseModel
Boolean vpc
Integer maxRecords
MaxRecords
value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: minimum 20, maximum 100
String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> orderableDBInstanceOptions
String marker
MaxRecords
.String reservedDBInstancesOfferingId
Example:
438012d3-4052-4cc7-b2e3-8d3372e0e706
String dBInstanceClass
String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
String productDescription
String offeringType
Valid
Values: "Light Utilization" | "Medium Utilization" | "Heavy
Utilization"
Boolean multiAZ
Integer maxRecords
MaxRecords
value is available, a pagination token
called a marker is included in the response so that the following
results can be retrieved. Default: 100
Constraints: minimum 20, maximum 100
String marker
MaxRecords
.String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedDBInstancesOfferings
String reservedDBInstanceId
String reservedDBInstancesOfferingId
String dBInstanceClass
String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
String productDescription
String offeringType
Valid
Values: "Light Utilization" | "Medium Utilization" | "Heavy
Utilization"
Boolean multiAZ
Integer maxRecords
MaxRecords
value is available, a pagination token
called a marker is included in the response so that the following
results can be retrieved. Default: 100
Constraints: minimum 20, maximum 100
String marker
MaxRecords
.String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedDBInstances
String dBInstanceIdentifier
Constraints:
String logFileName
String marker
Integer numberOfLines
String logFileData
String marker
Boolean additionalDataPending
String status
String eC2SecurityGroupName
String eC2SecurityGroupId
String eC2SecurityGroupOwnerId
EC2SecurityGroupName
field.String dBParameterGroupFamily
String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
String sourceIdentifier
String sourceType
Constraints:
Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot
String message
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
Date date
String sourceType
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
String customerAwsId
String custSubscriptionId
String snsTopicArn
String status
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
String subscriptionCreationTime
String sourceType
com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceIdsList
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategoriesList
Boolean enabled
String resourceName
String dBInstanceIdentifier
Constraints:
Integer allocatedStorage
ApplyImmediately
parameter
is set to true
for this request. MySQL
Default: Uses existing setting
Valid Values: 5-1024
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
Oracle
Default: Uses existing setting
Valid Values: 10-1024
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
SQL Server
Cannot be modified.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
String dBInstanceClass
Passing
a value for this parameter causes an outage during the change and is
applied during the next maintenance window, unless the
ApplyImmediately
parameter is specified as
true
for this request.
Default: Uses existing setting
Valid Values: db.t1.micro | db.m1.small | db.m1.medium |
db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge |
db.m2.4xlarge
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Constraints:
Boolean applyImmediately
PreferredMaintenanceWindow
setting for
the DB Instance. If this parameter is passed as
false
, changes to the DB Instance are applied on the next
call to RebootDBInstance, the next maintenance reboot, or the
next failure reboot, whichever occurs first. See each parameter to
determine when a change is applied.
Default: false
String masterUserPassword
Changing this parameter
does not result in an outage and the change is asynchronously applied
as soon as possible. Between the time of the request and the
completion of the request, the MasterUserPassword
element
exists in the PendingModifiedValues
element of the
operation response.
Default: Uses existing setting
Constraints:
Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric
characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).
String dBParameterGroupName
ApplyImmediately
parameter is set to true
for this request. Default: Uses existing setting
Constraints: The DB Parameter Group must be in the same DB Parameter Group family as this DB Instance.
Integer backupRetentionPeriod
Changing this parameter can result in
an outage if you change from 0 to a non-zero value or from a non-zero
value to 0. These changes are applied during the next maintenance
window unless the ApplyImmediately
parameter is set to
true
for this request. If you change the parameter from
one non-zero value to another non-zero value, the change is
asynchronously applied as soon as possible.
Default: Uses existing setting
Constraints:
String preferredBackupWindow
BackupRetentionPeriod
. Changing this parameter does not
result in an outage and the change is asynchronously applied as soon
as possible. Constraints:
String preferredMaintenanceWindow
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
Boolean multiAZ
ApplyImmediately
parameter is set to true
for this request. Constraints: Cannot be specified if the DB Instance is a read replica.
String engineVersion
ApplyImmediately
parameter is set to true
for this request. For major version upgrades, if a nondefault DB Parameter Group is currently in use, a new DB Parameter Group in the DB Parameter Group Family for the new engine version must be specified. The new DB Parameter Group can be the default for that DB Parameter Group Family.
Example:
5.1.42
Boolean allowMajorVersionUpgrade
Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB Instance's current version.
Boolean autoMinorVersionUpgrade
true
during the
maintenance window, and a newer minor version is available, and RDS
has enabled auto patching for that engine version.Integer iops
ApplyImmediately
parameter is set to true
for this request. Default: Uses existing setting
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
String optionGroupName
ApplyImmediately
parameter
is set to true
for this request. If the parameter change
results in an option group that enables OEM, this change can cause a
brief (sub-second) period during which new connections are rejected
but existing connections are not interrupted. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
String newDBInstanceIdentifier
Constraints:
String dBParameterGroupName
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
Valid Values (for
the application method): immediate | pending-reboot
String dBParameterGroupName
String dBSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".
Example:
mySubnetgroup
String dBSubnetGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
String subscriptionName
String snsTopicArn
String sourceType
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
Boolean enabled
String optionGroupName
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsToInclude
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsToRemove
Boolean applyImmediately
String optionName
String optionDescription
Boolean persistent
Boolean permanent
Integer port
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroupMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupMemberships
String optionName
Integer port
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroupMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
String optionGroupName
String optionGroupDescription
String engineName
String majorEngineVersion
com.amazonaws.internal.ListWithAutoConstructFlag<T> options
Boolean allowsVpcAndNonVpcInstanceMemberships
String vpcId
String name
String description
String engineName
String majorEngineVersion
String minimumRequiredMinorEngineVersion
Boolean portRequired
Integer defaultPort
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsDependedOn
Boolean persistent
Boolean permanent
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupOptionSettings
String settingName
String settingDescription
String defaultValue
String applyType
String allowedValues
Boolean isModifiable
String name
String value
String defaultValue
String description
String applyType
String dataType
String allowedValues
Boolean isModifiable
Boolean isCollection
String engine
String engineVersion
String dBInstanceClass
String licenseModel
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Boolean multiAZCapable
Boolean readReplicaCapable
Boolean vpc
String parameterName
String parameterValue
String description
String source
String applyType
String dataType
String allowedValues
Boolean isModifiable
true
) or not (false
) the
parameter can be modified. Some parameters have security or
operational implications that prevent them from being changed.String minimumEngineVersion
String applyMethod
Constraints:
Allowed Values: immediate, pending-reboot
String dBInstanceClass
DBInstanceClass
for the DB Instance that
will be applied or is in progress.Integer allocatedStorage
AllocatedStorage
size for the DB
Instance that will be applied or is in progress.String masterUserPassword
Integer port
Integer backupRetentionPeriod
Boolean multiAZ
String engineVersion
Integer iops
String dBInstanceIdentifier
DBInstanceIdentifier
for the DB Instance
that will be applied or is in progress.String dBInstanceIdentifier
Constraints:
Example:
Integer backupRetentionPeriod
Default: 1
Constraints:
String preferredBackupWindow
BackupRetentionPeriod
parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned.
Constraints: Must be in the format
hh24:mi-hh24:mi
. Times should be Universal Time
Coordinated (UTC). Must not conflict with the preferred maintenance
window. Must be at least 30 minutes.
String reservedDBInstancesOfferingId
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
String reservedDBInstanceId
Example: myreservationID
Integer dBInstanceCount
Default: 1
String dBInstanceIdentifier
Constraints:
Boolean forceFailover
true
, the reboot will be conducted through a MultiAZ
failover. Constraint: You cannot specify true
if the
instance is not configured for MultiAZ.
String subscriptionName
String sourceIdentifier
String resourceName
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
String reservedDBInstanceId
String reservedDBInstancesOfferingId
String dBInstanceClass
Date startTime
Integer duration
Double fixedPrice
Double usagePrice
String currencyCode
Integer dBInstanceCount
String productDescription
String offeringType
Boolean multiAZ
String state
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String reservedDBInstancesOfferingId
String dBInstanceClass
Integer duration
Double fixedPrice
Double usagePrice
String currencyCode
String productDescription
String offeringType
Boolean multiAZ
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String dBParameterGroupName
Constraints:
Boolean resetAllParameters
true
) or not (false
) to
reset all parameters in the DB Parameter Group to default values.
Default: true
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
MySQL
Valid Values (for Apply method): immediate
|
pending-reboot
You can use the immediate value with
dynamic parameters only. You can use the pending-reboot
value for both dynamic and static parameters, and changes are applied
when DB Instance reboots.
Oracle
Valid Values (for Apply
method): pending-reboot
String dBParameterGroupName
String dBInstanceIdentifier
Constraints:
String dBSnapshotIdentifier
Constraints:
Example: my-snapshot-id
String dBInstanceClass
Valid Values: db.t1.micro | db.m1.small | db.m1.medium |
db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge
Integer port
Default: The same port as the original DB Instance
Constraints: Value must
be 1150-65535
String availabilityZone
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if
the MultiAZ parameter is set to true
.
Example:
us-east-1a
String dBSubnetGroupName
Boolean multiAZ
Constraint:
You cannot specify the AvailabilityZone parameter if the MultiAZ
parameter is set to true
.
Boolean publiclyAccessible
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
Boolean autoMinorVersionUpgrade
String licenseModel
Default: Same as source.
Valid values: license-included
|
bring-your-own-license
|
general-public-license
String dBName
This parameter doesn't apply to the MySQL engine.
String engine
Default: The same as source
Constraint: Must be compatible with the engine of the source
Example: oracle-ee
Integer iops
Constraints: Must be an integer greater than 1000.
String optionGroupName
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
String sourceDBInstanceIdentifier
Constraints:
String targetDBInstanceIdentifier
Constraints:
Date restoreTime
Valid Values: Value must be a UTC time
Constraints:
Example:
2009-09-07T23:45:00Z
Boolean useLatestRestorableTime
true
) or not (false
) the
DB Instance is restored from the latest backup time. Default:
false
Constraints: Cannot be specified if RestoreTime parameter is provided.
String dBInstanceClass
Valid Values: db.t1.micro | db.m1.small | db.m1.medium |
db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge
Default: The same DBInstanceClass as the original DB Instance.
Integer port
Constraints: Value must be 1150-65535
Default: The same port as the original DB Instance.
String availabilityZone
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Example:
us-east-1a
String dBSubnetGroupName
Boolean multiAZ
Constraint:
You cannot specify the AvailabilityZone parameter if the MultiAZ
parameter is set to true
.
Boolean publiclyAccessible
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
Boolean autoMinorVersionUpgrade
String licenseModel
Default: Same as source.
Valid values: license-included
|
bring-your-own-license
|
general-public-license
String dBName
This parameter is not used for the MySQL engine.
String engine
Default: The same as source
Constraint: Must be compatible with the engine of the source
Example: oracle-ee
Integer iops
Constraints: Must be an integer greater than 1000.
String optionGroupName
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
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
, and resizing
.String modifyStatus
String masterUsername
String dBName
Endpoint endpoint
Date clusterCreateTime
Integer automatedSnapshotRetentionPeriod
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterSecurityGroups
ClusterSecurityGroup.Name
and
ClusterSecurityGroup.Status
subelements. Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterParameterGroups
String clusterSubnetGroupName
String vpcId
String availabilityZone
String preferredMaintenanceWindow
PendingModifiedValues pendingModifiedValues
String clusterVersion
Boolean allowVersionUpgrade
true
, version upgrades will be applied automatically
to the cluster during the maintenance window.Integer numberOfNodes
Boolean publiclyAccessible
true
, the cluster can be accessed from a public
network.Boolean encrypted
true
, data in cluster is encrypted at rest.RestoreStatus restoreStatus
String parameterGroupName
String parameterGroupFamily
String description
String clusterSecurityGroupName
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> eC2SecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> iPRanges
String clusterSubnetGroupName
String description
String vpcId
String subnetGroupStatus
Complete
, Incomplete
and
Invalid
.com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
String sourceSnapshotIdentifier
Constraints:
String sourceSnapshotClusterIdentifier
Constraints:
String targetSnapshotIdentifier
Constraints:
String parameterGroupName
Constraints:
String parameterGroupFamily
To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift-1.0".
String description
String dBName
To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift 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: dw.hs1.xlarge
|
dw.hs1.8xlarge
.
String masterUsername
Constraints:
String masterUserPassword
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterSecurityGroups
Default: The default cluster security group for Amazon Redshift.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Default: The default VPC security group is associated with the cluster.
String clusterSubnetGroupName
If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
String availabilityZone
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example:
us-east-1d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
String preferredMaintenanceWindow
Format:
ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. The following list shows the time blocks for each region from which the default maintenance windows are assigned.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
String clusterParameterGroupName
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
Integer automatedSnapshotRetentionPeriod
Default: 1
Constraints: Must be a value from 0 to 35.
Integer port
The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.
Default:
5439
Valid Values: 1150-65535
String clusterVersion
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
Boolean allowVersionUpgrade
true
, upgrades can be applied during the maintenance
window to the Amazon Redshift engine that is running on the cluster.
When a new version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.
Default: true
Integer numberOfNodes
multi-node
. For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Management Guide.
If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.
Default:
1
Constraints: Value must be at least 1 and no more than 100.
Boolean publiclyAccessible
true
, the cluster can be accessed from a public
network.Boolean encrypted
true
, the data in cluster is encrypted at rest.
Default: false
String clusterSecurityGroupName
Constraints:
Example:
examplesecuritygroup
String description
String snapshotIdentifier
Constraints:
Example:
my-snapshot-id
String clusterIdentifier
String clusterSubnetGroupName
Constraints:
Example:
examplesubnetgroup
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
String parameterGroupFamily
String marker
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 parameterGroupName
Integer maxRecords
MaxRecords
value, the response includes a marker that you
can use in a subsequent DescribeClusterParameterGroups request
to retrieve the next set of records. Default: 100
Constraints: Value must be at least 20 and no more than 100.
String marker
String marker
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,
response includes a marker that you can specify in your subsequent
request to retrieve remaining result. Default: 100
Constraints: Value must be at least 20 and no more than 100.
String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
String marker
String clusterSecurityGroupName
Example:
securitygroup1
Integer maxRecords
MaxRecords
value, a
marker is included in the response, which you can use in a subsequent
DescribeClusterSecurityGroups request. Default:
100
Constraints: Value must be at least 20 and no more than 100.
String marker
String marker
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,
the response returns a marker that you can use in a subsequent
DescribeClusterSnapshots request in order to retrieve the next
set of snapshot records. Default: 100
Constraints: Must be at least 20 and no more than 100.
String marker
String ownerAccount
String marker
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
marker
is included in the response that can be used in a
new DescribeClusters request to continue listing results.
Default: 100
Constraints: Value must be at least 20 and no more than 100.
String marker
You can specify either a Marker parameter or a ClusterIdentifier parameter in a DescribeClusters request, but not both.
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusters
String clusterSubnetGroupName
Integer maxRecords
MaxRecords
value, the response returns a marker that you
can use in a subsequent DescribeClusterSubnetGroups request in
order to retrieve the next set of cluster subnet group records.
Default: 100
Constraints: Must be at least 20 and no more than 100.
String marker
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterSubnetGroups
String clusterVersion
Example: 1.0
String clusterParameterGroupFamily
Constraints:
Integer maxRecords
MaxRecords
value is available, a marker is included
in the response so that the following results can be retrieved.
Default: 100
Constraints: Value must be at least 20 and no more than 100.
String marker
MaxRecords
.String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterVersions
Version
elements.String parameterGroupFamily
Integer maxRecords
MaxRecords
value, a
marker is included in the response so that the remaining results may
be retrieved. Default: 100
Constraints: Value must be at least 20 and no more than 100.
String marker
MaxRecords
.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
marker is included in the response so that the remaining results may
be retrieved. Default: 100
Constraints: Value must be at least 20 and no more than 100.
String marker
MaxRecords
.String clusterVersion
Default: All versions.
Constraints: Must be one of the version returned from DescribeClusterVersions.
String nodeType
Integer maxRecords
MaxRecords
value, a
marker is included in the response so that the remaining results may
be retrieved. Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords
.com.amazonaws.internal.ListWithAutoConstructFlag<T> orderableClusterOptions
String marker
String reservedNodeOfferingId
Integer maxRecords
MaxRecords
value, a
marker is included in the response so that the remaining results may
be retrieved. Default: 100
Constraints: minimum 20, maximum 100.
String marker
You can specify either a Marker parameter or a ClusterIdentifier parameter in a DescribeClusters request, but not both.
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedNodeOfferings
String reservedNodeId
Integer maxRecords
MaxRecords
value, a
marker is included in the response so that the remaining results may
be retrieved. Default: 100
Constraints: minimum 20, maximum 100.
String marker
String marker
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
String sourceIdentifier
String sourceType
Constraints:
Allowed Values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot
String message
Date date
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.
String parameterGroupName
String parameterGroupStatus
String clusterIdentifier
Example:
examplecluster
String clusterType
When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.
Valid Values: multi-node | single-node
String nodeType
When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use the DescribeResize to track the progress of the resize request.
Valid Values: dw.hs1.xlarge
|
dw.hs1.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 which fall outside of the new retention period will be immediately deleted.
Default: Uses existing setting.
Constraints: Must be a value from 0 to 35.
String preferredMaintenanceWindow
This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.
Default: Uses existing setting.
Format:
ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00
.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes.
String clusterVersion
For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide.
Example: 1.0
Boolean allowVersionUpgrade
true
, upgrades will be applied automatically to the
cluster during the maintenance window. Default: false
String clusterSubnetGroupName
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
String clusterVersion
String clusterType
multi-node
.String nodeType
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
String parameterName
String parameterValue
String description
String source
String dataType
String allowedValues
Boolean isModifiable
true
, the parameter can be modified. Some parameters
have security or operational implications that prevent them from being
changed.String minimumEngineVersion
String masterUserPassword
String nodeType
Integer numberOfNodes
String clusterType
String clusterVersion
Integer automatedSnapshotRetentionPeriod
String clusterIdentifier
String reservedNodeId
String reservedNodeOfferingId
String nodeType
Date startTime
Integer duration
Double fixedPrice
Double usagePrice
String currencyCode
Integer nodeCount
String state
Possible Values:
String offeringType
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String reservedNodeOfferingId
String nodeType
Integer duration
Double fixedPrice
Double usagePrice
String currencyCode
String offeringType
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String parameterGroupName
Boolean resetAllParameters
true
, all parameters in the specified parameter group
will be reset to their default values. Default: true
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
Constraints: A maximum of 20 parameters can be reset in a single request.
String parameterGroupName
String parameterGroupStatus
String clusterIdentifier
Constraints:
String snapshotIdentifier
Example:
my-snapshot-id
String snapshotClusterIdentifier
Integer port
Default: The same port as the original cluster.
Constraints: Must be between
1115
and 65535
.
String availabilityZone
Default: A random, system-chosen Availability Zone.
Example:
us-east-1a
Boolean allowVersionUpgrade
true
, upgrades can be applied during the maintenance
window to the Amazon Redshift engine that is running on the cluster.
Default: true
String clusterSubnetGroupName
A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.
Boolean publiclyAccessible
true
, the cluster can be accessed from a public
network.String ownerAccount
String 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 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.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 subnetIdentifier
AvailabilityZone subnetAvailabilityZone
String subnetStatus
String hostedZoneId
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide.
Constraints:
Length: 0 - 32
String dNSName
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide.
Constraints:
Length: 0 - 1024
Boolean evaluateTargetHealth
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide.
String action
Valid values: CREATE
|
DELETE
Constraints:
Allowed Values: CREATE, DELETE
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
For more information, an example, and several ways to get the hosted zone ID for the LoadBalancer, see Creating Alias Resource Record Sets for Elastic Load Balancing in the Amazon Route 53 Developer Guide.
Constraints:
Length: 0 - 32
ChangeBatch changeBatch
Changes
element.ChangeInfo changeInfo
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
String callerReference
CreateHealthCheck
requests to be retried without the risk
of executing the operation twice. You must use a unique
CallerReference
string every time you create a health
check. CallerReference
can be any unique string; you
might choose to use a string that identifies your project. Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
Constraints:
Length: 1 - 64
HealthCheckConfig healthCheckConfig
HealthCheck healthCheck
String location
Constraints:
Length: 0 - 1024
String name
This is the
name you have registered with your DNS registrar. You should ask your
registrar to change the authoritative name servers for your domain to
the set of NameServers
elements returned in
DelegationSet
.
Constraints:
Length: 0 - 1024
String callerReference
CreateHostedZone
requests to be retried without the risk
of executing the operation twice. You must use a unique
CallerReference
string every time you create a hosted
zone. CallerReference
can be any unique string; you might
choose to use a string that identifies your project, such as
DNSMigration_01
. Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
Constraints:
Length: 1 - 128
HostedZoneConfig hostedZoneConfig
HostedZone hostedZone
ChangeInfo changeInfo
DelegationSet delegationSet
String location
Constraints:
Length: 0 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> nameServers
NameServer
that is
assigned to your hosted zone.
Constraints:
Length: 1 -
String healthCheckId
Constraints:
Length: 0 - 64
ChangeInfo changeInfo
String id
ChangeResourceRecordSets
returned in the
Id element when you submitted the request.
Constraints:
Length: 0 - 32
ChangeInfo changeInfo
String healthCheckId
Constraints:
Length: 0 - 64
HealthCheck healthCheck
String id
Constraints:
Length: 0 - 32
HostedZone hostedZone
DelegationSet delegationSet
String id
Constraints:
Length: 0 - 64
String callerReference
Constraints:
Length: 1 - 64
HealthCheckConfig healthCheckConfig
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, TCP
String resourcePath
Constraints:
Length: 0 - 255
String fullyQualifiedDomainName
Constraints:
Length: 0 - 255
String id
Constraints:
Length: 0 - 32
String name
This is the
name you have registered with your DNS registrar. You should ask your
registrar to change the authoritative name servers for your domain to
the set of NameServers
elements returned in
DelegationSet
.
Constraints:
Length: 0 - 1024
String callerReference
Constraints:
Length: 1 - 128
HostedZoneConfig config
Comment
element.Long resourceRecordSetCount
String comment
HostedZoneConfig
and
Comment
elements from the XML document.
Constraints:
Length: 0 - 256
String marker
NextMarker
from the last
response in the marker
parameter to get the next page of
results.
Constraints:
Length: 0 - 64
String maxItems
com.amazonaws.internal.ListWithAutoConstructFlag<T> healthChecks
String marker
NextMarker
from the last
response in the marker
parameter to get the next page of
results.
Constraints:
Length: 0 - 64
Boolean isTruncated
Marker
element.
Valid Values: true
| false
String nextMarker
true
, make
another request to ListHealthChecks
and include the value
of the NextMarker
element in the Marker
element to get the next page of results.
Constraints:
Length: 0 - 64
String maxItems
MaxItems
, the value of
ListHealthChecksResponse$IsTruncated in the response is
true
. Call ListHealthChecks
again and
specify the value of ListHealthChecksResponse$NextMarker in the
ListHostedZonesRequest$Marker element to get the next page of
results.String marker
NextMarker
from the last
response in the marker
parameter to get the next page of
results.
Constraints:
Length: 0 - 64
String maxItems
com.amazonaws.internal.ListWithAutoConstructFlag<T> hostedZones
String marker
NextMarker
from the last
response in the marker
parameter to get the next page of
results.
Constraints:
Length: 0 - 64
Boolean isTruncated
Marker
element.
Valid Values: true
| false
String nextMarker
true
, make
another request to ListHostedZones
and include the value
of the NextMarker
element in the Marker
element to get the next page of results.
Constraints:
Length: 0 - 64
String maxItems
MaxItems
, the value of
ListHostedZonesResponse$IsTruncated in the response is
true
. Call ListHostedZones
again and specify
the value of ListHostedZonesResponse$NextMarker in the
ListHostedZonesRequest$Marker element to get the next page of
results.String hostedZoneId
Constraints:
Length: 0 - 32
String startRecordName
ListResourceRecordSets
request to list.
Constraints:
Length: 0 - 1024
String startRecordType
Valid values: A
| AAAA
|
CNAME
| MX
| NS
|
PTR
| SOA
| SPF
|
SRV
| TXT
Values for Weighted Resource
Record Sets: A
| AAAA
| CNAME
|
TXT
Values for Regional Resource Record Sets:
A
| AAAA
| CNAME
|
TXT
Values for Alias Resource Record Sets:
A
| AAAA
Constraint: Specifying
type
without specifying name
returns an
InvalidInput error.
Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA
String startRecordIdentifier
ListResourceRecordSetsResponse$NextRecordIdentifier
from
the previous response to get the next resource record set that has the
current DNS name and type.
Constraints:
Length: 1 - 128
String maxItems
com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceRecordSets
Boolean isTruncated
Valid
Values: true
| false
String nextRecordName
Constraints:
Length: 0 - 1024
String nextRecordType
Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA
String nextRecordIdentifier
SetIdentifier
for the next resource record set that has the current DNS name and
type.
Constraints:
Length: 1 - 128
String maxItems
MaxItems
is 100.String value
Value
element for the current resource
record set.
Constraints:
Length: 0 - 4000
String name
Constraints:
Length: 0 - 1024
String type
Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA
String setIdentifier
Constraints:
Length: 1 - 128
Long weight
Constraints:
Range: 0 - 255
String region
Constraints:
Length: 1 - 64
Allowed Values: us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1
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 extendedRequestId
String assumedRoleId
Constraints:
Length: 2 - 96
Pattern: [\w+=,.@:-]*
String arn
Constraints:
Length: 20 - 2048
String roleArn
Constraints:
Length: 20 - 2048
String roleSessionName
AssumedRoleUser
.
Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*
String policy
AssumeRole
call. The resulting
permissions of the temporary security credentials are an intersection
of this policy and the access policy that is associated with the role.
Use this policy to further restrict the permissions of the temporary
security credentials.
Constraints:
Length: 1 - 2048
Pattern: [
-ÿ]+
Integer durationSeconds
Constraints:
Range: 900 - 3600
String externalId
Constraints:
Length: 2 - 96
Pattern: [\w+=,.@:-]*
Credentials credentials
AssumedRoleUser assumedRoleUser
RoleSessionName
that
you specified when you called AssumeRole
.Integer packedPolicySize
Constraints:
Range: 0 -
String roleArn
Constraints:
Length: 20 - 2048
String roleSessionName
AssumedRoleUser
response element.
Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*
String webIdentityToken
AssumeRoleWithWebIdentity
call.
Constraints:
Length: 4 - 2048
String providerId
accounts.google.com
. Do not include URL schemes and port
numbers. Currently, www.amazon.com
and
graph.facebook.com
are supported.
Constraints:
Length: 4 - 2048
String policy
AssumeRoleWithWebIdentity
call. The
resulting permissions of the temporary security credentials are an
intersection of this policy and the access policy that is associated
with the role. Use this policy to further restrict the permissions of
the temporary security credentials.
Constraints:
Length: 1 - 2048
Pattern: [
-ÿ]+
Integer durationSeconds
Constraints:
Range: 900 - 129600
Credentials credentials
String subjectFromWebIdentityToken
WebIdentityToken
that was submitted with the AssumeRoleWithWebIdentity
call. The identifier is typically unique to the user and the
application that acquired the WebIdentityToken
(pairwise
identifier). If an OpenID Connect ID token was submitted in the
WebIdentityToken
, this value is returned by the identity
provider as the token's sub
(Subject) claim.
Constraints:
Length: 6 - 255
AssumedRoleUser assumedRoleUser
RoleSessionName
that
you specified when you called AssumeRole
.Integer packedPolicySize
Constraints:
Range: 0 -
String accessKeyId
Constraints:
Length: 16 - 32
Pattern: [\w]*
String secretAccessKey
String sessionToken
Date expiration
String encodedMessage
Constraints:
Length: 1 - 10240
String decodedMessage
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
Constraints:
Length: 1 - 2048
Pattern: [
-ÿ]+
Integer durationSeconds
Constraints:
Range: 900 - 129600
Credentials credentials
FederatedUser federatedUser
arn:aws:sts::123456789012:federated-user/Bob
or
123456789012:Bob
). You can use the federated user's ARN
in your resource policies like in an Amazon S3 bucket policy.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.Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainNames
String nextToken
MaxNumberOfDomains
still available.Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
String domainName
String itemName
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
UpdateCondition expected
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
Float boxUsage
String selectExpression
String nextToken
ItemNames
.Boolean consistentRead
true
, any data previously
written to SimpleDB will be returned. Otherwise, results will be
consistent eventually, and the client may not see data that was
written immediately before your read.com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String nextToken
MaxNumberOfItems
were matched, the response size exceeded
1 megabyte, or the execution time exceeded 5 seconds.Float boxUsage
String name
String value
Exists
parameter is equal to true
.Boolean exists
true
if the attribute must exist for
the update condition to be satisfied. Specify false
if
the attribute should not exist in order for the update condition to be
satisfied.Content text
Content html
String identity
String emailAddress
com.amazonaws.internal.ListWithAutoConstructFlag<T> toAddresses
com.amazonaws.internal.ListWithAutoConstructFlag<T> ccAddresses
com.amazonaws.internal.ListWithAutoConstructFlag<T> bccAddresses
Double max24HourSend
Double maxSendRate
Double sentLast24Hours
Boolean dkimEnabled
String dkimVerificationStatus
Constraints:
Allowed Values: Pending, Success, Failed, TemporaryFailure
com.amazonaws.internal.ListWithAutoConstructFlag<T> dkimTokens
CNAME
DNS records that point to DKIM public keys hosted
by Amazon SES. (This only applies to domain entities, not email
address identities.)String bounceTopic
String complaintTopic
Boolean forwardingEnabled
true
indicates that Amazon SES will forward feedback as
email, while false
indicates that feedback will be
published only to the specified Bounce and Complaint topics.String verificationStatus
Constraints:
Allowed Values: Pending, Success, Failed, TemporaryFailure
String verificationToken
String identityType
Constraints:
Allowed Values: EmailAddress, Domain
String nextToken
Integer maxItems
com.amazonaws.internal.ListWithAutoConstructFlag<T> identities
String nextToken
ByteBuffer data
For more information, go to theAmazon SES Developer Guide.
Date timestamp
Long deliveryAttempts
Long bounces
Long complaints
Long rejects
String source
Destination destination
Message message
com.amazonaws.internal.ListWithAutoConstructFlag<T> replyToAddresses
String returnPath
ReturnPath
parameter.String messageId
SendEmail
action.String source
Source
parameter, then bounce notifications and
complaints will be sent to this email address. This takes precedence
over any Return-Path header that you might include in the raw
text of the message. com.amazonaws.internal.ListWithAutoConstructFlag<T> destinations
RawMessage rawMessage
String messageId
SendRawEmail
action.String identity
[email protected]
, example.com
.Boolean forwardingEnabled
true
specifies that Amazon SES will forward feedback
notifications as email, in addition to any Amazon SNS topic publishing
otherwise specified. false
specifies that Amazon SES will
publish feedback notifications only through Amazon SNS. This value can
only be set to false
when topics are specified for both
Bounce
and Complaint
topic types.String identity
[email protected]
, example.com
.String notificationType
Constraints:
Allowed Values: Bounce, Complaint
String snsTopic
String domain
com.amazonaws.internal.ListWithAutoConstructFlag<T> dkimTokens
String domain
String verificationToken
String emailAddress
String emailAddress
String details
ActivityType activityType
String activityId
String details
ActivityTaskTimeoutType timeoutType
String details
WorkflowExecution workflowExecution
WorkflowType workflowType
String details
String key
ScheduleActivityTaskFailedCause failureCause
SignalExternalWorkflowExecutionFailedCause failureCause
WorkflowExecution signaledExecution
StartChildWorkflowExecutionFailedCause failureCause
StartTimerFailedCause failureCause
String details
String taskToken
Constraints:
Length: 1 - 1024
String activityId
Constraints:
Length: 1 - 256
Long startedEventId
ActivityTaskStarted
event recorded in the
history.WorkflowExecution workflowExecution
ActivityType activityType
String input
Constraints:
Length: 0 - 32768
String details
Constraints:
Length: 0 - 32768
Long scheduledEventId
ActivityTaskScheduled
event that was
recorded when this activity task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.Long startedEventId
ActivityTaskStarted
event recorded when
this activity task was started. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.Long latestCancelRequestedEventId
ActivityTaskCancelRequested
event recorded for this
activity task. This information can be useful for diagnosing problems
by tracing back the chain of events leading up to this event.Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the
RequestCancelActivityTask
decision for this cancellation
request. This information can be useful for diagnosing problems by
tracing back the cause of events.String activityId
Constraints:
Length: 1 - 256
String result
Constraints:
Length: 0 - 32768
Long scheduledEventId
ActivityTaskScheduled
event that was
recorded when this activity task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.Long startedEventId
ActivityTaskStarted
event recorded when
this activity task was started. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.String reason
Constraints:
Length: 0 - 256
String details
Constraints:
Length: 0 - 32768
Long scheduledEventId
ActivityTaskScheduled
event that was
recorded when this activity task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.Long startedEventId
ActivityTaskStarted
event recorded when
this activity task was started. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.ActivityType activityType
String activityId
Constraints:
Length: 1 - 256
String input
Constraints:
Length: 0 - 32768
String control
Constraints:
Length: 0 - 32768
String scheduleToStartTimeout
Constraints:
Length: 0 - 8
String scheduleToCloseTimeout
Constraints:
Length: 0 - 8
String startToCloseTimeout
Constraints:
Length: 0 - 8
TaskList taskList
Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision that resulted in the scheduling of this activity task.
This information can be useful for diagnosing problems by tracing back
the chain of events leading up to this event.String heartbeatTimeout
Constraints:
Length: 0 - 8
String identity
Constraints:
Length: 0 - 256
Long scheduledEventId
ActivityTaskScheduled
event that was
recorded when this activity task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.Boolean cancelRequested
true
if cancellation of the task is requested.String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE, SCHEDULE_TO_START, SCHEDULE_TO_CLOSE, HEARTBEAT
Long scheduledEventId
ActivityTaskScheduled
event that was
recorded when this activity task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.Long startedEventId
ActivityTaskStarted
event recorded when
this activity task was started. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.String details
details
parameter for the
last call made by the activity to
RecordActivityTaskHeartbeat
.
Constraints:
Length: 0 - 2048
String name
Constraints:
Length: 1 - 256
String version
Constraints:
Length: 1 - 64
String defaultTaskStartToCloseTimeout
ScheduleActivityTask
Decision. The valid values
are integers greater than or equal to 0
. An integer value
can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String defaultTaskHeartbeatTimeout
ScheduleActivityTask
Decision. If the activity
worker subsequently attempts to record a heartbeat or returns a
result, the activity worker receives an UnknownResource
fault. In this case, Amazon SWF no longer considers the activity task
to be valid; the activity worker should clean up the activity task.
The valid values are integers greater than or equal to
0
. An integer value can be used to specify the duration
in seconds while NONE
can be used to specify unlimited
duration.
Constraints:
Length: 0 - 8
TaskList defaultTaskList
ScheduleActivityTask
Decision. You can override
this default when scheduling a task through the
ScheduleActivityTask
Decision.String defaultTaskScheduleToStartTimeout
ScheduleActivityTask
Decision.
The valid values are integers greater than or equal to
0
. An integer value can be used to specify the duration
in seconds while NONE
can be used to specify unlimited
duration.
Constraints:
Length: 0 - 8
String defaultTaskScheduleToCloseTimeout
ScheduleActivityTask
Decision. The valid values
are integers greater than or equal to 0
. An integer value
can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
ActivityTypeInfo typeInfo
The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.
ActivityTypeConfiguration configuration
ActivityType activityType
String status
Constraints:
Allowed Values: REGISTERED, DEPRECATED
String description
Constraints:
Length: 0 - 1024
Date creationDate
Date deprecationDate
com.amazonaws.internal.ListWithAutoConstructFlag<T> typeInfos
String nextPageToken
Constraints:
Length: 0 - 2048
String timerId
Constraints:
Length: 1 - 256
String timerId
CancelTimer
decision that
failed.
Constraints:
Length: 1 - 256
String cause
Constraints:
Allowed Values: TIMER_ID_UNKNOWN, OPERATION_NOT_PERMITTED
Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the CancelTimer
decision to cancel this timer. This information can be useful for
diagnosing problems by tracing back the cause of events.String details
Constraints:
Length: 0 - 32768
String cause
Constraints:
Allowed Values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED
Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the
CancelWorkflowExecution
decision for this cancellation
request. This information can be useful for diagnosing problems by
tracing back the cause of events.WorkflowExecution workflowExecution
WorkflowType workflowType
String details
Constraints:
Length: 0 - 32768
Long initiatedEventId
StartChildWorkflowExecutionInitiated
event
corresponding to the StartChildWorkflowExecution
Decision to start this child workflow execution. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.Long startedEventId
ChildWorkflowExecutionStarted
event
recorded when this child workflow execution was started. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.WorkflowExecution workflowExecution
WorkflowType workflowType
String result
Constraints:
Length: 0 - 32768
Long initiatedEventId
StartChildWorkflowExecutionInitiated
event
corresponding to the StartChildWorkflowExecution
Decision to start this child workflow execution. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.Long startedEventId
ChildWorkflowExecutionStarted
event
recorded when this child workflow execution was started. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.WorkflowExecution workflowExecution
WorkflowType workflowType
String reason
Constraints:
Length: 0 - 256
String details
Constraints:
Length: 0 - 32768
Long initiatedEventId
StartChildWorkflowExecutionInitiated
event
corresponding to the StartChildWorkflowExecution
Decision to start this child workflow execution. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.Long startedEventId
ChildWorkflowExecutionStarted
event
recorded when this child workflow execution was started. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.WorkflowExecution workflowExecution
WorkflowType workflowType
Long initiatedEventId
StartChildWorkflowExecutionInitiated
event
corresponding to the StartChildWorkflowExecution
Decision to start this child workflow execution. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.WorkflowExecution workflowExecution
WorkflowType workflowType
Long initiatedEventId
StartChildWorkflowExecutionInitiated
event
corresponding to the StartChildWorkflowExecution
Decision to start this child workflow execution. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.Long startedEventId
ChildWorkflowExecutionStarted
event
recorded when this child workflow execution was started. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.WorkflowExecution workflowExecution
WorkflowType workflowType
String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE
Long initiatedEventId
StartChildWorkflowExecutionInitiated
event
corresponding to the StartChildWorkflowExecution
Decision to start this child workflow execution. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.Long startedEventId
ChildWorkflowExecutionStarted
event
recorded when this child workflow execution was started. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.String status
Constraints:
Allowed Values: COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT
String result
Constraints:
Length: 0 - 32768
String cause
Constraints:
Allowed Values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED
Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the
CompleteWorkflowExecution
decision to complete this
execution. This information can be useful for diagnosing problems by
tracing back the cause of events.String input
Constraints:
Length: 0 - 32768
String executionStartToCloseTimeout
defaultExecutionStartToCloseTimeout
specified when registering the workflow type. The valid values are
integers greater than or equal to 0
. An integer value can
be used to specify the duration in seconds while NONE
can
be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList taskList
String taskStartToCloseTimeout
defaultTaskStartToCloseTimout
specified when registering
the workflow type using RegisterWorkflowType. The valid
values are integers greater than or equal to 0
. An
integer value can be used to specify the duration in seconds while
NONE
can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String childPolicy
WorkflowExecutionCancelRequested
event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
String workflowTypeVersion
String cause
Constraints:
Allowed Values: UNHANDLED_DECISION, WORKFLOW_TYPE_DEPRECATED, WORKFLOW_TYPE_DOES_NOT_EXIST, DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_TASK_LIST_UNDEFINED, DEFAULT_CHILD_POLICY_UNDEFINED, OPERATION_NOT_PERMITTED
Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the
ContinueAsNewWorkflowExecution
decision that started this
execution. This information can be useful for diagnosing problems by
tracing back the cause of events.String domain
Constraints:
Length: 1 - 256
ExecutionTimeFilter startTimeFilter
startTimeFilter
and closeTimeFilter
are mutually exclusive. You must
specify one of these in a request but not both.ExecutionTimeFilter closeTimeFilter
startTimeFilter
and closeTimeFilter
are mutually exclusive. You must
specify one of these in a request but not both.WorkflowExecutionFilter executionFilter
WorkflowId
in the filter are counted.
closeStatusFilter
, executionFilter
,
typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.WorkflowTypeFilter typeFilter
closeStatusFilter
,
executionFilter
, typeFilter
and
tagFilter
are mutually exclusive. You can specify at most
one of these in a request.TagFilter tagFilter
closeStatusFilter
,
executionFilter
, typeFilter
and
tagFilter
are mutually exclusive. You can specify at most
one of these in a request.CloseStatusFilter closeStatusFilter
executionStatus
is specified as CLOSED
.
closeStatusFilter
, executionFilter
,
typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.String domain
Constraints:
Length: 1 - 256
ExecutionTimeFilter startTimeFilter
WorkflowTypeFilter typeFilter
executionFilter
, typeFilter
and
tagFilter
are mutually exclusive. You can specify at most
one of these in a request.TagFilter tagFilter
executionFilter
,
typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.WorkflowExecutionFilter executionFilter
WorkflowId
in the filter are counted.
executionFilter
, typeFilter
and
tagFilter
are mutually exclusive. You can specify at most
one of these in a request.String decisionType
Constraints:
Allowed Values: ScheduleActivityTask, RequestCancelActivityTask, CompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution, ContinueAsNewWorkflowExecution, RecordMarker, StartTimer, CancelTimer, SignalExternalWorkflowExecution, RequestCancelExternalWorkflowExecution, StartChildWorkflowExecution
ScheduleActivityTaskDecisionAttributes scheduleActivityTaskDecisionAttributes
ScheduleActivityTask
decision. It
is not set for other decision types.RequestCancelActivityTaskDecisionAttributes requestCancelActivityTaskDecisionAttributes
RequestCancelActivityTask
decision. It is not set for other decision types.CompleteWorkflowExecutionDecisionAttributes completeWorkflowExecutionDecisionAttributes
CompleteWorkflowExecution
decision. It is not set for other decision types.FailWorkflowExecutionDecisionAttributes failWorkflowExecutionDecisionAttributes
FailWorkflowExecution
decision.
It is not set for other decision types.CancelWorkflowExecutionDecisionAttributes cancelWorkflowExecutionDecisionAttributes
CancelWorkflowExecution
decision.
It is not set for other decision types.ContinueAsNewWorkflowExecutionDecisionAttributes continueAsNewWorkflowExecutionDecisionAttributes
ContinueAsNewWorkflowExecution
decision. It is not set for other decision types.RecordMarkerDecisionAttributes recordMarkerDecisionAttributes
RecordMarker
decision. It is not
set for other decision types.StartTimerDecisionAttributes startTimerDecisionAttributes
StartTimer
decision. It is not
set for other decision types.CancelTimerDecisionAttributes cancelTimerDecisionAttributes
CancelTimer
decision. It is not
set for other decision types.SignalExternalWorkflowExecutionDecisionAttributes signalExternalWorkflowExecutionDecisionAttributes
SignalExternalWorkflowExecution
decision. It is not set for other decision types.RequestCancelExternalWorkflowExecutionDecisionAttributes requestCancelExternalWorkflowExecutionDecisionAttributes
RequestCancelExternalWorkflowExecution
decision. It is
not set for other decision types.StartChildWorkflowExecutionDecisionAttributes startChildWorkflowExecutionDecisionAttributes
StartChildWorkflowExecution
decision. It is not set for other decision types.String taskToken
Constraints:
Length: 1 - 1024
Long startedEventId
DecisionTaskStarted
event recorded in the
history.WorkflowExecution workflowExecution
WorkflowType workflowType
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String nextPageToken
Constraints:
Length: 0 - 2048
Long previousStartedEventId
String executionContext
Constraints:
Length: 0 - 32768
Long scheduledEventId
DecisionTaskScheduled
event that was
recorded when this decision task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.Long startedEventId
DecisionTaskStarted
event recorded when
this decision task was started. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.TaskList taskList
String startToCloseTimeout
The valid
values are integers greater than or equal to 0
. An
integer value can be used to specify the duration in seconds while
NONE
can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String identity
Constraints:
Length: 0 - 256
Long scheduledEventId
DecisionTaskScheduled
event that was
recorded when this decision task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE
Long scheduledEventId
DecisionTaskScheduled
event that was
recorded when this decision task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.Long startedEventId
DecisionTaskStarted
event recorded when
this decision task was started. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.String domain
Constraints:
Length: 1 - 256
ActivityType activityType
String name
Constraints:
Length: 1 - 256
String domain
Constraints:
Length: 1 - 256
WorkflowType workflowType
String domain
Constraints:
Length: 1 - 256
ActivityType activityType
String name
Constraints:
Length: 1 - 256
String domain
Constraints:
Length: 1 - 256
WorkflowExecution execution
String domain
Constraints:
Length: 1 - 256
WorkflowType workflowType
String workflowExecutionRetentionPeriodInDays
Constraints:
Length: 1 - 8
DomainInfo domainInfo
DomainConfiguration configuration
String name
Constraints:
Length: 1 - 256
String status
Constraints:
Allowed Values: REGISTERED, DEPRECATED
String description
Constraints:
Length: 0 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainInfos
String nextPageToken
Constraints:
Length: 0 - 2048
WorkflowExecution workflowExecution
Long initiatedEventId
RequestCancelExternalWorkflowExecutionInitiated
event
corresponding to the
RequestCancelExternalWorkflowExecution
decision to cancel
this external workflow execution. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.WorkflowExecution workflowExecution
Long initiatedEventId
SignalExternalWorkflowExecutionInitiated
event corresponding to the
SignalExternalWorkflowExecution
decision to request this
signal. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.String cause
Constraints:
Allowed Values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED
Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the
FailWorkflowExecution
decision to fail this execution.
This information can be useful for diagnosing problems by tracing back
the cause of events.String domain
Constraints:
Length: 1 - 256
WorkflowExecution execution
String nextPageToken
NextPageToken
is returned, the result has more than
one pages. To get the next page, repeat the call and specify the
nextPageToken with all other arguments unchanged.
Constraints:
Length: 0 - 2048
Integer maximumPageSize
NextPageToken
returned. By default 100 history events are
returned in a page but the caller can override this value to a page
size smaller than the default. You cannot specify a page size
larger than 100. Note that the number of events may be less than the
maxiumum page size, in which case, the returned page will have fewer
results than the maximumPageSize specified.
Constraints:
Range: 0 - 1000
Boolean reverseOrder
true
, returns the events in reverse order. By
default the results are returned in ascending order of the
eventTimeStamp
of the events.com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String nextPageToken
Constraints:
Length: 0 - 2048
Date eventTimestamp
String eventType
Constraints:
Allowed Values: WorkflowExecutionStarted, WorkflowExecutionCancelRequested, WorkflowExecutionCompleted, CompleteWorkflowExecutionFailed, WorkflowExecutionFailed, FailWorkflowExecutionFailed, WorkflowExecutionTimedOut, WorkflowExecutionCanceled, CancelWorkflowExecutionFailed, WorkflowExecutionContinuedAsNew, ContinueAsNewWorkflowExecutionFailed, WorkflowExecutionTerminated, DecisionTaskScheduled, DecisionTaskStarted, DecisionTaskCompleted, DecisionTaskTimedOut, ActivityTaskScheduled, ScheduleActivityTaskFailed, ActivityTaskStarted, ActivityTaskCompleted, ActivityTaskFailed, ActivityTaskTimedOut, ActivityTaskCanceled, ActivityTaskCancelRequested, RequestCancelActivityTaskFailed, WorkflowExecutionSignaled, MarkerRecorded, RecordMarkerFailed, TimerStarted, StartTimerFailed, TimerFired, TimerCanceled, CancelTimerFailed, StartChildWorkflowExecutionInitiated, StartChildWorkflowExecutionFailed, ChildWorkflowExecutionStarted, ChildWorkflowExecutionCompleted, ChildWorkflowExecutionFailed, ChildWorkflowExecutionTimedOut, ChildWorkflowExecutionCanceled, ChildWorkflowExecutionTerminated, SignalExternalWorkflowExecutionInitiated, SignalExternalWorkflowExecutionFailed, ExternalWorkflowExecutionSignaled, RequestCancelExternalWorkflowExecutionInitiated, RequestCancelExternalWorkflowExecutionFailed, ExternalWorkflowExecutionCancelRequested
Long eventId
WorkflowExecutionStartedEventAttributes workflowExecutionStartedEventAttributes
WorkflowExecutionStarted
then
this member is set and provides detailed information about the event.
It is not set for other event types.WorkflowExecutionCompletedEventAttributes workflowExecutionCompletedEventAttributes
WorkflowExecutionCompleted
then
this member is set and provides detailed information about the event.
It is not set for other event types.CompleteWorkflowExecutionFailedEventAttributes completeWorkflowExecutionFailedEventAttributes
CompleteWorkflowExecutionFailed
then this member is set and provides detailed information about the
event. It is not set for other event types.WorkflowExecutionFailedEventAttributes workflowExecutionFailedEventAttributes
WorkflowExecutionFailed
then this
member is set and provides detailed information about the event. It is
not set for other event types.FailWorkflowExecutionFailedEventAttributes failWorkflowExecutionFailedEventAttributes
FailWorkflowExecutionFailed
then
this member is set and provides detailed information about the event.
It is not set for other event types.WorkflowExecutionTimedOutEventAttributes workflowExecutionTimedOutEventAttributes
WorkflowExecutionTimedOut
then
this member is set and provides detailed information about the event.
It is not set for other event types.WorkflowExecutionCanceledEventAttributes workflowExecutionCanceledEventAttributes
WorkflowExecutionCanceled
then
this member is set and provides detailed information about the event.
It is not set for other event types.CancelWorkflowExecutionFailedEventAttributes cancelWorkflowExecutionFailedEventAttributes
CancelWorkflowExecutionFailed
then this member is set and provides detailed information about the
event. It is not set for other event types.WorkflowExecutionContinuedAsNewEventAttributes workflowExecutionContinuedAsNewEventAttributes
WorkflowExecutionContinuedAsNew
then this member is set and provides detailed information about the
event. It is not set for other event types.ContinueAsNewWorkflowExecutionFailedEventAttributes continueAsNewWorkflowExecutionFailedEventAttributes
ContinueAsNewWorkflowExecutionFailed
then this member is
set and provides detailed information about the event. It is not set
for other event types.WorkflowExecutionTerminatedEventAttributes workflowExecutionTerminatedEventAttributes
WorkflowExecutionTerminated
then
this member is set and provides detailed information about the event.
It is not set for other event types.WorkflowExecutionCancelRequestedEventAttributes workflowExecutionCancelRequestedEventAttributes
WorkflowExecutionCancelRequested
then this member is set and provides detailed information about the
event. It is not set for other event types.DecisionTaskScheduledEventAttributes decisionTaskScheduledEventAttributes
DecisionTaskScheduled
then this
member is set and provides detailed information about the event. It is
not set for other event types.DecisionTaskStartedEventAttributes decisionTaskStartedEventAttributes
DecisionTaskStarted
then this
member is set and provides detailed information about the event. It is
not set for other event types.DecisionTaskCompletedEventAttributes decisionTaskCompletedEventAttributes
DecisionTaskCompleted
then this
member is set and provides detailed information about the event. It is
not set for other event types.DecisionTaskTimedOutEventAttributes decisionTaskTimedOutEventAttributes
DecisionTaskTimedOut
then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskScheduledEventAttributes activityTaskScheduledEventAttributes
ActivityTaskScheduled
then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskStartedEventAttributes activityTaskStartedEventAttributes
ActivityTaskStarted
then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskCompletedEventAttributes activityTaskCompletedEventAttributes
ActivityTaskCompleted
then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskFailedEventAttributes activityTaskFailedEventAttributes
ActivityTaskFailed
then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskTimedOutEventAttributes activityTaskTimedOutEventAttributes
ActivityTaskTimedOut
then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskCanceledEventAttributes activityTaskCanceledEventAttributes
ActivityTaskCanceled
then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskCancelRequestedEventAttributes activityTaskCancelRequestedEventAttributes
ActivityTaskcancelRequested
then
this member is set and provides detailed information about the event.
It is not set for other event types.WorkflowExecutionSignaledEventAttributes workflowExecutionSignaledEventAttributes
WorkflowExecutionSignaled
then
this member is set and provides detailed information about the event.
It is not set for other event types.MarkerRecordedEventAttributes markerRecordedEventAttributes
MarkerRecorded
then this member
is set and provides detailed information about the event. It is not
set for other event types.RecordMarkerFailedEventAttributes recordMarkerFailedEventAttributes
DecisionTaskFailed
then this
member is set and provides detailed information about the event. It is
not set for other event types.TimerStartedEventAttributes timerStartedEventAttributes
TimerStarted
then this member is
set and provides detailed information about the event. It is not set
for other event types.TimerFiredEventAttributes timerFiredEventAttributes
TimerFired
then this member is
set and provides detailed information about the event. It is not set
for other event types.TimerCanceledEventAttributes timerCanceledEventAttributes
TimerCanceled
then this member is
set and provides detailed information about the event. It is not set
for other event types.StartChildWorkflowExecutionInitiatedEventAttributes startChildWorkflowExecutionInitiatedEventAttributes
StartChildWorkflowExecutionInitiated
then this member is
set and provides detailed information about the event. It is not set
for other event types.ChildWorkflowExecutionStartedEventAttributes childWorkflowExecutionStartedEventAttributes
ChildWorkflowExecutionStarted
then this member is set and provides detailed information about the
event. It is not set for other event types.ChildWorkflowExecutionCompletedEventAttributes childWorkflowExecutionCompletedEventAttributes
ChildWorkflowExecutionCompleted
then this member is set and provides detailed information about the
event. It is not set for other event types.ChildWorkflowExecutionFailedEventAttributes childWorkflowExecutionFailedEventAttributes
ChildWorkflowExecutionFailed
then
this member is set and provides detailed information about the event.
It is not set for other event types.ChildWorkflowExecutionTimedOutEventAttributes childWorkflowExecutionTimedOutEventAttributes
ChildWorkflowExecutionTimedOut
then this member is set and provides detailed information about the
event. It is not set for other event types.ChildWorkflowExecutionCanceledEventAttributes childWorkflowExecutionCanceledEventAttributes
ChildWorkflowExecutionCanceled
then this member is set and provides detailed information about the
event. It is not set for other event types.ChildWorkflowExecutionTerminatedEventAttributes childWorkflowExecutionTerminatedEventAttributes
ChildWorkflowExecutionTerminated
then this member is set and provides detailed information about the
event. It is not set for other event types.SignalExternalWorkflowExecutionInitiatedEventAttributes signalExternalWorkflowExecutionInitiatedEventAttributes
SignalExternalWorkflowExecutionInitiated
then this member
is set and provides detailed information about the event. It is not
set for other event types.ExternalWorkflowExecutionSignaledEventAttributes externalWorkflowExecutionSignaledEventAttributes
ExternalWorkflowExecutionSignaled
then this member is set and provides detailed information about the
event. It is not set for other event types.SignalExternalWorkflowExecutionFailedEventAttributes signalExternalWorkflowExecutionFailedEventAttributes
SignalExternalWorkflowExecutionFailed
then this member is
set and provides detailed information about the event. It is not set
for other event types.ExternalWorkflowExecutionCancelRequestedEventAttributes externalWorkflowExecutionCancelRequestedEventAttributes
ExternalWorkflowExecutionCancelRequested
then this member
is set and provides detailed information about the event. It is not
set for other event types.RequestCancelExternalWorkflowExecutionInitiatedEventAttributes requestCancelExternalWorkflowExecutionInitiatedEventAttributes
RequestCancelExternalWorkflowExecutionInitiated
then this
member is set and provides detailed information about the event. It is
not set for other event types.RequestCancelExternalWorkflowExecutionFailedEventAttributes requestCancelExternalWorkflowExecutionFailedEventAttributes
RequestCancelExternalWorkflowExecutionFailed
then this
member is set and provides detailed information about the event. It is
not set for other event types.ScheduleActivityTaskFailedEventAttributes scheduleActivityTaskFailedEventAttributes
ScheduleActivityTaskFailed
then
this member is set and provides detailed information about the event.
It is not set for other event types.RequestCancelActivityTaskFailedEventAttributes requestCancelActivityTaskFailedEventAttributes
RequestCancelActivityTaskFailed
then this member is set and provides detailed information about the
event. It is not set for other event types.StartTimerFailedEventAttributes startTimerFailedEventAttributes
StartTimerFailed
then this member
is set and provides detailed information about the event. It is not
set for other event types.CancelTimerFailedEventAttributes cancelTimerFailedEventAttributes
CancelTimerFailed
then this
member is set and provides detailed information about the event. It is
not set for other event types.StartChildWorkflowExecutionFailedEventAttributes startChildWorkflowExecutionFailedEventAttributes
StartChildWorkflowExecutionFailed
then this member is set and provides detailed information about the
event. It is not set for other event types.String domain
Constraints:
Length: 1 - 256
String name
Constraints:
Length: 1 - 256
String registrationStatus
Constraints:
Allowed Values: REGISTERED, DEPRECATED
String nextPageToken
NextResultToken
was returned, the results have more than one page. To get the next
page of results, repeat the call with the nextPageToken
and keep all other arguments unchanged.
Constraints:
Length: 0 - 2048
Integer maximumPageSize
Constraints:
Range: 0 - 1000
Boolean reverseOrder
true
, returns the results in reverse order.
By default the results are returned in ascending alphabetical order of
the name
of the activity types.String domain
Constraints:
Length: 1 - 256
ExecutionTimeFilter startTimeFilter
startTimeFilter
and closeTimeFilter
are mutually exclusive. You must specify one of these in a request but
not both.ExecutionTimeFilter closeTimeFilter
startTimeFilter
and closeTimeFilter
are mutually exclusive. You must specify one of these in a request but
not both.WorkflowExecutionFilter executionFilter
closeStatusFilter
, executionFilter
,
typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.CloseStatusFilter closeStatusFilter
closeStatusFilter
, executionFilter
,
typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.WorkflowTypeFilter typeFilter
closeStatusFilter
,
executionFilter
, typeFilter
and
tagFilter
are mutually exclusive. You can specify at most
one of these in a request.TagFilter tagFilter
closeStatusFilter
, executionFilter
,
typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.String nextPageToken
NextPageToken
was
returned, the results are being paginated. To get the next page of
results, repeat the call with the returned token and all other
arguments unchanged.
Constraints:
Length: 0 - 2048
Integer maximumPageSize
Constraints:
Range: 0 - 1000
Boolean reverseOrder
true
, returns the results in reverse order.
By default the results are returned in descending order of the start
or the close time of the executions.String nextPageToken
NextPageToken
was
returned, the result has more than one page. To get the next page of
results, repeat the call with the returned token and all other
arguments unchanged.
Constraints:
Length: 0 - 2048
String registrationStatus
Constraints:
Allowed Values: REGISTERED, DEPRECATED
Integer maximumPageSize
Constraints:
Range: 0 - 1000
Boolean reverseOrder
true
, returns the results in reverse order.
By default the results are returned in ascending alphabetical order of
the name
of the domains.String domain
Constraints:
Length: 1 - 256
ExecutionTimeFilter startTimeFilter
WorkflowTypeFilter typeFilter
executionFilter
, typeFilter
and tagFilter
are mutually exclusive. You can specify at
most one of these in a request.TagFilter tagFilter
executionFilter
, typeFilter
and
tagFilter
are mutually exclusive. You can specify at most
one of these in a request.String nextPageToken
NextPageToken
was
returned, the results are being paginated. To get the next page of
results, repeat the call with the returned token and all other
arguments unchanged.
Constraints:
Length: 0 - 2048
Integer maximumPageSize
Constraints:
Range: 0 - 1000
Boolean reverseOrder
true
, returns the results in reverse order.
By default the results are returned in descending order of the start
time of the executions.WorkflowExecutionFilter executionFilter
executionFilter
, typeFilter
and
tagFilter
are mutually exclusive. You can specify at most
one of these in a request.String domain
Constraints:
Length: 1 - 256
String name
Constraints:
Length: 1 - 256
String registrationStatus
Constraints:
Allowed Values: REGISTERED, DEPRECATED
String nextPageToken
NextPageToken
was
returned, the results are being paginated. To get the next page of
results, repeat the call with the returned token and all other
arguments unchanged.
Constraints:
Length: 0 - 2048
Integer maximumPageSize
Constraints:
Range: 0 - 1000
Boolean reverseOrder
true
, returns the results in reverse order.
By default the results are returned in ascending alphabetical order of
the name
of the workflow types.String markerName
Constraints:
Length: 1 - 256
String details
Constraints:
Length: 0 - 32768
Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the RecordMarker
decision that requested this marker. This information can be useful
for diagnosing problems by tracing back the cause of events.String domain
Constraints:
Length: 1 - 256
TaskList taskList
The specified
string must not start or end with whitespace. It must not contain a
:
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
). Also, it must not contain the literal string "arn".
String identity
ActivityTaskStarted
event in the workflow history. This
enables diagnostic tracing when problems arise. The form of this
identity is user defined.
Constraints:
Length: 0 - 256
String domain
Constraints:
Length: 1 - 256
TaskList taskList
The specified
string must not start or end with whitespace. It must not contain a
:
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
). Also, it must not contain the literal string "arn".
String identity
Constraints:
Length: 0 - 256
String nextPageToken
NextPageToken
was
returned, the results are being paginated. To get the next page of
results, repeat the call with the returned token and all other
arguments unchanged. nextPageToken
returned by
this action cannot be used with GetWorkflowExecutionHistory to
get the next page. You must call PollForDecisionTask again
(with the nextPageToken
) to retrieve the next page of
history records. Calling PollForDecisionTask with a
nextPageToken
will not return a new decision
task.
Constraints:
Length: 0 - 2048
Integer maximumPageSize
Constraints:
Range: 0 - 1000
Boolean reverseOrder
true
, returns the events in reverse order. By
default the results are returned in ascending order of the
eventTimestamp
of the events.String taskToken
taskToken
of the ActivityTask. taskToken
is generated by the service and should be
treated as an opaque value. If the task is passed to another process,
its taskToken
must also be passed. This enables it to
provide its progress and respond with results.
Constraints:
Length: 1 - 1024
String details
Constraints:
Length: 0 - 2048
String markerName
Constraints:
Length: 1 - 256
String cause
Constraints:
Allowed Values: OPERATION_NOT_PERMITTED
Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the
RecordMarkerFailed
decision for this cancellation
request. This information can be useful for diagnosing problems by
tracing back the cause of events.String domain
Constraints:
Length: 1 - 256
String name
The specified
string must not start or end with whitespace. It must not contain a
:
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
). Also, it must not contain the literal string "arn".
Constraints:
Length: 1 - 256
String version
The specified string must not start or end with
whitespace. It must not contain a :
(colon),
/
(slash), |
(vertical bar), or any control
characters ( - | - ). Also, it must not
contain the literal string "arn".
Constraints:
Length: 1 - 64
String description
Constraints:
Length: 0 - 1024
String defaultTaskStartToCloseTimeout
ScheduleActivityTask
Decision. The valid values
are integers greater than or equal to 0
. An integer value
can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String defaultTaskHeartbeatTimeout
ScheduleActivityTask
Decision. If the activity
worker subsequently attempts to record a heartbeat or returns a
result, the activity worker receives an UnknownResource
fault. In this case, Amazon SWF no longer considers the activity task
to be valid; the activity worker should clean up the activity task.
The valid values are integers greater than or equal to
0
. An integer value can be used to specify the duration
in seconds while NONE
can be used to specify unlimited
duration.
Constraints:
Length: 0 - 8
TaskList defaultTaskList
ScheduleActivityTask
Decision.String defaultTaskScheduleToStartTimeout
ScheduleActivityTask
Decision. The valid values
are integers greater than or equal to 0
. An integer value
can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String defaultTaskScheduleToCloseTimeout
ScheduleActivityTask
Decision. The valid values are integers greater than or
equal to 0
. An integer value can be used to specify the
duration in seconds while NONE
can be used to specify
unlimited duration.
Constraints:
Length: 0 - 8
String name
The
specified string must not start or end with whitespace. It must not
contain a :
(colon), /
(slash),
|
(vertical bar), or any control characters
( - | - ). Also, it must not contain the
literal string "arn".
Constraints:
Length: 1 - 256
String description
Constraints:
Length: 0 - 1024
String workflowExecutionRetentionPeriodInDays
NONE
is specified, the records for workflow
executions in this domain are not retained at all.
Constraints:
Length: 1 - 8
String domain
Constraints:
Length: 1 - 256
String name
The specified string must not start
or end with whitespace. It must not contain a :
(colon),
/
(slash), |
(vertical bar), or any control
characters ( - | - ). Also, it must not
contain the literal string "arn".
Constraints:
Length: 1 - 256
String version
The specified
string must not start or end with whitespace. It must not contain a
:
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
). Also, it must not contain the literal string "arn".
Constraints:
Length: 1 - 64
String description
Constraints:
Length: 0 - 1024
String defaultTaskStartToCloseTimeout
StartChildWorkflowExecution
Decision. The
valid values are integers greater than or equal to 0
. An
integer value can be used to specify the duration in seconds while
NONE
can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String defaultExecutionStartToCloseTimeout
StartChildWorkflowExecution
Decision. The
duration is specified in seconds. The valid values are integers
greater than or equal to 0. Unlike some of the other timeout
parameters in Amazon SWF, you cannot specify a value of "NONE" for
defaultExecutionStartToCloseTimeout
; there is a one-year
max limit on the time that a workflow execution can run. Exceeding
this limit will always cause the workflow execution to time out.
Constraints:
Length: 0 - 8
TaskList defaultTaskList
StartChildWorkflowExecution
Decision.String defaultChildPolicy
StartChildWorkflowExecution
Decision. The
supported child policies are: WorkflowExecutionCancelRequested
event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
String activityId
activityId
of the activity task to be canceled.
Constraints:
Length: 1 - 256
String activityId
RequestCancelActivityTask
decision that failed.
Constraints:
Length: 1 - 256
String cause
Constraints:
Allowed Values: ACTIVITY_ID_UNKNOWN, OPERATION_NOT_PERMITTED
Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the
RequestCancelActivityTask
decision for this cancellation
request. This information can be useful for diagnosing problems by
tracing back the cause of events.String workflowId
workflowId
of the external workflow execution to
cancel. This field is required.
Constraints:
Length: 1 - 256
String runId
runId
of the external workflow execution to cancel.
Constraints:
Length: 0 - 64
String control
Constraints:
Length: 0 - 32768
String workflowId
workflowId
of the external workflow to which the
cancel request was to be delivered.
Constraints:
Length: 1 - 256
String runId
runId
of the external workflow execution.
Constraints:
Length: 0 - 64
String cause
Constraints:
Allowed Values: UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION, REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED
Long initiatedEventId
RequestCancelExternalWorkflowExecutionInitiated
event
corresponding to the
RequestCancelExternalWorkflowExecution
decision to cancel
this external workflow execution. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the
RequestCancelExternalWorkflowExecution
decision for this
cancellation request. This information can be useful for diagnosing
problems by tracing back the cause of events.String control
String workflowId
workflowId
of the external workflow execution to be
canceled.
Constraints:
Length: 1 - 256
String runId
runId
of the external workflow execution to be
canceled.
Constraints:
Length: 0 - 64
Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the
RequestCancelExternalWorkflowExecution
decision for this
cancellation request. This information can be useful for diagnosing
problems by tracing back the cause of events.String control
Constraints:
Length: 0 - 32768
String domain
Constraints:
Length: 1 - 256
String workflowId
Constraints:
Length: 1 - 256
String runId
Constraints:
Length: 0 - 64
String taskToken
taskToken
of the ActivityTask. taskToken
is generated by the service and should be
treated as an opaque value. If the task is passed to another process,
its taskToken
must also be passed. This enables it to
provide its progress and respond with results.
Constraints:
Length: 1 - 1024
String details
Constraints:
Length: 0 - 32768
String taskToken
taskToken
of the ActivityTask. taskToken
is generated by the service and should be
treated as an opaque value. If the task is passed to another process,
its taskToken
must also be passed. This enables it to
provide its progress and respond with results.
Constraints:
Length: 1 - 1024
String result
Constraints:
Length: 0 - 32768
String taskToken
taskToken
of the ActivityTask. taskToken
is generated by the service and should be
treated as an opaque value. If the task is passed to another process,
its taskToken
must also be passed. This enables it to
provide its progress and respond with results.
Constraints:
Length: 1 - 1024
String reason
Constraints:
Length: 0 - 256
String details
Constraints:
Length: 0 - 32768
String taskToken
taskToken
from the DecisionTask. taskToken
is generated by the service and should be
treated as an opaque value. If the task is passed to another process,
its taskToken
must also be passed. This enables it to
provide its progress and respond with results.
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> decisions
String executionContext
Constraints:
Length: 0 - 32768
String runId
runId
of a workflow execution. This Id is generated
by the service and can be used to uniquely identify the workflow
execution within a domain.
Constraints:
Length: 1 - 64
ActivityType activityType
String activityId
activityId
of the activity task. This field is
required. The specified string must not start or end with
whitespace. It must not contain a :
(colon),
/
(slash), |
(vertical bar), or any control
characters ( - | - ). Also, it must not
contain the literal string "arn".
Constraints:
Length: 1 - 256
String control
Constraints:
Length: 0 - 32768
String input
Constraints:
Length: 0 - 32768
String scheduleToCloseTimeout
The valid values are
integers greater than or equal to 0
. An integer value can
be used to specify the duration in seconds while NONE
can
be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList taskList
defaultTaskList
registered with the activity type will be used. The specified string must not start or end
with whitespace. It must not contain a :
(colon),
/
(slash), |
(vertical bar), or any control
characters ( - | - ). Also, it must not
contain the literal string "arn".
String scheduleToStartTimeout
The valid values are integers greater
than or equal to 0
. An integer value can be used to
specify the duration in seconds while NONE
can be used to
specify unlimited duration.
Constraints:
Length: 0 - 8
String startToCloseTimeout
The valid values are integers greater
than or equal to 0
. An integer value can be used to
specify the duration in seconds while NONE
can be used to
specify unlimited duration.
Constraints:
Length: 0 - 8
String heartbeatTimeout
The valid values are integers greater than or equal to
0
. An integer value can be used to specify the duration
in seconds while NONE
can be used to specify unlimited
duration.
Constraints:
Length: 0 - 8
ActivityType activityType
ScheduleActivityTask
decision that failed.String activityId
ScheduleActivityTask
decision that failed.
Constraints:
Length: 1 - 256
String cause
Constraints:
Allowed Values: ACTIVITY_TYPE_DEPRECATED, ACTIVITY_TYPE_DOES_NOT_EXIST, ACTIVITY_ID_ALREADY_IN_USE, OPEN_ACTIVITIES_LIMIT_EXCEEDED, ACTIVITY_CREATION_RATE_EXCEEDED, DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_TASK_LIST_UNDEFINED, DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED, DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED, OPERATION_NOT_PERMITTED
Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision that resulted in the scheduling of this activity task.
This information can be useful for diagnosing problems by tracing back
the chain of events leading up to this event.String workflowId
workflowId
of the workflow execution to be signaled.
This field is required.
Constraints:
Length: 1 - 256
String runId
runId
of the workflow execution to be signaled.
Constraints:
Length: 0 - 64
String signalName
Constraints:
Length: 1 - 256
String input
Constraints:
Length: 0 - 32768
String control
Constraints:
Length: 0 - 32768
String workflowId
workflowId
of the external workflow execution that
the signal was being delivered to.
Constraints:
Length: 1 - 256
String runId
runId
of the external workflow execution that the
signal was being delivered to.
Constraints:
Length: 0 - 64
String cause
Constraints:
Allowed Values: UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION, SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED
Long initiatedEventId
SignalExternalWorkflowExecutionInitiated
event corresponding to the
SignalExternalWorkflowExecution
decision to request this
signal. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the
SignalExternalWorkflowExecution
decision for this signal.
This information can be useful for diagnosing problems by tracing back
the cause of events leading up to this event.String control
String workflowId
workflowId
of the external workflow execution.
Constraints:
Length: 1 - 256
String runId
runId
of the external workflow execution to send the
signal to.
Constraints:
Length: 0 - 64
String signalName
Constraints:
Length: 1 - 256
String input
Constraints:
Length: 0 - 32768
Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the
SignalExternalWorkflowExecution
decision for this signal.
This information can be useful for diagnosing problems by tracing back
the cause of events leading up to this event.String control
Constraints:
Length: 0 - 32768
String domain
Constraints:
Length: 1 - 256
String workflowId
Constraints:
Length: 1 - 256
String runId
Constraints:
Length: 0 - 64
String signalName
Constraints:
Length: 1 - 256
String input
WorkflowExecutionSignaled
event in
the target workflow execution's history.
Constraints:
Length: 0 - 32768
WorkflowType workflowType
String workflowId
workflowId
of the workflow execution. This field is
required. The specified string must not start or end with
whitespace. It must not contain a :
(colon),
/
(slash), |
(vertical bar), or any control
characters ( - | - ). Also, it must not
contain the literal string "arn".
Constraints:
Length: 1 - 256
String control
Constraints:
Length: 0 - 32768
String input
Constraints:
Length: 0 - 32768
String executionStartToCloseTimeout
The valid values are integers greater than or equal
to 0
. An integer value can be used to specify the
duration in seconds while NONE
can be used to specify
unlimited duration.
Constraints:
Length: 0 - 8
TaskList taskList
The specified string must not start or end with
whitespace. It must not contain a :
(colon),
/
(slash), |
(vertical bar), or any control
characters ( - | - ). Also, it must not
contain the literal string "arn".
String taskStartToCloseTimeout
defaultTaskStartToCloseTimout
specified when registering
the workflow type using RegisterWorkflowType. The valid
values are integers greater than or equal to 0
. An
integer value can be used to specify the duration in seconds while
NONE
can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String childPolicy
WorkflowExecutionCancelRequested
event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
WorkflowType workflowType
StartChildWorkflowExecution
Decision that failed.String cause
Constraints:
Allowed Values: WORKFLOW_TYPE_DOES_NOT_EXIST, WORKFLOW_TYPE_DEPRECATED, OPEN_CHILDREN_LIMIT_EXCEEDED, OPEN_WORKFLOWS_LIMIT_EXCEEDED, CHILD_CREATION_RATE_EXCEEDED, WORKFLOW_ALREADY_RUNNING, DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_TASK_LIST_UNDEFINED, DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_CHILD_POLICY_UNDEFINED, OPERATION_NOT_PERMITTED
String workflowId
workflowId
of the child workflow execution.
Constraints:
Length: 1 - 256
Long initiatedEventId
StartChildWorkflowExecutionInitiated
event
corresponding to the StartChildWorkflowExecution
Decision to start this child workflow execution. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the
StartChildWorkflowExecution
Decision to request
this child workflow execution. This information can be useful for
diagnosing problems by tracing back the cause of events.String control
String workflowId
workflowId
of the child workflow execution.
Constraints:
Length: 1 - 256
WorkflowType workflowType
String control
Constraints:
Length: 0 - 32768
String input
Constraints:
Length: 0 - 32768
String executionStartToCloseTimeout
The valid values are integers greater than or
equal to 0
. An integer value can be used to specify the
duration in seconds while NONE
can be used to specify
unlimited duration.
Constraints:
Length: 0 - 8
TaskList taskList
Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the
StartChildWorkflowExecution
Decision to request
this child workflow execution. This information can be useful for
diagnosing problems by tracing back the cause of events.String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested
event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
String taskStartToCloseTimeout
The valid values are integers greater than or equal to
0
. An integer value can be used to specify the duration
in seconds while NONE
can be used to specify unlimited
duration.
Constraints:
Length: 0 - 8
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
String timerId
The specified
string must not start or end with whitespace. It must not contain a
:
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
). Also, it must not contain the literal string "arn".
Constraints:
Length: 1 - 256
String control
Constraints:
Length: 0 - 32768
String startToFireTimeout
The duration is specified in seconds. The valid values are integers greater than or equal to 0.
Constraints:
Length: 1 - 8
String timerId
StartTimer
decision that
failed.
Constraints:
Length: 1 - 256
String cause
Constraints:
Allowed Values: TIMER_ID_ALREADY_IN_USE, OPEN_TIMERS_LIMIT_EXCEEDED, TIMER_CREATION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED
Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the StartTimer
decision for this activity task. This information can be useful for
diagnosing problems by tracing back the cause of events.String domain
Constraints:
Length: 1 - 256
String workflowId
workflowId
at
the same time. The specified string must not start or end with
whitespace. It must not contain a :
(colon),
/
(slash), |
(vertical bar), or any control
characters ( - | - ). Also, it must not
contain the literal string "arn".
Constraints:
Length: 1 - 256
WorkflowType workflowType
TaskList taskList
defaultTaskList
specified when registering the workflow type. The specified string must not start
or end with whitespace. It must not contain a :
(colon),
/
(slash), |
(vertical bar), or any control
characters ( - | - ). Also, it must not
contain the literal string "arn".
String input
input
is made available to the new workflow execution in
the WorkflowExecutionStarted
history event.
Constraints:
Length: 0 - 32768
String executionStartToCloseTimeout
The duration is specified in seconds. The valid
values are integers greater than or equal to 0. Exceeding this limit
will cause the workflow execution to time out. Unlike some of the
other timeout parameters in Amazon SWF, you cannot specify a value of
"NONE" for this timeout; there is a one-year max limit on the time
that a workflow execution can run.
Constraints:
Length: 0 - 8
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
String taskStartToCloseTimeout
defaultTaskStartToCloseTimout
specified when registering
the workflow type using RegisterWorkflowType. The valid
values are integers greater than or equal to 0
. An
integer value can be used to specify the duration in seconds while
NONE
can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String childPolicy
WorkflowExecutionCancelRequested
event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
String tag
Constraints:
Length: 1 - 256
String name
Constraints:
Length: 1 - 256
String domain
Constraints:
Length: 1 - 256
String workflowId
Constraints:
Length: 1 - 256
String runId
Constraints:
Length: 0 - 64
String reason
Constraints:
Length: 0 - 256
String details
Constraints:
Length: 0 - 32768
String childPolicy
WorkflowExecutionCancelRequested
event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
String timerId
Constraints:
Length: 1 - 256
Long startedEventId
TimerStarted
event that was recorded when
this timer was started. This information can be useful for diagnosing
problems by tracing back the chain of events leading up to this event.Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the CancelTimer
decision to cancel this timer. This information can be useful for
diagnosing problems by tracing back the cause of events.String timerId
Constraints:
Length: 1 - 256
Long startedEventId
TimerStarted
event that was recorded when
this timer was started. This information can be useful for diagnosing
problems by tracing back the chain of events leading up to this event.String timerId
Constraints:
Length: 1 - 256
String control
Constraints:
Length: 0 - 32768
String startToFireTimeout
The duration is specified in seconds. The valid values are integers greater than or equal to 0.
Constraints:
Length: 1 - 8
Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the StartTimer
decision for this activity task. This information can be useful for
diagnosing problems by tracing back the cause of events.String details
Constraints:
Length: 0 - 32768
Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the
CancelWorkflowExecution
decision for this cancellation
request. This information can be useful for diagnosing problems by
tracing back the cause of events.WorkflowExecution externalWorkflowExecution
Long externalInitiatedEventId
RequestCancelExternalWorkflowExecutionInitiated
event
corresponding to the
RequestCancelExternalWorkflowExecution
decision to cancel
this workflow execution.The source event with this Id can be found in
the history of the source workflow execution. This information can be
useful for diagnosing problems by tracing back the chain of events
leading up to this event.String cause
Constraints:
Allowed Values: CHILD_POLICY_APPLIED
String result
Constraints:
Length: 0 - 32768
Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the
CompleteWorkflowExecution
decision to complete this
execution. This information can be useful for diagnosing problems by
tracing back the cause of events.String taskStartToCloseTimeout
The valid values are integers greater than or equal to
0
. An integer value can be used to specify the duration
in seconds while NONE
can be used to specify unlimited
duration.
Constraints:
Length: 1 - 8
String executionStartToCloseTimeout
The valid values
are integers greater than or equal to 0
. An integer value
can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
Constraints:
Length: 1 - 8
TaskList taskList
String childPolicy
WorkflowExecutionCancelRequested
event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
String input
Constraints:
Length: 0 - 32768
Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the
ContinueAsNewWorkflowExecution
decision that started this
execution. This information can be useful for diagnosing problems by
tracing back the cause of events.String newExecutionRunId
runId
of the new workflow execution.
Constraints:
Length: 1 - 64
String executionStartToCloseTimeout
The
valid values are integers greater than or equal to 0
. An
integer value can be used to specify the duration in seconds while
NONE
can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList taskList
String taskStartToCloseTimeout
The valid values are integers greater than or equal to
0
. An integer value can be used to specify the duration
in seconds while NONE
can be used to specify unlimited
duration.
Constraints:
Length: 0 - 8
String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested
event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
WorkflowType workflowType
WorkflowExecutionInfo executionInfo
WorkflowExecutionConfiguration executionConfiguration
WorkflowExecutionOpenCounts openCounts
Date latestActivityTaskTimestamp
String latestExecutionContext
Constraints:
Length: 0 - 32768
String reason
Constraints:
Length: 0 - 256
String details
Constraints:
Length: 0 - 32768
Long decisionTaskCompletedEventId
DecisionTaskCompleted
event corresponding
to the decision task that resulted in the
FailWorkflowExecution
decision to fail this execution.
This information can be useful for diagnosing problems by tracing back
the cause of events.String workflowId
Constraints:
Length: 1 - 256
WorkflowExecution execution
WorkflowType workflowType
Date startTimestamp
Date closeTimestamp
String executionStatus
Constraints:
Allowed Values: OPEN, CLOSED
String closeStatus
Constraints:
Allowed Values: COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT
WorkflowExecution parent
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
Boolean cancelRequested
com.amazonaws.internal.ListWithAutoConstructFlag<T> executionInfos
String nextPageToken
Constraints:
Length: 0 - 2048
Integer openActivityTasks
Constraints:
Range: 0 -
Integer openDecisionTasks
Constraints:
Range: 0 - 1
Integer openTimers
Constraints:
Range: 0 -
Integer openChildWorkflowExecutions
Constraints:
Range: 0 -
String signalName
Constraints:
Length: 1 - 256
String input
Constraints:
Length: 0 - 32768
WorkflowExecution externalWorkflowExecution
Long externalInitiatedEventId
SignalExternalWorkflowExecutionInitiated
event corresponding to the SignalExternalWorkflow
decision to signal this workflow execution.The source event with this
Id can be found in the history of the source workflow execution. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event. This field is set only if
the signal was initiated by another workflow execution.String input
Constraints:
Length: 0 - 32768
String executionStartToCloseTimeout
The valid values
are integers greater than or equal to 0
. An integer value
can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String taskStartToCloseTimeout
The
valid values are integers greater than or equal to 0
. An
integer value can be used to specify the duration in seconds while
NONE
can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String childPolicy
WorkflowExecutionCancelRequested
event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
TaskList taskList
WorkflowType workflowType
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
String continuedExecutionRunId
ContinueAsNewWorkflowExecution
decision, then it contains
the runId
of the previous workflow execution that was
closed and continued as this execution.
Constraints:
Length: 0 - 64
WorkflowExecution parentWorkflowExecution
Long parentInitiatedEventId
StartChildWorkflowExecutionInitiated
event
corresponding to the StartChildWorkflowExecution
Decision to start this workflow execution. The source event
with this Id can be found in the history of the source workflow
execution. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.String reason
Constraints:
Length: 0 - 256
String details
Constraints:
Length: 0 - 32768
String childPolicy
WorkflowExecutionCancelRequested
event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
String cause
Constraints:
Allowed Values: CHILD_POLICY_APPLIED, EVENT_LIMIT_EXCEEDED, OPERATOR_INITIATED
String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE
String childPolicy
WorkflowExecutionCancelRequested
event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
String name
Constraints:
Length: 1 - 256
String version
Constraints:
Length: 1 - 64
String defaultTaskStartToCloseTimeout
StartChildWorkflowExecution
Decision. The valid
values are integers greater than or equal to 0
. An
integer value can be used to specify the duration in seconds while
NONE
can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String defaultExecutionStartToCloseTimeout
StartChildWorkflowExecution
Decision. The valid
values are integers greater than or equal to 0
. An
integer value can be used to specify the duration in seconds while
NONE
can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList defaultTaskList
StartChildWorkflowExecution
Decision.String defaultChildPolicy
StartChildWorkflowExecution
Decision. The
supported child policies are: WorkflowExecutionCancelRequested
event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
WorkflowTypeInfo typeInfo
The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.
WorkflowTypeConfiguration configuration
WorkflowType workflowType
String status
Constraints:
Allowed Values: REGISTERED, DEPRECATED
String description
Constraints:
Length: 0 - 1024
Date creationDate
Date deprecationDate
com.amazonaws.internal.ListWithAutoConstructFlag<T> typeInfos
String nextPageToken
Constraints:
Length: 0 - 2048
String topicArn
String label
com.amazonaws.internal.ListWithAutoConstructFlag<T> aWSAccountIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> actionNames
Valid values: any Amazon SNS action name.
String topicArn
String token
Subscribe
action.String authenticateOnUnsubscribe
true
and the request has an
AWS signature, then only the topic owner and the subscription owner
can unsubscribe the endpoint. The unsubscribe action requires AWS
authentication.String subscriptionArn
String name
String platform
Map<K,V> attributes
String platformApplicationArn
String platformApplicationArn
String token
String customUserData
Map<K,V> attributes
String endpointArn
String name
Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
String topicArn
String endpointArn
String platformApplicationArn
String topicArn
String endpointArn
Map<K,V> attributes
CustomUserData
-- arbitrary user data to associate
with the endpoint. 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. Message Processor will
set this to false when a notification service indicates to 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 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
String messageId
Length Constraint: Maximum 100 characters
String endpointArn
Map<K,V> attributes
CustomUserData
-- arbitrary
user data to associate with the endpoint. 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. Message Processor will set this to false when a notification
service indicates to 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
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
String id
Boolean senderFault
String code
String message
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 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 queueNamePrefix
String queueUrl
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeNames
Integer maxNumberOfMessages
All of the messages are not necessarily returned.
Integer visibilityTimeout
ReceiveMessage
request.Integer waitTimeSeconds
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> successful
com.amazonaws.internal.ListWithAutoConstructFlag<T> failed
String id
String messageId
String mD5OfMessageBody
String mD5OfMessageBody
String messageId
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:
Allowed Values: GMT-12:00, GMT-11:00, GMT-10:00, GMT-9:00, GMT-8:00, GMT-7:00, GMT-6:00, GMT-5:00, GMT-4:00, GMT-3:30, GMT-3:00, GMT-2:00, GMT-1:00, GMT, GMT+1:00, GMT+2:00, GMT+3:00, GMT+3:30, GMT+4:00, GMT+4:30, GMT+5:00, GMT+5:30, GMT+5:45, GMT+6:00, GMT+7:00, GMT+8:00, GMT+9:00, GMT+9:30, GMT+10:00, GMT+11:00, GMT+12:00
String gatewayRegion
Host
header in the request.
For more information about available regions and endpoints for AWS
Storage Gateway, see Regions
and Endpoints in the Amazon Web Services Glossary.
Valid Values: "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "ap-northeast-1", "ap-southest-1", "sa-east-1"
Constraints:
Length: 1 - 25
String gatewayType
STORED
.
Constraints:
Allowed Values: STORED, CACHED
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskIds
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskIds
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskIds
String gatewayARN
Constraints:
Length: 50 - 500
String volumeARN
Constraints:
Length: 50 - 500
String volumeId
Constraints:
Length: 12 - 30
String volumeType
Constraints:
Allowed Values: STORED iSCSI, CACHED iSCSI
String volumeStatus
Constraints:
Allowed Values: CREATING, AVAILABLE, RESTORING, BOOTSTRAPPING, IRRECOVERABLE, PASS THROUGH, RESTORE AND PASS THROUGH, DELETED, WORKING STORAGE NOT CONFIGURED, UPLOAD BUFFER NOT CONFIGURED
Long volumeSizeInBytes
Double volumeProgress
String sourceSnapshotId
Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z
VolumeiSCSIAttributes volumeiSCSIAttributes
String targetARN
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
Constraints:
Length: 50 - 800
String secretToAuthenticateInitiator
Constraints:
Length: 12 - 16
String initiatorName
Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+
String secretToAuthenticateTarget
Constraints:
Length: 12 - 16
String gatewayARN
Constraints:
Length: 50 - 500
Long volumeSizeInBytes
String snapshotId
Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z
String targetName
Constraints:
Length: 1 - 200
Pattern: ^[-\.;a-z0-9]+$
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
String clientToken
Constraints:
Length: 5 - 100
String volumeARN
Constraints:
Length: 50 - 500
String snapshotDescription
Length: Minimum length of 1. Maximum length of 255.
Constraints:
Length: 1 - 255
String snapshotId
Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z
String volumeARN
Constraints:
Length: 50 - 500
String volumeRecoveryPointTime
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
String bandwidthType
Valid Values:
Upload
, Download
, All
Constraints:
Allowed Values: UPLOAD, DOWNLOAD, ALL
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
Constraints:
Length: 50 - 500
String volumeARN
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
DiskIds
array is empty.Long cacheAllocatedInBytes
Double cacheUsedPercentage
Double cacheDirtyPercentage
Double cacheHitPercentage
Double cacheMissPercentage
String targetARN
Constraints:
Length: 50 - 800
com.amazonaws.internal.ListWithAutoConstructFlag<T> chapCredentials
InitiatorName: The iSCSI initiator that connects to the target.
SecretToAuthenticateInitiator: The secret key that the initiator (e.g. Windows client) must provide to participate in mutual CHAP with the target.
SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
TargetARN: The Amazon Resource Name (ARN) of the storage volume.
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayId
Constraints:
Length: 12 - 30
String gatewayTimezone
Constraints:
Allowed Values: GMT-12:00, GMT-11:00, GMT-10:00, GMT-9:00, GMT-8:00, GMT-7:00, GMT-6:00, GMT-5:00, GMT-4:00, GMT-3:30, GMT-3:00, GMT-2:00, GMT-1:00, GMT, GMT+1:00, GMT+2:00, GMT+3:00, GMT+3:30, GMT+4:00, GMT+4:30, GMT+5:00, GMT+5:30, GMT+5:45, GMT+6:00, GMT+7:00, GMT+8:00, GMT+9:00, GMT+9:30, GMT+10:00, GMT+11:00, GMT+12:00
String gatewayState
Constraints:
Allowed Values: RUNNING, SHUTDOWN
com.amazonaws.internal.ListWithAutoConstructFlag<T> gatewayNetworkInterfaces
String gatewayType
Constraints:
Allowed Values: STORED, CACHED
String nextUpdateAvailabilityDate
Constraints:
Length: 1 - 25
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 timezone
Constraints:
Allowed Values: GMT-12:00, GMT-11:00, GMT-10:00, GMT-9:00, GMT-8:00, GMT-7:00, GMT-6:00, GMT-5:00, GMT-4:00, GMT-3:30, GMT-3:00, GMT-2:00, GMT-1:00, GMT, GMT+1:00, GMT+2:00, GMT+3:00, GMT+3:30, GMT+4:00, GMT+4:30, GMT+5:00, GMT+5:30, GMT+5:45, GMT+6:00, GMT+7:00, GMT+8:00, GMT+9:00, GMT+9:30, GMT+10:00, GMT+11:00, GMT+12:00
String volumeARN
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 timezone
Constraints:
Allowed Values: GMT-12:00, GMT-11:00, GMT-10:00, GMT-9:00, GMT-8:00, GMT-7:00, GMT-6:00, GMT-5:00, GMT-4:00, GMT-3:30, GMT-3:00, GMT-2:00, GMT-1:00, GMT, GMT+1:00, GMT+2:00, GMT+3:00, GMT+3:30, GMT+4:00, GMT+4:30, GMT+5:00, GMT+5:30, GMT+5:45, GMT+6:00, GMT+7:00, GMT+8:00, GMT+9:00, GMT+9:30, GMT+10:00, GMT+11:00, GMT+12:00
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeARNs
com.amazonaws.internal.ListWithAutoConstructFlag<T> storediSCSIVolumes
ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.
LunNumber: The logical disk number.
NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the stored volume as an iSCSI target.
NetworkInterfacePort: The port used to communicate with iSCSI targets.
PreservedExistingData: Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.
SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-1122aabb. Otherwise, this field is not included.
StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about one stored volume.
TargetARN: The Amazon Resource Name (ARN) of the volume target.
VolumeARN: The Amazon Resource Name (ARN) of the stored volume.
VolumeDiskId: The disk ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.
VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
VolumeProgress: Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.
VolumeSizeInBytes: The size of the volume in bytes.
VolumeStatus: One of the VolumeStatus values that indicates the state of the volume.
VolumeType: One of the enumeration values describing the type of the volume. Currently, on STORED volumes are supported.
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskIds
DiskIds
array is
empty.Long uploadBufferUsedInBytes
Long uploadBufferAllocatedInBytes
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskIds
Long workingStorageUsedInBytes
Long workingStorageAllocatedInBytes
String diskId
Constraints:
Length: 1 - 300
String diskPath
String diskNode
Long diskSizeInBytes
String diskAllocationType
Constraints:
Allowed Values: AVAILABLE, CACHE STORAGE, STORED iSCSI VOLUME, UPLOAD BUFFER, WORKING STORAGE
String diskAllocationResource
String gatewayARN
Constraints:
Length: 50 - 500
StorageGatewayError error
StorageGatewayError error
com.amazonaws.internal.ListWithAutoConstructFlag<T> gateways
String marker
Constraints:
Length: 1 - 1000
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> disks
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeRecoveryPointInfos
String gatewayARN
Constraints:
Length: 50 - 500
String marker
Constraints:
Length: 1 - 1000
Integer limit
Constraints:
Range: 1 -
String gatewayARN
Constraints:
Length: 50 - 500
String marker
Constraints:
Length: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeInfos
VolumeInfos
is an empty array "[]".String ipv4Address
String macAddress
String ipv6Address
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 errorCode
Constraints:
Allowed Values: ActivationKeyExpired, ActivationKeyInvalid, ActivationKeyNotFound, GatewayInternalError, GatewayNotConnected, GatewayNotFound, GatewayProxyNetworkConnectionBusy, AuthenticationFailure, BandwidthThrottleScheduleNotFound, Blocked, CannotExportSnapshot, ChapCredentialNotFound, DiskAlreadyAllocated, DiskDoesNotExist, DiskSizeGreaterThanVolumeMaxSize, DiskSizeLessThanVolumeSize, DiskSizeNotGigAligned, DuplicateCertificateInfo, DuplicateSchedule, EndpointNotFound, IAMNotSupported, InitiatorInvalid, InitiatorNotFound, InternalError, InvalidGateway, InvalidEndpoint, InvalidParameters, InvalidSchedule, LocalStorageLimitExceeded, LunAlreadyAllocated , LunInvalid, MaximumContentLengthExceeded, MaximumVolumeCountExceeded, NetworkConfigurationChanged, NoDisksAvailable, NotImplemented, NotSupported, OperationAborted, OutdatedGateway, ParametersNotImplemented, RegionInvalid, RequestTimeout, ServiceUnavailable, SnapshotDeleted, SnapshotIdInvalid, SnapshotInProgress, SnapshotNotFound, SnapshotScheduleNotFound, StagingAreaFull, StorageFailure, TargetAlreadyExists, TargetInvalid, TargetNotFound, UnauthorizedOperation, VolumeAlreadyExists, VolumeIdInvalid, VolumeInUse, VolumeNotFound, VolumeNotReady
Map<K,V> errorDetails
String volumeARN
Constraints:
Length: 50 - 500
String volumeId
Constraints:
Length: 12 - 30
String volumeType
Constraints:
Allowed Values: STORED iSCSI, CACHED iSCSI
String volumeStatus
Constraints:
Allowed Values: CREATING, AVAILABLE, RESTORING, BOOTSTRAPPING, IRRECOVERABLE, PASS THROUGH, RESTORE AND PASS THROUGH, DELETED, WORKING STORAGE NOT CONFIGURED, UPLOAD BUFFER NOT CONFIGURED
Long volumeSizeInBytes
Double volumeProgress
String volumeDiskId
Constraints:
Length: 1 - 300
String sourceSnapshotId
Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z
Boolean preservedExistingData
Valid Values: true, false
VolumeiSCSIAttributes volumeiSCSIAttributes
String gatewayARN
Constraints:
Length: 50 - 500
Long averageUploadRateLimitInBitsPerSec
Constraints:
Range: 51200 -
Long averageDownloadRateLimitInBitsPerSec
Constraints:
Range: 102400 -
String gatewayARN
Constraints:
Length: 50 - 500
String targetARN
Constraints:
Length: 50 - 800
String secretToAuthenticateInitiator
Constraints:
Length: 12 - 16
String initiatorName
Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+
String secretToAuthenticateTarget
Constraints:
Length: 12 - 16
String targetARN
Constraints:
Length: 50 - 800
String initiatorName
Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayName
Constraints:
Length: 2 - 255
Pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$
String gatewayTimezone
Constraints:
Allowed Values: GMT-12:00, GMT-11:00, GMT-10:00, GMT-9:00, GMT-8:00, GMT-7:00, GMT-6:00, GMT-5:00, GMT-4:00, GMT-3:30, GMT-3:00, GMT-2:00, GMT-1:00, GMT, GMT+1:00, GMT+2:00, GMT+3:00, GMT+3:30, GMT+4:00, GMT+4:30, GMT+5:00, GMT+5:30, GMT+5:45, GMT+6:00, GMT+7:00, GMT+8:00, GMT+9:00, GMT+9:30, GMT+10:00, GMT+11:00, GMT+12:00
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
String gatewayARN
Constraints:
Length: 50 - 500
Integer hourOfDay
Constraints:
Range: 0 - 23
Integer minuteOfHour
Constraints:
Range: 0 - 59
Integer dayOfWeek
Constraints:
Range: 0 - 6
String gatewayARN
Constraints:
Length: 50 - 500
String volumeARN
Constraints:
Length: 50 - 500
Integer startAt
Constraints:
Range: 0 - 23
Integer recurrenceInHours
Constraints:
Range: 1 - 24
String description
Constraints:
Length: 1 - 255
String volumeARN
Constraints:
Length: 50 - 500
String volumeARN
arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
Constraints:
Length: 50 - 500
String volumeType
Constraints:
Allowed Values: STORED iSCSI, CACHED iSCSI
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 volumeARN
Constraints:
Length: 50 - 500
Long volumeSizeInBytes
Long volumeUsageInBytes
String volumeRecoveryPointTime
String caseId
String communicationBody
Constraints:
Length: 1 - 8000
com.amazonaws.internal.ListWithAutoConstructFlag<T> ccEmailAddresses
Constraints:
Length: 0 - 10
Boolean result
String caseId
String displayId
String subject
String status
String serviceCode
String categoryCode
String severityCode
String submittedBy
String timeCreated
RecentCaseCommunications recentCommunications
com.amazonaws.internal.ListWithAutoConstructFlag<T> ccEmailAddresses
String language
String caseId
String body
String submittedBy
String timeCreated
String subject
String serviceCode
Constraints:
Pattern: [0-9a-z\-_]+
String severityCode
String categoryCode
String communicationBody
Constraints:
Length: 1 - 8000
com.amazonaws.internal.ListWithAutoConstructFlag<T> ccEmailAddresses
Constraints:
Length: 0 - 10
String language
String issueType
String caseId
com.amazonaws.internal.ListWithAutoConstructFlag<T> caseIdList
Constraints:
Length: 0 - 100
String displayId
String afterTime
String beforeTime
Boolean includeResolvedCases
String nextToken
Integer maxResults
Constraints:
Range: 10 - 100
String language
com.amazonaws.internal.ListWithAutoConstructFlag<T> cases
String nextToken
String caseId
String beforeTime
String afterTime
String nextToken
Integer maxResults
Constraints:
Range: 10 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> communications
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> serviceCodeList
Constraints:
Length: 0 - 100
String language
String language
com.amazonaws.internal.ListWithAutoConstructFlag<T> checkIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> statuses
String checkId
String language
TrustedAdvisorCheckResult result
String language
com.amazonaws.internal.ListWithAutoConstructFlag<T> checks
com.amazonaws.internal.ListWithAutoConstructFlag<T> summaries
com.amazonaws.internal.ListWithAutoConstructFlag<T> communications
String nextToken
String checkId
TrustedAdvisorCheckRefreshStatus status
String caseId
String initialCaseStatus
String finalCaseStatus
String code
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> categories
TrustedAdvisorCostOptimizingSummary costOptimizing
String id
String name
String description
String category
com.amazonaws.internal.ListWithAutoConstructFlag<T> metadata
String checkId
String status
Long millisUntilNextRefreshable
String checkId
String timestamp
String status
TrustedAdvisorResourcesSummary resourcesSummary
TrustedAdvisorCategorySpecificSummary categorySpecificSummary
com.amazonaws.internal.ListWithAutoConstructFlag<T> flaggedResources
String checkId
String timestamp
String status
Boolean hasFlaggedResources
TrustedAdvisorResourcesSummary resourcesSummary
TrustedAdvisorCategorySpecificSummary categorySpecificSummary
Double estimatedMonthlySavings
Double estimatedPercentMonthlySavings
String status
String region
String resourceId
Boolean isSuppressed
com.amazonaws.internal.ListWithAutoConstructFlag<T> metadata
Long resourcesProcessed
Long resourcesFlagged
Long resourcesIgnored
Long resourcesSuppressed
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.