String requestId
String errorCode
AmazonServiceException.ErrorType errorType
AmazonServiceException.ErrorTypeString errorMessage
int statusCode
String serviceName
String rawResponseContent
String extraInfo
String id
The identifier of the API Key.
String name
The name of the API Key.
String description
The description of the API Key.
Boolean enabled
Specifies whether the API Key can be used by callers.
List<E> stageKeys
Date createdDate
The date when the API Key was created, in ISO 8601 format.
Date lastUpdatedDate
When the API Key was last updated, in ISO 8601 format.
String id
The identifier of the API Key.
String name
The name of the API Key.
String description
The description of the API Key.
Boolean enabled
Specifies whether the API Key can be used by callers.
List<E> stageKeys
Date createdDate
The date when the API Key was created, in ISO 8601 format.
Date lastUpdatedDate
When the API Key was last updated, in ISO 8601 format.
String domainName
The domain name of the BasePathMapping resource to create.
String basePath
The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify a base path name after the domain name.
String restApiId
The name of the API that you want to apply this mapping to.
String stage
The name of the API's stage that you want to use for this mapping. Leave this blank if you do not want callers to explicitly specify the stage name after any base path name.
String restApiId
The RestApi resource identifier for the Deployment resource to create.
String stageName
The name of the Stage resource for the Deployment resource to create.
String stageDescription
The description of the Stage resource for the Deployment resource to create.
String description
The description for the Deployment resource to create.
Boolean cacheClusterEnabled
Enables a cache cluster for the Stage resource specified in the input.
String cacheClusterSize
Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
Map<K,V> variables
A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphabetic characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+
String id
The identifier for the deployment resource.
String description
The description for the deployment resource.
Date createdDate
The date and time that the deployment resource was created.
Map<K,V> apiSummary
Gets a summary of the RestApi at the date and time that the deployment resource was created.
String domainName
The name of the DomainName resource.
String certificateName
The name of the certificate.
String certificateBody
The body of the server certificate provided by your certificate authority.
String certificatePrivateKey
Your certificate's private key.
String certificateChain
The intermediate certificates and optionally the root certificate, one after the other without any blank lines. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.
String domainName
The name of the DomainName resource.
String certificateName
The name of the certificate.
Date certificateUploadDate
The date when the certificate was uploaded, in ISO 8601 format.
String distributionDomainName
The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.
String restApiId
String name
The name of the model.
String description
The description of the model.
String schema
The schema for the model. For application/json models, this
should be JSON-schema draft v4
model.
String contentType
The content-type for the model.
String id
The identifier for the model resource.
String name
The name of the model.
String description
The description of the model.
String schema
The schema for the model. For application/json models, this
should be JSON-schema draft v4
model.
String contentType
The content-type for the model.
String id
The resource's identifier.
String parentId
The parent resource's identifier.
String pathPart
The last path segment for this resource.
String path
The full path for this resource.
Map<K,V> resourceMethods
Map of methods for this resource, which is included only if requested using the embed option.
String id
The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
String name
The API's name.
String description
The API's description.
Date createdDate
The date when the API was created, in ISO 8601 format.
String restApiId
String stageName
The name for the Stage resource.
String deploymentId
The identifier of the Deployment resource for the Stage resource.
String description
The description of the Stage resource.
Boolean cacheClusterEnabled
Whether cache clustering is enabled for the stage.
String cacheClusterSize
The stage's cache cluster size.
Map<K,V> variables
A map that defines the stage variables for the new Stage resource. Variable names can have alphabetic characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+
String deploymentId
The identifier of the Deployment that the stage points to.
String clientCertificateId
String stageName
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.
String description
The stage's description.
Boolean cacheClusterEnabled
Specifies whether a cache cluster is enabled for the stage.
String cacheClusterSize
The size of the cache cluster for the stage, if enabled.
String cacheClusterStatus
The status of the cache cluster for the stage, if enabled.
Map<K,V> methodSettings
A map that defines the method settings for a Stage resource. Keys
are defined as {resource_path}/{http_method} for an
individual method override, or \*/\* for the settings
applied to all methods in the stage.
Map<K,V> variables
A map that defines the stage variables for a Stage resource. Variable names can have alphabetic characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+
Date createdDate
The date and time that the stage was created, in ISO 8601 format.
Date lastUpdatedDate
The date and time that information about the stage was last updated, in ISO 8601 format.
String domainName
The domain name of the BasePathMapping resource to delete.
String basePath
The base path name of the BasePathMapping resource to delete.
String clientCertificateId
String restApiId
The identifier of the RestApi resource for the Deployment resource to delete.
String deploymentId
The identifier of the Deployment resource to delete.
String domainName
The name of the DomainName resource to be deleted.
String restApiId
Specifies a delete integration response request's API identifier.
String resourceId
Specifies a delete integration response request's resource identifier.
String httpMethod
Specifies a delete integration response request's HTTP method.
String statusCode
Specifies a delete integration response request's status code.
String restApiId
The RestApi identifier for the MethodResponse resource.
String resourceId
The Resource identifier for the MethodResponse resource.
String httpMethod
The HTTP verb identifier for the parent Method resource.
String statusCode
The status code identifier for the MethodResponse resource.
String id
The identifier for the deployment resource.
String description
The description for the deployment resource.
Date createdDate
The date and time that the deployment resource was created.
Map<K,V> apiSummary
Gets a summary of the RestApi at the date and time that the deployment resource was created.
String domainName
The name of the DomainName resource.
String certificateName
The name of the certificate.
Date certificateUploadDate
The date when the certificate was uploaded, in ISO 8601 format.
String distributionDomainName
The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.
String description
String cloudwatchRoleArn
Specifies the Amazon resource name (ARN) of an Amazon CloudWatch role for the current Account resource.
ThrottleSettings throttleSettings
Specifies the application programming interface (API) throttle settings for the current Account resource.
String id
The identifier of the API Key.
String name
The name of the API Key.
String description
The description of the API Key.
Boolean enabled
Specifies whether the API Key can be used by callers.
List<E> stageKeys
Date createdDate
The date when the API Key was created, in ISO 8601 format.
Date lastUpdatedDate
When the API Key was last updated, in ISO 8601 format.
String domainName
The domain name of the BasePathMapping resource to be described.
String basePath
The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify any base path name after the domain name.
String domainName
The domain name of a BasePathMapping resource.
String position
The position of the current BasePathMapping resource in the collection to get information about.
Integer limit
The maximum number of BasePathMapping resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
String position
List<E> items
The current page of any BasePathMapping resources in the collection of base path mapping resources.
String clientCertificateId
String restApiId
The identifier of the RestApi resource for the Deployment resource to get information about.
String deploymentId
The identifier of the Deployment resource to get information about.
String id
The identifier for the deployment resource.
String description
The description for the deployment resource.
Date createdDate
The date and time that the deployment resource was created.
Map<K,V> apiSummary
Gets a summary of the RestApi at the date and time that the deployment resource was created.
String restApiId
The identifier of the RestApi resource for the collection of Deployment resources to get information about.
String position
The position of the current Deployment resource in the collection to get information about.
Integer limit
The maximum number of Deployment resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
String position
List<E> items
The current page of any Deployment resources in the collection of deployment resources.
String domainName
The name of the DomainName resource.
String domainName
The name of the DomainName resource.
String certificateName
The name of the certificate.
Date certificateUploadDate
The date when the certificate was uploaded, in ISO 8601 format.
String distributionDomainName
The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.
String position
The position of the current domain names to get information about.
Integer limit
The maximum number of DomainName resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
String position
List<E> items
The current page of any DomainName resources in the collection of DomainName resources.
String restApiId
Specifies a get integration response request's API identifier.
String resourceId
Specifies a get integration response request's resource identifier.
String httpMethod
Specifies a get integration response request's HTTP method.
String statusCode
Specifies a get integration response request's status code.
String statusCode
Specifies the status code that is used to map the integration response to an existing MethodResponse.
String selectionPattern
Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the backend. If the backend is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS backends, the HTTP status code is matched.
Map<K,V> responseParameters
Represents response parameters that can be read from the backend
response. Response parameters are represented as a key/value map, with a
destination as the key and a source as the value. A destination must
match an existing response parameter in the Method. The source can
be a header from the backend response, or a static value. Static values
are specified using enclosing single quotes, and backend response headers
can be read using the pattern
integration.response.header.{name}.
Map<K,V> responseTemplates
Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
String type
Specifies the integration's type.
String httpMethod
Specifies the integration's HTTP method type.
String uri
Specifies the integration's Uniform Resource Identifier (URI). For HTTP
integrations, the URI must be a fully formed, encoded HTTP(S) URL
according to the RFC-3986 specification.
For AWS integrations, the URI should be of the form
arn:aws:apigateway:{region}:{service}:{path|action}/{service_api}. Region and service are used to determine the
right endpoint. For AWS services that use the Action= query
string parameter, service_api should be a valid action for
the desired service. For RESTful AWS service APIs, path is
used to indicate that the remaining substring in the URI should be
treated as the path to the resource, including the initial /
.
String credentials
Specifies the credentials required for the integration, if any. For AWS
integrations, three options are available. To specify an IAM Role for
Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN).
To require that the caller's identity be passed through from the request,
specify the string arn:aws:iam::\*:user/\*. To use
resource-based permissions on supported AWS services, specify null.
Map<K,V> requestParameters
Represents requests parameters that are sent with the backend request.
Request parameters are represented as a key/value map, with a destination
as the key and a source as the value. A source must match an existing
method request parameter, or a static value. Static values must be
enclosed with single quotes, and be pre-encoded based on their
destination in the request. The destination must match the pattern
integration.request.{location}.{name}, where
location is either querystring, path, or header.
name must be a valid, unique parameter name.
Map<K,V> requestTemplates
Specifies the integration's request templates.
String cacheNamespace
Specifies the integration's cache namespace.
List<E> cacheKeyParameters
Specifies the integration's cache key parameters.
Map<K,V> integrationResponses
Specifies the integration's responses.
String restApiId
The RestApi identifier for the MethodResponse resource.
String resourceId
The Resource identifier for the MethodResponse resource.
String httpMethod
The HTTP verb identifier for the parent Method resource.
String statusCode
The status code identifier for the MethodResponse resource.
String statusCode
The method response's status code.
Map<K,V> responseParameters
Represents response parameters that can be sent back to the caller by
Amazon API Gateway. Response parameters are represented as a key/value
map, with a destination as the key and a boolean flag as the value, which
is used to specify whether the parameter is required. A destination must
match the pattern method.response.header.{name}, where
name is a valid, unique header name. Destinations specified
here are available to the integration for mapping from integration
response parameters.
Map<K,V> responseModels
String httpMethod
The HTTP method.
String authorizationType
The method's authorization type.
Boolean apiKeyRequired
Specifies whether the method requires a valid ApiKey.
Map<K,V> requestParameters
Represents request parameters that can be accepted by Amazon API Gateway.
Request parameters are represented as a key/value map, with a source as
the key and a Boolean flag as the value. The Boolean flag is used to
specify whether the parameter is required. A source must match the
pattern method.request.{location}.{name}, where
location is either querystring, path, or header.
name is a valid, unique parameter name. Sources specified
here are available to the integration for mapping to integration request
parameters or templates.
Map<K,V> requestModels
Map<K,V> methodResponses
Represents available responses that can be sent to the caller. Method responses are represented as a key/value map, with an HTTP status code as the key and a MethodResponse as the value. The status codes are available for the Integration responses to map to.
Integration methodIntegration
The method's integration.
String id
The identifier for the model resource.
String name
The name of the model.
String description
The description of the model.
String schema
The schema for the model. For application/json models, this
should be JSON-schema draft v4
model.
String contentType
The content-type for the model.
String restApiId
The RestApi identifier.
String position
The position of the next set of results in the Models resource to get information about.
Integer limit
The maximum number of models in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
String value
The Apache Velocity Template Language (VTL) template content used for the template resource.
String id
The resource's identifier.
String parentId
The parent resource's identifier.
String pathPart
The last path segment for this resource.
String path
The full path for this resource.
Map<K,V> resourceMethods
Map of methods for this resource, which is included only if requested using the embed option.
String restApiId
The RestApi identifier for the Resource.
String position
The position of the next set of results in the current Resources resource to get information about.
Integer limit
The maximum number of Resource resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
String id
The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
String name
The API's name.
String description
The API's description.
Date createdDate
The date when the API was created, in ISO 8601 format.
String contentType
String contentDisposition
ByteBuffer body
String deploymentId
The identifier of the Deployment that the stage points to.
String clientCertificateId
String stageName
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.
String description
The stage's description.
Boolean cacheClusterEnabled
Specifies whether a cache cluster is enabled for the stage.
String cacheClusterSize
The size of the cache cluster for the stage, if enabled.
String cacheClusterStatus
The status of the cache cluster for the stage, if enabled.
Map<K,V> methodSettings
A map that defines the method settings for a Stage resource. Keys
are defined as {resource_path}/{http_method} for an
individual method override, or \*/\* for the settings
applied to all methods in the stage.
Map<K,V> variables
A map that defines the stage variables for a Stage resource. Variable names can have alphabetic characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+
Date createdDate
The date and time that the stage was created, in ISO 8601 format.
Date lastUpdatedDate
The date and time that information about the stage was last updated, in ISO 8601 format.
String type
Specifies the integration's type.
String httpMethod
Specifies the integration's HTTP method type.
String uri
Specifies the integration's Uniform Resource Identifier (URI). For HTTP
integrations, the URI must be a fully formed, encoded HTTP(S) URL
according to the RFC-3986 specification.
For AWS integrations, the URI should be of the form
arn:aws:apigateway:{region}:{service}:{path|action}/{service_api}. Region and service are used to determine the
right endpoint. For AWS services that use the Action= query
string parameter, service_api should be a valid action for
the desired service. For RESTful AWS service APIs, path is
used to indicate that the remaining substring in the URI should be
treated as the path to the resource, including the initial /
.
String credentials
Specifies the credentials required for the integration, if any. For AWS
integrations, three options are available. To specify an IAM Role for
Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN).
To require that the caller's identity be passed through from the request,
specify the string arn:aws:iam::\*:user/\*. To use
resource-based permissions on supported AWS services, specify null.
Map<K,V> requestParameters
Represents requests parameters that are sent with the backend request.
Request parameters are represented as a key/value map, with a destination
as the key and a source as the value. A source must match an existing
method request parameter, or a static value. Static values must be
enclosed with single quotes, and be pre-encoded based on their
destination in the request. The destination must match the pattern
integration.request.{location}.{name}, where
location is either querystring, path, or header.
name must be a valid, unique parameter name.
Map<K,V> requestTemplates
Specifies the integration's request templates.
String cacheNamespace
Specifies the integration's cache namespace.
List<E> cacheKeyParameters
Specifies the integration's cache key parameters.
Map<K,V> integrationResponses
Specifies the integration's responses.
String statusCode
Specifies the status code that is used to map the integration response to an existing MethodResponse.
String selectionPattern
Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the backend. If the backend is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS backends, the HTTP status code is matched.
Map<K,V> responseParameters
Represents response parameters that can be read from the backend
response. Response parameters are represented as a key/value map, with a
destination as the key and a source as the value. A destination must
match an existing response parameter in the Method. The source can
be a header from the backend response, or a static value. Static values
are specified using enclosing single quotes, and backend response headers
can be read using the pattern
integration.response.header.{name}.
Map<K,V> responseTemplates
Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
String retryAfterSeconds
String httpMethod
The HTTP method.
String authorizationType
The method's authorization type.
Boolean apiKeyRequired
Specifies whether the method requires a valid ApiKey.
Map<K,V> requestParameters
Represents request parameters that can be accepted by Amazon API Gateway.
Request parameters are represented as a key/value map, with a source as
the key and a Boolean flag as the value. The Boolean flag is used to
specify whether the parameter is required. A source must match the
pattern method.request.{location}.{name}, where
location is either querystring, path, or header.
name is a valid, unique parameter name. Sources specified
here are available to the integration for mapping to integration request
parameters or templates.
Map<K,V> requestModels
Map<K,V> methodResponses
Represents available responses that can be sent to the caller. Method responses are represented as a key/value map, with an HTTP status code as the key and a MethodResponse as the value. The status codes are available for the Integration responses to map to.
Integration methodIntegration
The method's integration.
String statusCode
The method response's status code.
Map<K,V> responseParameters
Represents response parameters that can be sent back to the caller by
Amazon API Gateway. Response parameters are represented as a key/value
map, with a destination as the key and a boolean flag as the value, which
is used to specify whether the parameter is required. A destination must
match the pattern method.response.header.{name}, where
name is a valid, unique header name. Destinations specified
here are available to the integration for mapping from integration
response parameters.
Map<K,V> responseModels
Boolean metricsEnabled
Specifies whether Amazon CloudWatch metrics are enabled for this method.
The PATCH path for this setting is
/{method_setting_key}/metrics/enabled, and the value is a
Boolean.
String loggingLevel
Specifies the logging level for this method, which effects the log
entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting
is /{method_setting_key}/logging/loglevel, and the available
levels are OFF, ERROR, and INFO.
Boolean dataTraceEnabled
Specifies the whether data trace logging is enabled for this method,
which effects the log entries pushed to Amazon CloudWatch Logs. The PATCH
path for this setting is
/{method_setting_key}/logging/dataTrace, and the value is a
Boolean.
Integer throttlingBurstLimit
Specifies the throttling burst limit. The PATCH path for this setting is
/{method_setting_key}/throttling/burstLimit, and the value
is an integer.
Double throttlingRateLimit
Specifies the throttling rate limit. The PATCH path for this setting is
/{method_setting_key}/throttling/rateLimit, and the value is
a double.
Boolean cachingEnabled
Specifies whether responses should be cached and returned for requests. A
cache cluster must be enabled on the stage for responses to be cached.
The PATCH path for this setting is
/{method_setting_key}/caching/enabled, and the value is a
Boolean.
Integer cacheTtlInSeconds
Specifies the time to live (TTL) in seconds, for cached responses. The
higher a the TTL, the longer the response will be cached. The PATCH path
for this setting is
/{method_setting_key}/caching/ttlInSeconds, and the value is
an integer.
Boolean cacheDataEncrypted
Specifies whether the cached responses are encrypted. The PATCH path for
this setting is /{method_setting_key}/caching/dataEncrypted,
and the value is a Boolean.
String id
The identifier for the model resource.
String name
The name of the model.
String description
The description of the model.
String schema
The schema for the model. For application/json models, this
should be JSON-schema draft v4
model.
String contentType
The content-type for the model.
String op
A patch operation whose value indicates the operation to perform. Its value MUST be one of "add", "remove", "replace", "move", "copy", or "test"; other values are errors.
String path
Operation objects MUST have exactly one "path" member. That member's value is a string containing a `JSON-Pointer` value that references a location within the target document (the "target location") where the operation is performed.
String value
The actual value content.
String from
The "move" and "copy" operation object MUST contain a "from" member,
which is a string containing a JSON Pointer value that
references the location in the target document to move the value from.
String restApiId
Specifies a put integration request's API identifier.
String resourceId
Specifies a put integration request's resource ID.
String httpMethod
Specifies a put integration request's HTTP method.
String type
Specifies a put integration input's type.
String integrationHttpMethod
Specifies a put integration HTTP method.
String uri
Specifies a put integration input's Uniform Resource Identifier (URI).
String credentials
Specifies whether credentials are required for a put integration.
Map<K,V> requestParameters
Represents request parameters that are sent with the backend request.
Request parameters are represented as a key/value map, with a destination
as the key and a source as the value. A source must match an existing
method request parameter, or a static value. Static values must be
enclosed with single quotes, and be pre-encoded based on their
destination in the request. The destination must match the pattern
integration.request.{location}.{name}, where
location is either querystring, path, or header.
name must be a valid, unique parameter name.
Map<K,V> requestTemplates
Specifies the templates used to transform the method request body. Request templates are represented as a key/value map, with a content-type as the key and a template as the value.
String cacheNamespace
Specifies a put integration input's cache namespace.
List<E> cacheKeyParameters
Specifies a put integration input's cache key parameters.
String restApiId
Specifies a put integration response request's API identifier.
String resourceId
Specifies a put integration response request's resource identifier.
String httpMethod
Specifies a put integration response request's HTTP method.
String statusCode
Specifies the status code that is used to map the integration response to an existing MethodResponse.
String selectionPattern
Specifies the selection pattern of a put integration response.
Map<K,V> responseParameters
Represents response parameters that can be read from the backend
response. Response parameters are represented as a key/value map, with a
destination as the key and a source as the value. A destination must
match an existing response parameter in the Method. The source can
be a header from the backend response, or a static value. Static values
are specified using enclosing single quotes, and backend response headers
can be read using the pattern
integration.response.header.{name}.
Map<K,V> responseTemplates
Specifies a put integration response's templates.
String statusCode
Specifies the status code that is used to map the integration response to an existing MethodResponse.
String selectionPattern
Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the backend. If the backend is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS backends, the HTTP status code is matched.
Map<K,V> responseParameters
Represents response parameters that can be read from the backend
response. Response parameters are represented as a key/value map, with a
destination as the key and a source as the value. A destination must
match an existing response parameter in the Method. The source can
be a header from the backend response, or a static value. Static values
are specified using enclosing single quotes, and backend response headers
can be read using the pattern
integration.response.header.{name}.
Map<K,V> responseTemplates
Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
String type
Specifies the integration's type.
String httpMethod
Specifies the integration's HTTP method type.
String uri
Specifies the integration's Uniform Resource Identifier (URI). For HTTP
integrations, the URI must be a fully formed, encoded HTTP(S) URL
according to the RFC-3986 specification.
For AWS integrations, the URI should be of the form
arn:aws:apigateway:{region}:{service}:{path|action}/{service_api}. Region and service are used to determine the
right endpoint. For AWS services that use the Action= query
string parameter, service_api should be a valid action for
the desired service. For RESTful AWS service APIs, path is
used to indicate that the remaining substring in the URI should be
treated as the path to the resource, including the initial /
.
String credentials
Specifies the credentials required for the integration, if any. For AWS
integrations, three options are available. To specify an IAM Role for
Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN).
To require that the caller's identity be passed through from the request,
specify the string arn:aws:iam::\*:user/\*. To use
resource-based permissions on supported AWS services, specify null.
Map<K,V> requestParameters
Represents requests parameters that are sent with the backend request.
Request parameters are represented as a key/value map, with a destination
as the key and a source as the value. A source must match an existing
method request parameter, or a static value. Static values must be
enclosed with single quotes, and be pre-encoded based on their
destination in the request. The destination must match the pattern
integration.request.{location}.{name}, where
location is either querystring, path, or header.
name must be a valid, unique parameter name.
Map<K,V> requestTemplates
Specifies the integration's request templates.
String cacheNamespace
Specifies the integration's cache namespace.
List<E> cacheKeyParameters
Specifies the integration's cache key parameters.
Map<K,V> integrationResponses
Specifies the integration's responses.
String restApiId
String resourceId
String httpMethod
Specifies the put method request's HTTP method type.
String authorizationType
Specifies the type of authorization used for the method.
Boolean apiKeyRequired
Specifies whether the method required a valid ApiKey.
Map<K,V> requestParameters
Represents requests parameters that are sent with the backend request.
Request parameters are represented as a key/value map, with a destination
as the key and a source as the value. A source must match an existing
method request parameter, or a static value. Static values must be
enclosed with single quotes, and be pre-encoded based on their
destination in the request. The destination must match the pattern
integration.request.{location}.{name}, where
location is either querystring, path, or header.
name must be a valid, unique parameter name.
Map<K,V> requestModels
String restApiId
String resourceId
String httpMethod
The HTTP verb that identifies the Method resource.
String statusCode
The method response's status code.
Map<K,V> responseParameters
Represents response parameters that can be sent back to the caller by
Amazon API Gateway. Response parameters are represented as a key/value
map, with a destination as the key and a Boolean flag as the value. The
Boolean flag is used to specify whether the parameter is required. A
destination must match the pattern
method.response.header.{name}, where name is a
valid, unique header name. Destinations specified here are available to
the integration for mapping from integration response parameters.
Map<K,V> responseModels
String statusCode
The method response's status code.
Map<K,V> responseParameters
Represents response parameters that can be sent back to the caller by
Amazon API Gateway. Response parameters are represented as a key/value
map, with a destination as the key and a boolean flag as the value, which
is used to specify whether the parameter is required. A destination must
match the pattern method.response.header.{name}, where
name is a valid, unique header name. Destinations specified
here are available to the integration for mapping from integration
response parameters.
Map<K,V> responseModels
String httpMethod
The HTTP method.
String authorizationType
The method's authorization type.
Boolean apiKeyRequired
Specifies whether the method requires a valid ApiKey.
Map<K,V> requestParameters
Represents request parameters that can be accepted by Amazon API Gateway.
Request parameters are represented as a key/value map, with a source as
the key and a Boolean flag as the value. The Boolean flag is used to
specify whether the parameter is required. A source must match the
pattern method.request.{location}.{name}, where
location is either querystring, path, or header.
name is a valid, unique parameter name. Sources specified
here are available to the integration for mapping to integration request
parameters or templates.
Map<K,V> requestModels
Map<K,V> methodResponses
Represents available responses that can be sent to the caller. Method responses are represented as a key/value map, with an HTTP status code as the key and a MethodResponse as the value. The status codes are available for the Integration responses to map to.
Integration methodIntegration
The method's integration.
String id
The resource's identifier.
String parentId
The parent resource's identifier.
String pathPart
The last path segment for this resource.
String path
The full path for this resource.
Map<K,V> resourceMethods
Map of methods for this resource, which is included only if requested using the embed option.
String id
The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
String name
The API's name.
String description
The API's description.
Date createdDate
The date when the API was created, in ISO 8601 format.
String retryAfterSeconds
String deploymentId
The identifier of the Deployment that the stage points to.
String clientCertificateId
String stageName
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.
String description
The stage's description.
Boolean cacheClusterEnabled
Specifies whether a cache cluster is enabled for the stage.
String cacheClusterSize
The size of the cache cluster for the stage, if enabled.
String cacheClusterStatus
The status of the cache cluster for the stage, if enabled.
Map<K,V> methodSettings
A map that defines the method settings for a Stage resource. Keys
are defined as {resource_path}/{http_method} for an
individual method override, or \*/\* for the settings
applied to all methods in the stage.
Map<K,V> variables
A map that defines the stage variables for a Stage resource. Variable names can have alphabetic characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+
Date createdDate
The date and time that the stage was created, in ISO 8601 format.
Date lastUpdatedDate
The date and time that information about the stage was last updated, in ISO 8601 format.
String retryAfterSeconds
String cloudwatchRoleArn
Specifies the Amazon resource name (ARN) of an Amazon CloudWatch role for the current Account resource.
ThrottleSettings throttleSettings
Specifies the application programming interface (API) throttle settings for the current Account resource.
String id
The identifier of the API Key.
String name
The name of the API Key.
String description
The description of the API Key.
Boolean enabled
Specifies whether the API Key can be used by callers.
List<E> stageKeys
Date createdDate
The date when the API Key was created, in ISO 8601 format.
Date lastUpdatedDate
When the API Key was last updated, in ISO 8601 format.
String domainName
The domain name of the BasePathMapping resource to change.
String basePath
The base path of the BasePathMapping resource to change.
List<E> patchOperations
A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
String restApiId
The replacement identifier of the RestApi resource for the Deployment resource to change information about.
String deploymentId
The replacment identifier for the Deployment resource to change information about.
List<E> patchOperations
A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
String id
The identifier for the deployment resource.
String description
The description for the deployment resource.
Date createdDate
The date and time that the deployment resource was created.
Map<K,V> apiSummary
Gets a summary of the RestApi at the date and time that the deployment resource was created.
String domainName
The name of the DomainName resource to be changed.
List<E> patchOperations
A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
String domainName
The name of the DomainName resource.
String certificateName
The name of the certificate.
Date certificateUploadDate
The date when the certificate was uploaded, in ISO 8601 format.
String distributionDomainName
The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.
String restApiId
Represents an update integration request's API identifier.
String resourceId
Represents an update integration request's resource identifier.
String httpMethod
Represents an update integration request's HTTP method.
List<E> patchOperations
A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
String restApiId
Specifies an update integration response request's API identifier.
String resourceId
Specifies an update integration response request's resource identifier.
String httpMethod
Specifies an update integration response request's HTTP method.
String statusCode
Specifies an update integration response request's status code.
List<E> patchOperations
A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
String statusCode
Specifies the status code that is used to map the integration response to an existing MethodResponse.
String selectionPattern
Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the backend. If the backend is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS backends, the HTTP status code is matched.
Map<K,V> responseParameters
Represents response parameters that can be read from the backend
response. Response parameters are represented as a key/value map, with a
destination as the key and a source as the value. A destination must
match an existing response parameter in the Method. The source can
be a header from the backend response, or a static value. Static values
are specified using enclosing single quotes, and backend response headers
can be read using the pattern
integration.response.header.{name}.
Map<K,V> responseTemplates
Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
String type
Specifies the integration's type.
String httpMethod
Specifies the integration's HTTP method type.
String uri
Specifies the integration's Uniform Resource Identifier (URI). For HTTP
integrations, the URI must be a fully formed, encoded HTTP(S) URL
according to the RFC-3986 specification.
For AWS integrations, the URI should be of the form
arn:aws:apigateway:{region}:{service}:{path|action}/{service_api}. Region and service are used to determine the
right endpoint. For AWS services that use the Action= query
string parameter, service_api should be a valid action for
the desired service. For RESTful AWS service APIs, path is
used to indicate that the remaining substring in the URI should be
treated as the path to the resource, including the initial /
.
String credentials
Specifies the credentials required for the integration, if any. For AWS
integrations, three options are available. To specify an IAM Role for
Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN).
To require that the caller's identity be passed through from the request,
specify the string arn:aws:iam::\*:user/\*. To use
resource-based permissions on supported AWS services, specify null.
Map<K,V> requestParameters
Represents requests parameters that are sent with the backend request.
Request parameters are represented as a key/value map, with a destination
as the key and a source as the value. A source must match an existing
method request parameter, or a static value. Static values must be
enclosed with single quotes, and be pre-encoded based on their
destination in the request. The destination must match the pattern
integration.request.{location}.{name}, where
location is either querystring, path, or header.
name must be a valid, unique parameter name.
Map<K,V> requestTemplates
Specifies the integration's request templates.
String cacheNamespace
Specifies the integration's cache namespace.
List<E> cacheKeyParameters
Specifies the integration's cache key parameters.
Map<K,V> integrationResponses
Specifies the integration's responses.
String restApiId
String resourceId
String httpMethod
The HTTP verb that identifies the Method resource.
List<E> patchOperations
A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
String restApiId
The RestApi identifier for the MethodResponse resource.
String resourceId
The Resource identifier for the MethodResponse resource.
String httpMethod
The HTTP verb identifier for the parent Method resource.
String statusCode
The status code identifier for the MethodResponse resource.
List<E> patchOperations
A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
String statusCode
The method response's status code.
Map<K,V> responseParameters
Represents response parameters that can be sent back to the caller by
Amazon API Gateway. Response parameters are represented as a key/value
map, with a destination as the key and a boolean flag as the value, which
is used to specify whether the parameter is required. A destination must
match the pattern method.response.header.{name}, where
name is a valid, unique header name. Destinations specified
here are available to the integration for mapping from integration
response parameters.
Map<K,V> responseModels
String httpMethod
The HTTP method.
String authorizationType
The method's authorization type.
Boolean apiKeyRequired
Specifies whether the method requires a valid ApiKey.
Map<K,V> requestParameters
Represents request parameters that can be accepted by Amazon API Gateway.
Request parameters are represented as a key/value map, with a source as
the key and a Boolean flag as the value. The Boolean flag is used to
specify whether the parameter is required. A source must match the
pattern method.request.{location}.{name}, where
location is either querystring, path, or header.
name is a valid, unique parameter name. Sources specified
here are available to the integration for mapping to integration request
parameters or templates.
Map<K,V> requestModels
Map<K,V> methodResponses
Represents available responses that can be sent to the caller. Method responses are represented as a key/value map, with an HTTP status code as the key and a MethodResponse as the value. The status codes are available for the Integration responses to map to.
Integration methodIntegration
The method's integration.
String restApiId
The RestApi identifier under which the model exists.
String modelName
The name of the model to update.
List<E> patchOperations
A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
String id
The identifier for the model resource.
String name
The name of the model.
String description
The description of the model.
String schema
The schema for the model. For application/json models, this
should be JSON-schema draft v4
model.
String contentType
The content-type for the model.
String id
The resource's identifier.
String parentId
The parent resource's identifier.
String pathPart
The last path segment for this resource.
String path
The full path for this resource.
Map<K,V> resourceMethods
Map of methods for this resource, which is included only if requested using the embed option.
String id
The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
String name
The API's name.
String description
The API's description.
Date createdDate
The date when the API was created, in ISO 8601 format.
String deploymentId
The identifier of the Deployment that the stage points to.
String clientCertificateId
String stageName
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.
String description
The stage's description.
Boolean cacheClusterEnabled
Specifies whether a cache cluster is enabled for the stage.
String cacheClusterSize
The size of the cache cluster for the stage, if enabled.
String cacheClusterStatus
The status of the cache cluster for the stage, if enabled.
Map<K,V> methodSettings
A map that defines the method settings for a Stage resource. Keys
are defined as {resource_path}/{http_method} for an
individual method override, or \*/\* for the settings
applied to all methods in the stage.
Map<K,V> variables
A map that defines the stage variables for a Stage resource. Variable names can have alphabetic characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+
Date createdDate
The date and time that the stage was created, in ISO 8601 format.
Date lastUpdatedDate
The date and time that information about the stage was last updated, in ISO 8601 format.
String activityId
The ID of the activity.
String autoScalingGroupName
The name of the Auto Scaling group.
String description
A friendly, more verbose description of the activity.
String cause
The reason the activity began.
Date startTime
The start time of the activity.
Date endTime
The end time of the activity.
String statusCode
The current status of the activity.
String statusMessage
A friendly, more verbose description of the activity status.
Integer progress
A value between 0 and 100 that indicates the progress of the activity.
String details
The details about the activity.
String adjustmentType
The policy adjustment type. The valid values are
ChangeInCapacity, ExactCapacity, and
PercentChangeInCapacity.
com.amazonaws.internal.SdkInternalList<T> instanceIds
One or more EC2 instance IDs.
String autoScalingGroupName
The name of the group.
String autoScalingGroupName
The name of the group.
com.amazonaws.internal.SdkInternalList<T> loadBalancerNames
One or more load balancer names.
String autoScalingGroupName
The name of the group.
String autoScalingGroupARN
The Amazon Resource Name (ARN) of the group.
String launchConfigurationName
The name of the associated launch configuration.
Integer minSize
The minimum size of the group.
Integer maxSize
The maximum size of the group.
Integer desiredCapacity
The desired size of the group.
Integer defaultCooldown
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.
com.amazonaws.internal.SdkInternalList<T> availabilityZones
One or more Availability Zones for the group.
com.amazonaws.internal.SdkInternalList<T> loadBalancerNames
One or more load balancers associated with the group.
String healthCheckType
The service to use for the health checks. The valid values are
EC2 and ELB.
Integer healthCheckGracePeriod
The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service.
com.amazonaws.internal.SdkInternalList<T> instances
The EC2 instances associated with the group.
Date createdTime
The date and time the group was created.
com.amazonaws.internal.SdkInternalList<T> suspendedProcesses
The suspended processes associated with the group.
String placementGroup
The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.
String vPCZoneIdentifier
One or more subnet IDs, if applicable, separated by commas.
If you specify VPCZoneIdentifier and
AvailabilityZones, ensure that the Availability Zones of the
subnets match the values for AvailabilityZones.
com.amazonaws.internal.SdkInternalList<T> enabledMetrics
The metrics enabled for the group.
String status
The current state of the group when DeleteAutoScalingGroup is in progress.
com.amazonaws.internal.SdkInternalList<T> tags
The tags for the group.
com.amazonaws.internal.SdkInternalList<T> terminationPolicies
The termination policies for the group.
Boolean newInstancesProtectedFromScaleIn
Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
String instanceId
The ID of the instance.
String autoScalingGroupName
The name of the Auto Scaling group associated with the instance.
String availabilityZone
The Availability Zone for the instance.
String lifecycleState
The lifecycle state for the instance. For more information, see Auto Scaling Instance States in the Auto Scaling Developer Guide.
String healthStatus
The health status of this instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and Auto Scaling should terminate and replace it.
String launchConfigurationName
The launch configuration associated with the instance.
Boolean protectedFromScaleIn
Indicates whether the instance is protected from termination by Auto Scaling when scaling in.
String virtualName
The name of the virtual device (for example, ephemeral0).
String deviceName
The device name exposed to the EC2 instance (for example,
/dev/sdh or xvdh).
Ebs ebs
The information about the Amazon EBS volume.
Boolean noDevice
Suppresses a device mapping.
If this parameter is true for the root device, the instance might fail the EC2 health check. Auto Scaling launches a replacement instance if the instance fails the health check.
String lifecycleHookName
The name of the lifecycle hook.
String autoScalingGroupName
The name of the group for the lifecycle hook.
String lifecycleActionToken
A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.
String lifecycleActionResult
The action for the group to take. This parameter can be either
CONTINUE or ABANDON.
String autoScalingGroupName
The name of the group. This name must be unique within the scope of your AWS account.
String launchConfigurationName
The name of the launch configuration. Alternatively, use the
InstanceId parameter to specify an EC2 instance instead of a
launch configuration.
String instanceId
The ID of the EC2 instance used to create a launch configuration for the
group. Alternatively, use the LaunchConfigurationName
parameter to specify a launch configuration instead of an EC2 instance.
When you specify an ID of an instance, Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.
For more information, see Create an Auto Scaling Group from an EC2 Instance in the Auto Scaling Developer Guide.
Integer minSize
The minimum size of the group.
Integer maxSize
The maximum size of the group.
Integer desiredCapacity
The number of EC2 instances that should be running in the group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.
Integer defaultCooldown
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.
For more information, see Understanding Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
com.amazonaws.internal.SdkInternalList<T> availabilityZones
One or more Availability Zones for the group. This parameter is optional
if you specify subnets using the VPCZoneIdentifier
parameter.
com.amazonaws.internal.SdkInternalList<T> loadBalancerNames
One or more load balancers.
For more information, see Load Balance Your Auto Scaling Group in the Auto Scaling Developer Guide.
String healthCheckType
The service to use for the health checks. The valid values are
EC2 and ELB.
By default, health checks use Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Checks in the Auto Scaling Developer Guide.
Integer healthCheckGracePeriod
The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default is 300.
This parameter is required if you are adding an ELB health
check.
For more information, see Health Checks for Auto Scaling Instances in the Auto Scaling Developer Guide.
String placementGroup
The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.
String vPCZoneIdentifier
A comma-separated list of subnet identifiers for your virtual private cloud (VPC).
If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.
For more information, see Auto Scaling and Amazon Virtual Private Cloud in the Auto Scaling Developer Guide.
com.amazonaws.internal.SdkInternalList<T> terminationPolicies
One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.
For more information, see Choosing a Termination Policy for Your Auto Scaling Group in the Auto Scaling Developer Guide.
Boolean newInstancesProtectedFromScaleIn
Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
com.amazonaws.internal.SdkInternalList<T> tags
The tag to be created or updated. Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. Valid values: key=value, value=value, propagate=true or false. Value and propagate are optional parameters.
For more information, see Tagging Auto Scaling Groups and Instances in the Auto Scaling Developer Guide.
String launchConfigurationName
The name of the launch configuration. This name must be unique within the scope of your AWS account.
String imageId
The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see Finding an AMI in the Amazon Elastic Compute Cloud User Guide.
String keyName
The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon Elastic Compute Cloud User Guide.
com.amazonaws.internal.SdkInternalList<T> securityGroups
One or more security groups with which to associate the instances.
If your instances are launched in EC2-Classic, you can either specify security group names or the security group IDs. For more information about security groups for EC2-Classic, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide.
If your instances are launched into a VPC, specify security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
String classicLinkVPCId
The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter is supported only if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
com.amazonaws.internal.SdkInternalList<T> classicLinkVPCSecurityGroups
The IDs of one or more security groups for the VPC specified in
ClassicLinkVPCId. This parameter is required if
ClassicLinkVPCId is specified, and is not supported
otherwise. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
String userData
The user data to make available to the launched EC2 instances. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide.
At this time, launch configurations don't support compressed (zipped) user data files.
String instanceId
The ID of the EC2 instance to use to create the launch configuration.
The new launch configuration derives attributes from the instance, with the exception of the block device mapping.
To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.
For more information, see Create a Launch Configuration Using an EC2 Instance in the Auto Scaling Developer Guide.
String instanceType
The instance type of the EC2 instance. For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.
String kernelId
The ID of the kernel associated with the AMI.
String ramdiskId
The ID of the RAM disk associated with the AMI.
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
One or more mappings that specify how block devices are exposed to the instance. For more information, see Block Device Mapping in the Amazon Elastic Compute Cloud User Guide.
InstanceMonitoring instanceMonitoring
Enables detailed monitoring if it is disabled. Detailed monitoring is enabled by default.
When detailed monitoring is enabled, Amazon CloudWatch generates metrics
every minute and your account is charged a fee. When you disable detailed
monitoring, by specifying False, CloudWatch generates
metrics every 5 minutes. For more information, see Monitor Your Auto Scaling Instances in the Auto Scaling Developer
Guide.
String spotPrice
The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. For more information, see Launch Spot Instances in Your Auto Scaling Group in the Auto Scaling Developer Guide.
String iamInstanceProfile
The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.
EC2 instances launched with an IAM role will automatically have AWS security credentials available. You can use IAM roles with Auto Scaling to automatically enable applications running on your EC2 instances to securely access other AWS resources. For more information, see Launch Auto Scaling Instances with an IAM Role in the Auto Scaling Developer Guide.
Boolean ebsOptimized
Indicates whether the instance is optimized for Amazon EBS I/O. By default, the instance is not optimized for EBS I/O. The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional usage charges apply. For more information, see Amazon EBS-Optimized Instances in the Amazon Elastic Compute Cloud User Guide.
Boolean associatePublicIpAddress
Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see Auto Scaling and Amazon Virtual Private Cloud in the Auto Scaling Developer Guide.
If you specify a value for this parameter, be sure to specify at least one subnet using the VPCZoneIdentifier parameter when you create your group.
Default: If the instance is launched into a default subnet, the default
is true. If the instance is launched into a nondefault
subnet, the default is false. For more information, see Supported Platforms in the Amazon Elastic Compute Cloud User
Guide.
String placementTenancy
The tenancy of the instance. An instance with a tenancy of
dedicated runs on single-tenant hardware and can only be
launched into a VPC.
You must set the value of this parameter to dedicated if
want to launch Dedicated Instances into a shared tenancy VPC (VPC with
instance placement tenancy attribute set to default).
If you specify a value for this parameter, be sure to specify at least one subnet using the VPCZoneIdentifier parameter when you create your group.
For more information, see Auto Scaling and Amazon Virtual Private Cloud in the Auto Scaling Developer Guide.
Valid values: default | dedicated
com.amazonaws.internal.SdkInternalList<T> tags
One or more tags.
String autoScalingGroupName
The name of the group to delete.
Boolean forceDelete
Specifies that the group will be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions associated with the group.
String launchConfigurationName
The name of the launch configuration.
com.amazonaws.internal.SdkInternalList<T> tags
Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. Valid values are: Resource type = auto-scaling-group, Resource ID = AutoScalingGroupName, key=value, value=value, propagate=true or false.
Integer maxNumberOfAutoScalingGroups
The maximum number of groups allowed for your AWS account. The default limit is 20 per region.
Integer maxNumberOfLaunchConfigurations
The maximum number of launch configurations allowed for your AWS account. The default limit is 100 per region.
Integer numberOfAutoScalingGroups
The current number of groups for your AWS account.
Integer numberOfLaunchConfigurations
The current number of launch configurations for your AWS account.
com.amazonaws.internal.SdkInternalList<T> adjustmentTypes
The policy adjustment types.
com.amazonaws.internal.SdkInternalList<T> autoScalingGroupNames
The group names.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxRecords
The maximum number of items to return with this call.
com.amazonaws.internal.SdkInternalList<T> autoScalingGroups
The groups.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
com.amazonaws.internal.SdkInternalList<T> instanceIds
One or more Auto Scaling instances to describe, up to 50 instances. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.
Integer maxRecords
The maximum number of items to return with this call.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> autoScalingInstances
The instances.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
com.amazonaws.internal.SdkInternalList<T> autoScalingNotificationTypes
One or more of the following notification types:
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
com.amazonaws.internal.SdkInternalList<T> launchConfigurationNames
The launch configuration names.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxRecords
The maximum number of items to return with this call. The default is 100.
com.amazonaws.internal.SdkInternalList<T> launchConfigurations
The launch configurations.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String autoScalingGroupName
The name of the group.
com.amazonaws.internal.SdkInternalList<T> lifecycleHookNames
The names of one or more lifecycle hooks.
com.amazonaws.internal.SdkInternalList<T> lifecycleHooks
The lifecycle hooks for the specified group.
com.amazonaws.internal.SdkInternalList<T> lifecycleHookTypes
One or more of the following notification types:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
com.amazonaws.internal.SdkInternalList<T> loadBalancers
The load balancers.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
com.amazonaws.internal.SdkInternalList<T> metrics
One or more metrics.
com.amazonaws.internal.SdkInternalList<T> granularities
The granularities for the metrics.
com.amazonaws.internal.SdkInternalList<T> autoScalingGroupNames
The name of the group.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxRecords
The maximum number of items to return with this call.
com.amazonaws.internal.SdkInternalList<T> notificationConfigurations
The notification configurations.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String autoScalingGroupName
The name of the group.
com.amazonaws.internal.SdkInternalList<T> policyNames
One or more policy names or policy ARNs to be described. If you omit this list, all policy names are described. If an group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.
com.amazonaws.internal.SdkInternalList<T> policyTypes
One or more policy types. Valid values are SimpleScaling and
StepScaling.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxRecords
The maximum number of items to be returned with each call.
com.amazonaws.internal.SdkInternalList<T> scalingPolicies
The scaling policies.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
com.amazonaws.internal.SdkInternalList<T> activityIds
The activity IDs of the desired scaling activities. If this list is
omitted, all activities are described. If the
AutoScalingGroupName parameter is provided, the results are
limited to that group. The list of requested activities cannot contain
more than 50 items. If unknown activities are requested, they are ignored
with no error.
String autoScalingGroupName
The name of the group.
Integer maxRecords
The maximum number of items to return with this call.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> activities
The scaling activities.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
com.amazonaws.internal.SdkInternalList<T> processes
The names of the process types.
String autoScalingGroupName
The name of the group.
com.amazonaws.internal.SdkInternalList<T> scheduledActionNames
Describes one or more scheduled actions. If you omit this list, the call describes all scheduled actions. If you specify an unknown scheduled action it is ignored with no error.
You can describe up to a maximum of 50 instances with a single call. If
there are more items to return, the call returns a token. To get the next
set of items, repeat the call with the returned token in the
NextToken parameter.
Date startTime
The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
Date endTime
The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxRecords
The maximum number of items to return with this call.
com.amazonaws.internal.SdkInternalList<T> scheduledUpdateGroupActions
The scheduled actions.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
com.amazonaws.internal.SdkInternalList<T> filters
A filter used to scope the tags to return.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxRecords
The maximum number of items to return with this call.
com.amazonaws.internal.SdkInternalList<T> tags
The tags.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
com.amazonaws.internal.SdkInternalList<T> terminationPolicyTypes
The termination policies supported by Auto Scaling (
OldestInstance, OldestLaunchConfiguration,
NewestInstance, ClosestToNextInstanceHour, and
Default).
com.amazonaws.internal.SdkInternalList<T> instanceIds
One or more instance IDs.
String autoScalingGroupName
The name of the group.
Boolean shouldDecrementDesiredCapacity
If True, the Auto Scaling group decrements the desired
capacity value by the number of instances detached.
com.amazonaws.internal.SdkInternalList<T> activities
The activities related to detaching the instances from the Auto Scaling group.
String autoScalingGroupName
The name of the group.
com.amazonaws.internal.SdkInternalList<T> loadBalancerNames
One or more load balancer names.
String autoScalingGroupName
The name or Amazon Resource Name (ARN) of the group.
com.amazonaws.internal.SdkInternalList<T> metrics
One or more of the following metrics. If you omit this parameter, all metrics are disabled.
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
String snapshotId
The ID of the snapshot.
Integer volumeSize
The volume size, in gigabytes.
Valid values: If the volume type is io1, the minimum size of
the volume is 10 GiB. If you specify SnapshotId and
VolumeSize, VolumeSize must be equal to or
larger than the size of the snapshot.
Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the size of the snapshot.
Required: Required when the volume type is io1.
String volumeType
The volume type.
Valid values: standard | io1 | gp2
Default: standard
Boolean deleteOnTermination
Indicates whether to delete the volume on instance termination.
Default: true
Integer iops
For Provisioned IOPS (SSD) volumes only. The number of I/O operations per second (IOPS) to provision for the volume.
Default: None
Boolean encrypted
Indicates whether the volume should be encrypted. Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or an unencrypted volume from an encrypted snapshot. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
String metric
One of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
String granularity
The granularity of the metric. The only valid value is
1Minute.
String autoScalingGroupName
The name or ARN of the Auto Scaling group.
com.amazonaws.internal.SdkInternalList<T> metrics
One or more of the following metrics. If you omit this parameter, all metrics are enabled.
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
Note that the GroupStandbyInstances metric is not enabled by
default. You must explicitly request this metric.
String granularity
The granularity to associate with the metrics to collect. The only valid
value is 1Minute.
com.amazonaws.internal.SdkInternalList<T> instanceIds
One or more instances to move into Standby mode. You must
specify at least one instance ID.
String autoScalingGroupName
The name of the Auto Scaling group.
Boolean shouldDecrementDesiredCapacity
Specifies whether the instances moved to Standby mode count
as part of the Auto Scaling group's desired capacity. If set, the desired
capacity for the Auto Scaling group decrements by the number of instances
moved to Standby mode.
com.amazonaws.internal.SdkInternalList<T> activities
The activities related to moving instances into Standby
mode.
String autoScalingGroupName
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
String policyName
The name or ARN of the policy.
Boolean honorCooldown
If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy. Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to complete.
This parameter is not supported if the policy type is
StepScaling.
For more information, see Understanding Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
Double metricValue
The metric value to compare to BreachThreshold. This enables
you to execute a policy of type StepScaling and determine
which step adjustment to use. For example, if the breach threshold is 50
and you want to use a step adjustment with a lower bound of 0 and an
upper bound of 10, you can set the metric value to 59.
If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.
This parameter is required if the policy type is StepScaling
and not supported otherwise.
Double breachThreshold
The breach threshold for the alarm.
This parameter is required if the policy type is StepScaling
and not supported otherwise.
com.amazonaws.internal.SdkInternalList<T> instanceIds
One or more instance IDs. You must specify at least one instance ID.
String autoScalingGroupName
The name of the Auto Scaling group.
com.amazonaws.internal.SdkInternalList<T> activities
The activities related to moving instances out of Standby
mode.
String name
The name of the filter. The valid values are:
"auto-scaling-group", "key",
"value", and "propagate-at-launch".
com.amazonaws.internal.SdkInternalList<T> values
The value of the filter.
String instanceId
The ID of the instance.
String availabilityZone
The Availability Zone in which the instance is running.
String lifecycleState
A description of the current lifecycle state. Note that the
Quarantined state is not used.
String healthStatus
The health status of the instance.
String launchConfigurationName
The launch configuration associated with the instance.
Boolean protectedFromScaleIn
Indicates whether the instance is protected from termination by Auto Scaling when scaling in.
Boolean enabled
If True, instance monitoring is enabled.
String launchConfigurationName
The name of the launch configuration.
String launchConfigurationARN
The Amazon Resource Name (ARN) of the launch configuration.
String imageId
The ID of the Amazon Machine Image (AMI).
String keyName
The name of the key pair.
com.amazonaws.internal.SdkInternalList<T> securityGroups
The security groups to associate with the instances.
String classicLinkVPCId
The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter can only be used if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
com.amazonaws.internal.SdkInternalList<T> classicLinkVPCSecurityGroups
The IDs of one or more security groups for the VPC specified in
ClassicLinkVPCId. This parameter is required if
ClassicLinkVPCId is specified, and cannot be used otherwise.
For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
String userData
The user data available to the instances.
String instanceType
The instance type for the instances.
String kernelId
The ID of the kernel associated with the AMI.
String ramdiskId
The ID of the RAM disk associated with the AMI.
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
A block device mapping, which specifies the block devices for the instance.
InstanceMonitoring instanceMonitoring
Controls whether instances in this group are launched with detailed monitoring.
String spotPrice
The price to bid when launching Spot Instances.
String iamInstanceProfile
The name or Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.
Date createdTime
The creation date and time for the launch configuration.
Boolean ebsOptimized
Controls whether the instance is optimized for EBS I/O (true
) or not (false).
Boolean associatePublicIpAddress
[EC2-VPC] Indicates whether to assign a public IP address to each instance.
String placementTenancy
The tenancy of the instance, either default or
dedicated. An instance with dedicated tenancy
runs in an isolated, single-tenant hardware and can only be launched into
a VPC.
String lifecycleHookName
The name of the lifecycle hook.
String autoScalingGroupName
The name of the Auto Scaling group for the lifecycle hook.
String lifecycleTransition
The state of the EC2 instance to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.
String notificationTargetARN
The ARN of the notification target that Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic. The notification message sent to the target includes the following:
String roleARN
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
String notificationMetadata
Additional information that you want to include any time Auto Scaling sends a message to the notification target.
Integer heartbeatTimeout
The maximum time, in seconds, that can elapse before the lifecycle hook
times out. The default is 3600 seconds (1 hour). When the lifecycle hook
times out, Auto Scaling performs the action defined in the
DefaultResult parameter. You can prevent the lifecycle hook
from timing out by calling RecordLifecycleActionHeartbeat.
Integer globalTimeout
The maximum time, in seconds, that an instance can remain in a
Pending:Wait or Terminating:Wait state. The
default is 172800 seconds (48 hours).
String defaultResult
Defines the action the Auto Scaling group should take when the lifecycle
hook timeout elapses or if an unexpected failure occurs. The valid values
are CONTINUE and ABANDON. The default value is
CONTINUE.
String loadBalancerName
The name of the load balancer.
String state
One of the following load balancer states:
Adding - The instances in the group are being registered
with the load balancer.
Added - All instances in the group are registered with the
load balancer.
InService - At least one instance in the group passed an ELB
health check.
Removing - The instances are being deregistered from the
load balancer. If connection draining is enabled, Elastic Load Balancing
waits for in-flight requests to complete before deregistering the
instances.
String metric
One of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
String granularity
The granularity. The only valid value is 1Minute.
String autoScalingGroupName
The name of the group.
String topicARN
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
String notificationType
One of the following event notification types:
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
String processName
One of the following processes:
Launch
Terminate
AddToLoadBalancer
AlarmNotification
AZRebalance
HealthCheck
ReplaceUnhealthy
ScheduledActions
String lifecycleHookName
The name of the lifecycle hook.
String autoScalingGroupName
The name of the Auto Scaling group to which you want to assign the lifecycle hook.
String lifecycleTransition
The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
String roleARN
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
String notificationTargetARN
The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic.
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
The notification message sent to the target will include:
This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.
When you call this operation, a test message is sent to the notification
target. This test message contains an additional key/value pair:
Event:autoscaling:TEST_NOTIFICATION.
String notificationMetadata
Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.
Integer heartbeatTimeout
The amount of time, in seconds, that can elapse before the lifecycle hook
times out. When the lifecycle hook times out, Auto Scaling performs the
action defined in the DefaultResult parameter. You can
prevent the lifecycle hook from timing out by calling
RecordLifecycleActionHeartbeat. The default is 3600 seconds (1
hour).
String defaultResult
Defines the action the Auto Scaling group should take when the lifecycle
hook timeout elapses or if an unexpected failure occurs. The value for
this parameter can be either CONTINUE or
ABANDON. The default value for this parameter is
ABANDON.
String autoScalingGroupName
The name of the Auto Scaling group.
String topicARN
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
com.amazonaws.internal.SdkInternalList<T> notificationTypes
The type of event that will cause the notification to be sent. For details about notification types supported by Auto Scaling, see DescribeAutoScalingNotificationTypes.
String autoScalingGroupName
The name or ARN of the group.
String policyName
The name of the policy.
String policyType
The policy type. Valid values are SimpleScaling and
StepScaling. If the policy type is null, the value is
treated as SimpleScaling.
String adjustmentType
The adjustment type. Valid values are ChangeInCapacity,
ExactCapacity, and PercentChangeInCapacity.
For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.
Integer minAdjustmentStep
Available for backward compatibility. Use
MinAdjustmentMagnitude instead.
Integer minAdjustmentMagnitude
The minimum number of instances to scale. If the value of
AdjustmentType is PercentChangeInCapacity, the
scaling policy changes the DesiredCapacity of the Auto
Scaling group by at least this many instances. Otherwise, the error is
ValidationError.
Integer scalingAdjustment
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
This parameter is required if the policy type is
SimpleScaling and not supported otherwise.
Integer cooldown
The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.
This parameter is not supported unless the policy type is
SimpleScaling.
For more information, see Understanding Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
String metricAggregationType
The aggregation type for the CloudWatch metrics. Valid values are
Minimum, Maximum, and Average. If
the aggregation type is null, the value is treated as
Average.
This parameter is not supported if the policy type is
SimpleScaling.
com.amazonaws.internal.SdkInternalList<T> stepAdjustments
A set of adjustments that enable you to scale based on the size of the alarm breach.
This parameter is required if the policy type is StepScaling
and not supported otherwise.
Integer estimatedInstanceWarmup
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.
This parameter is not supported if the policy type is
SimpleScaling.
String policyARN
The Amazon Resource Name (ARN) of the policy.
String autoScalingGroupName
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
String scheduledActionName
The name of this scaling action.
Date time
This parameter is deprecated; use StartTime instead.
The time for this action to start. If both Time and
StartTime are specified, their values must be identical.
Date startTime
The time for this action to start, in "YYYY-MM-DDThh:mm:ssZ" format in
UTC/GMT only (for example, 2014-06-01T00:00:00Z).
If you try to schedule your action in the past, Auto Scaling returns an error message.
When StartTime and EndTime are specified with
Recurrence, they form the boundaries of when the recurring
action starts and stops.
Date endTime
The time for this action to end.
String recurrence
The time when recurring future actions will start. Start time is specified by the user following the Unix cron syntax format. For more information, see Cron in Wikipedia.
When StartTime and EndTime are specified with
Recurrence, they form the boundaries of when the recurring
action will start and stop.
Integer minSize
The minimum size for the Auto Scaling group.
Integer maxSize
The maximum size for the Auto Scaling group.
Integer desiredCapacity
The number of EC2 instances that should be running in the group.
String lifecycleHookName
The name of the lifecycle hook.
String autoScalingGroupName
The name of the Auto Scaling group for the hook.
String lifecycleActionToken
A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.
String autoScalingGroupName
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
com.amazonaws.internal.SdkInternalList<T> scalingProcesses
One or more of the following processes:
Launch
Terminate
HealthCheck
ReplaceUnhealthy
AZRebalance
AlarmNotification
ScheduledActions
AddToLoadBalancer
String autoScalingGroupName
The name of the Auto Scaling group associated with this scaling policy.
String policyName
The name of the scaling policy.
String policyARN
The Amazon Resource Name (ARN) of the policy.
String policyType
The policy type. Valid values are SimpleScaling and
StepScaling.
String adjustmentType
The adjustment type, which specifies how ScalingAdjustment
is interpreted. Valid values are ChangeInCapacity,
ExactCapacity, and PercentChangeInCapacity.
Integer minAdjustmentStep
Available for backward compatibility. Use
MinAdjustmentMagnitude instead.
Integer minAdjustmentMagnitude
The minimum number of instances to scale. If the value of
AdjustmentType is PercentChangeInCapacity, the
scaling policy changes the DesiredCapacity of the Auto
Scaling group by at least this many instances. Otherwise, the error is
ValidationError.
Integer scalingAdjustment
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
Integer cooldown
The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.
com.amazonaws.internal.SdkInternalList<T> stepAdjustments
A set of adjustments that enable you to scale based on the size of the alarm breach.
String metricAggregationType
The aggregation type for the CloudWatch metrics. Valid values are
Minimum, Maximum, and Average.
Integer estimatedInstanceWarmup
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
com.amazonaws.internal.SdkInternalList<T> alarms
The CloudWatch alarms related to the policy.
String autoScalingGroupName
The name of the group.
String scheduledActionName
The name of the scheduled action.
String scheduledActionARN
The Amazon Resource Name (ARN) of the scheduled action.
Date time
This parameter is deprecated; use StartTime instead.
Date startTime
The date and time that the action is scheduled to begin. This date and time can be up to one month in the future.
When StartTime and EndTime are specified with
Recurrence, they form the boundaries of when the recurring
action will start and stop.
Date endTime
The date and time that the action is scheduled to end. This date and time can be up to one month in the future.
String recurrence
The recurring schedule for the action.
Integer minSize
The minimum size of the group.
Integer maxSize
The maximum size of the group.
Integer desiredCapacity
The number of instances you prefer to maintain in the group.
String autoScalingGroupName
The name of the Auto Scaling group.
Integer desiredCapacity
The number of EC2 instances that should be running in the Auto Scaling group.
Boolean honorCooldown
By default, SetDesiredCapacity overrides any cooldown period
associated with the Auto Scaling group. Specify True to make
Auto Scaling to wait for the cool-down period associated with the Auto
Scaling group to complete before initiating a scaling activity to set
your Auto Scaling group to its new capacity.
String instanceId
The ID of the EC2 instance.
String healthStatus
The health status of the instance. Set to Healthy if you
want the instance to remain in service. Set to Unhealthy if
you want the instance to be out of service. Auto Scaling will terminate
and replace the unhealthy instance.
Boolean shouldRespectGracePeriod
If the Auto Scaling group of the specified instance has a
HealthCheckGracePeriod specified for the group, by default,
this call will respect the grace period. Set this to False,
if you do not want the call to respect the grace period associated with
the group.
For more information, see the HealthCheckGracePeriod
parameter description for CreateAutoScalingGroup.
com.amazonaws.internal.SdkInternalList<T> instanceIds
One or more instance IDs.
String autoScalingGroupName
The name of the group.
Boolean protectedFromScaleIn
Indicates whether the instance is protected from termination by Auto Scaling when scaling in.
Double metricIntervalLowerBound
The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
Double metricIntervalUpperBound
The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.
The upper bound must be greater than the lower bound.
Integer scalingAdjustment
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
String autoScalingGroupName
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
com.amazonaws.internal.SdkInternalList<T> scalingProcesses
One or more of the following processes:
Launch
Terminate
HealthCheck
ReplaceUnhealthy
AZRebalance
AlarmNotification
ScheduledActions
AddToLoadBalancer
String resourceId
The name of the group.
String resourceType
The type of resource. The only supported value is
auto-scaling-group.
String key
The tag key.
String value
The tag value.
Boolean propagateAtLaunch
Determines whether the tag is added to new instances as they are launched in the group.
String resourceId
The name of the group.
String resourceType
The type of resource. The only supported value is
auto-scaling-group.
String key
The tag key.
String value
The tag value.
Boolean propagateAtLaunch
Determines whether the tag is added to new instances as they are launched in the group.
Activity activity
A scaling activity.
String autoScalingGroupName
The name of the Auto Scaling group.
String launchConfigurationName
The name of the launch configuration.
Integer minSize
The minimum size of the Auto Scaling group.
Integer maxSize
The maximum size of the Auto Scaling group.
Integer desiredCapacity
The number of EC2 instances that should be running in the Auto Scaling group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.
Integer defaultCooldown
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.
For more information, see Understanding Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
com.amazonaws.internal.SdkInternalList<T> availabilityZones
One or more Availability Zones for the group.
String healthCheckType
The service to use for the health checks. The valid values are
EC2 and ELB.
Integer healthCheckGracePeriod
The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default is 300.
For more information, see Health Checks For Auto Scaling Instances in the Auto Scaling Developer Guide.
String placementGroup
The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.
String vPCZoneIdentifier
The ID of the subnet, if you are launching into a VPC. You can specify several subnets in a comma-separated list.
When you specify VPCZoneIdentifier with
AvailabilityZones, ensure that the subnets' Availability
Zones match the values you specify for AvailabilityZones.
For more information, see Auto Scaling and Amazon Virtual Private Cloud in the Auto Scaling Developer Guide.
com.amazonaws.internal.SdkInternalList<T> terminationPolicies
A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.
For more information, see Choosing a Termination Policy for Your Auto Scaling Group in the Auto Scaling Developer Guide.
Boolean newInstancesProtectedFromScaleIn
Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
String stackName
The name or the unique stack ID that is associated with the stack.
String stackName
The name that is associated with the stack. The name must be unique in the region in which you are creating the stack.
String templateBody
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the
TemplateURL parameter, but not both.
String templateURL
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the
TemplateURL parameter, but not both.
com.amazonaws.internal.SdkInternalList<T> parameters
A list of Parameter structures that specify input parameters
for the stack.
Boolean disableRollback
Set to true to disable rollback of the stack if stack
creation failed. You can specify either DisableRollback or
OnFailure, but not both.
Default: false
Integer timeoutInMinutes
The amount of time that can pass before the stack status becomes
CREATE_FAILED; if DisableRollback is not set or is set to
false, the stack will be rolled back.
com.amazonaws.internal.SdkInternalList<T> notificationARNs
The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).
com.amazonaws.internal.SdkInternalList<T> capabilities
A list of capabilities that you must specify before AWS CloudFormation can create or update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.
Currently, the only valid value is CAPABILITY_IAM, which is
required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains
these resources, we recommend that you review any permissions associated
with them. If you don't specify this parameter, this action returns an
InsufficientCapabilities error.
com.amazonaws.internal.SdkInternalList<T> resourceTypes
The template resource types that you have permissions to work with for
this create stack action, such as AWS::EC2::Instance,
AWS::EC2::*, or Custom::MyCustomInstance. Use
the following syntax to describe template resource types:
AWS::* (for all AWS resource), Custom::* (for
all custom resources), Custom::logical_ID (for a
specific custom resource), AWS::service_name::* (for
all resources of a particular AWS service), and
AWS::service_name::resource_logical_ID (for a
specific AWS resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
String onFailure
Determines what action will be taken if stack creation fails. This must
be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either
OnFailure or DisableRollback, but not both.
Default: ROLLBACK
String stackPolicyBody
Structure containing the stack policy body. For more information, go to
Prevent Updates to Stack Resources in the AWS CloudFormation User
Guide. You can specify either the StackPolicyBody or the
StackPolicyURL parameter, but not both.
String stackPolicyURL
Location of a file containing the stack policy. The URL must point to a
policy (max size: 16KB) located in an S3 bucket in the same region as the
stack. You can specify either the StackPolicyBody or the
StackPolicyURL parameter, but not both.
com.amazonaws.internal.SdkInternalList<T> tags
A set of user-defined Tags to associate with this stack,
represented by key/value pairs. Tags defined for the stack are propagated
to EC2 resources that are created as part of the stack. A maximum number
of 10 tags can be specified.
String stackId
Unique identifier of the stack.
String stackName
The name or the unique stack ID that is associated with the stack.
String nextToken
A string that identifies the next page of limits that you want to retrieve.
com.amazonaws.internal.SdkInternalList<T> accountLimits
An account limit structure that contain a list of AWS CloudFormation account limits and their values.
String nextToken
A string that identifies the next page of limits. If no additional page exists, this value is null.
String stackName
The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Default: There is no default value.
String nextToken
String that identifies the start of the next list of events, if there is one.
Default: There is no default value.
com.amazonaws.internal.SdkInternalList<T> stackEvents
A list of StackEvents structures.
String nextToken
String that identifies the start of the next list of events, if there is one.
String stackName
The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Default: There is no default value.
String logicalResourceId
The logical name of the resource as specified in the template.
Default: There is no default value.
StackResourceDetail stackResourceDetail
A StackResourceDetail structure containing the description
of the specified resource in the specified stack.
String stackName
The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Default: There is no default value.
Required: Conditional. If you do not specify StackName, you
must specify PhysicalResourceId.
String logicalResourceId
The logical name of the resource as specified in the template.
Default: There is no default value.
String physicalResourceId
The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
For example, for an Amazon Elastic Compute Cloud (EC2) instance,
PhysicalResourceId corresponds to the
InstanceId. You can pass the EC2 InstanceId to
DescribeStackResources to find which stack the instance
belongs to and what other resources are part of the stack.
Required: Conditional. If you do not specify
PhysicalResourceId, you must specify StackName.
Default: There is no default value.
com.amazonaws.internal.SdkInternalList<T> stackResources
A list of StackResource structures.
String stackName
The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Default: There is no default value.
String nextToken
com.amazonaws.internal.SdkInternalList<T> stacks
A list of stack structures.
String nextToken
String templateBody
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)
Conditional: You must pass TemplateBody or
TemplateURL. If both are passed, only
TemplateBody is used.
String templateURL
Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must pass TemplateURL or
TemplateBody. If both are passed, only
TemplateBody is used.
com.amazonaws.internal.SdkInternalList<T> parameters
A list of Parameter structures that specify input
parameters.
String url
An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
String stackName
The name or unique stack ID that is associated with the stack whose policy you want to get.
String stackPolicyBody
Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.)
String stackName
The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Default: There is no default value.
String templateBody
Structure containing the template body. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)
String templateBody
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify only one of the following parameters:
StackName, TemplateBody, or
TemplateURL.
String templateURL
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify only one of the following parameters:
StackName, TemplateBody, or
TemplateURL.
String stackName
The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.
Conditional: You must specify only one of the following parameters:
StackName, TemplateBody, or
TemplateURL.
com.amazonaws.internal.SdkInternalList<T> parameters
A list of parameter declarations that describe various properties for each parameter.
String description
The value that is defined in the Description property of the
template.
com.amazonaws.internal.SdkInternalList<T> capabilities
The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.
String capabilitiesReason
The list of resources that generated the values in the
Capabilities response element.
com.amazonaws.internal.SdkInternalList<T> resourceTypes
A list of all the template resource types that are defined in the
template, such as AWS::EC2::Instance,
AWS::Dynamo::Table, and
Custom::MyCustomInstance. Use the following syntax to
describe template resource types: AWS::* (for all AWS
resources), Custom::* (for all custom resources),
Custom::logical_ID (for a specific custom resource),
AWS::service_name::* (for all resources of a
particular AWS service), and
AWS::service_name::resource_logical_ID (for a
specific AWS resource).
String version
The AWS template format version, which identifies the capabilities of the template.
String metadata
The value that is defined for the Metadata property of the
template.
String stackName
The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Default: There is no default value.
String nextToken
String that identifies the start of the next list of stack resource summaries, if there is one.
Default: There is no default value.
com.amazonaws.internal.SdkInternalList<T> stackResourceSummaries
A list of StackResourceSummary structures.
String nextToken
String that identifies the start of the next list of stack resources, if there is one.
String nextToken
String that identifies the start of the next list of stacks, if there is one.
Default: There is no default value.
com.amazonaws.internal.SdkInternalList<T> stackStatusFilters
Stack status to use as a filter. Specify one or more stack status codes
to list only stacks with the specified status codes. For a complete list
of stack status codes, see the StackStatus parameter of the
Stack data type.
com.amazonaws.internal.SdkInternalList<T> stackSummaries
A list of StackSummary structures containing information
about the specified stacks.
String nextToken
String that identifies the start of the next list of stacks, if there is one.
String parameterKey
The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.
String parameterValue
The value associated with the parameter.
Boolean usePreviousValue
During a stack update, use the existing parameter value that the stack is
using for a given parameter key. If you specify true, do not
specify a parameter value.
com.amazonaws.internal.SdkInternalList<T> allowedValues
A list of values that are permitted for a parameter.
String parameterKey
The name that is associated with the parameter.
String defaultValue
The default value of the parameter.
String parameterType
The type of parameter.
Boolean noEcho
Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.
String description
The description that is associate with the parameter.
ParameterConstraints parameterConstraints
The criteria that AWS CloudFormation uses to validate parameter values.
String stackName
The name or unique stack ID that you want to associate a policy with.
String stackPolicyBody
Structure containing the stack policy body. For more information, go to
Prevent Updates to Stack Resources in the AWS CloudFormation User
Guide. You can specify either the StackPolicyBody or the
StackPolicyURL parameter, but not both.
String stackPolicyURL
Location of a file containing the stack policy. The URL must point to a
policy (max size: 16KB) located in an S3 bucket in the same region as the
stack. You can specify either the StackPolicyBody or the
StackPolicyURL parameter, but not both.
String stackName
The stack name or unique stack ID that includes the resource that you want to signal.
String logicalResourceId
The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.
String uniqueId
A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.
String status
The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.
String stackId
Unique identifier of the stack.
String stackName
The name associated with the stack.
String description
A user-defined description associated with the stack.
com.amazonaws.internal.SdkInternalList<T> parameters
A list of Parameter structures.
Date creationTime
The time at which the stack was created.
Date lastUpdatedTime
The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
String stackStatus
Current status of the stack.
String stackStatusReason
Success/failure message associated with the stack status.
Boolean disableRollback
Boolean to enable or disable rollback on stack creation failures:
true: disable rollbackfalse: enable rollbackcom.amazonaws.internal.SdkInternalList<T> notificationARNs
SNS topic ARNs to which stack related events are published.
Integer timeoutInMinutes
The amount of time within which stack creation should complete.
com.amazonaws.internal.SdkInternalList<T> capabilities
The capabilities allowed in the stack.
com.amazonaws.internal.SdkInternalList<T> outputs
A list of output structures.
com.amazonaws.internal.SdkInternalList<T> tags
A list of Tags that specify cost allocation information for
the stack.
String stackId
The unique ID name of the instance of the stack.
String eventId
The unique ID of this event.
String stackName
The name associated with a stack.
String logicalResourceId
The logical name of the resource specified in the template.
String physicalResourceId
The name or unique identifier associated with the physical instance of the resource.
String resourceType
Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
Date timestamp
Time the status was updated.
String resourceStatus
Current status of the resource.
String resourceStatusReason
Success/failure message associated with the resource.
String resourceProperties
BLOB of the properties used to create the resource.
String stackName
The name associated with the stack.
String stackId
Unique identifier of the stack.
String logicalResourceId
The logical name of the resource specified in the template.
String physicalResourceId
The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
String resourceType
Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
Date timestamp
Time the status was updated.
String resourceStatus
Current status of the resource.
String resourceStatusReason
Success/failure message associated with the resource.
String description
User defined description associated with the resource.
String stackName
The name associated with the stack.
String stackId
Unique identifier of the stack.
String logicalResourceId
The logical name of the resource specified in the template.
String physicalResourceId
The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
String resourceType
Type of resource. ((For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
Date lastUpdatedTimestamp
Time the status was updated.
String resourceStatus
Current status of the resource.
String resourceStatusReason
Success/failure message associated with the resource.
String description
User defined description associated with the resource.
String metadata
The JSON format content of the Metadata attribute declared
for the resource. For more information, see Metadata Attribute in the AWS CloudFormation User Guide.
String logicalResourceId
The logical name of the resource specified in the template.
String physicalResourceId
The name or unique identifier that corresponds to a physical instance ID of the resource.
String resourceType
Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
Date lastUpdatedTimestamp
Time the status was updated.
String resourceStatus
Current status of the resource.
String resourceStatusReason
Success/failure message associated with the resource.
String stackId
Unique stack identifier.
String stackName
The name associated with the stack.
String templateDescription
The template description of the template used to create the stack.
Date creationTime
The time the stack was created.
Date lastUpdatedTime
The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
Date deletionTime
The time the stack was deleted.
String stackStatus
The current status of the stack.
String stackStatusReason
Success/Failure message associated with the stack status.
String key
Required. A string used to identify this tag. You can specify a
maximum of 128 characters for a tag key. Tags owned by Amazon Web
Services (AWS) have the reserved prefix: aws:.
String value
Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
String parameterKey
The name associated with the parameter.
String defaultValue
The default value associated with the parameter.
Boolean noEcho
Flag indicating whether the parameter should be displayed as plain text in logs and UIs.
String description
User defined description associated with the parameter.
String stackName
The name or unique stack ID of the stack to update.
String templateBody
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)
Conditional: You must specify either the TemplateBody or the
TemplateURL parameter, but not both.
String templateURL
Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the
TemplateURL parameter, but not both.
Boolean usePreviousTemplate
Reuse the existing template that is associated with the stack that you are updating.
String stackPolicyDuringUpdateBody
Structure containing the temporary overriding stack policy body. You can
specify either the StackPolicyDuringUpdateBody or the
StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
String stackPolicyDuringUpdateURL
Location of a file containing the temporary overriding stack policy. The
URL must point to a policy (max size: 16KB) located in an S3 bucket in
the same region as the stack. You can specify either the
StackPolicyDuringUpdateBody or the
StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
com.amazonaws.internal.SdkInternalList<T> parameters
A list of Parameter structures that specify input parameters
for the stack. For more information, see the Parameter data type.
com.amazonaws.internal.SdkInternalList<T> capabilities
A list of capabilities that you must specify before AWS CloudFormation
can create or update certain stacks. Some stack templates might include
resources that can affect permissions in your AWS account. For those
stacks, you must explicitly acknowledge their capabilities by specifying
this parameter. Currently, the only valid value is
CAPABILITY_IAM, which is required for the following
resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains
these resources, we recommend that you review any permissions associated
with them. If you don't specify this parameter, this action returns an
InsufficientCapabilities error.
com.amazonaws.internal.SdkInternalList<T> resourceTypes
The template resource types that you have permissions to work with for
this update stack action, such as AWS::EC2::Instance,
AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management
String stackPolicyBody
Structure containing a new stack policy body. You can specify either the
StackPolicyBody or the StackPolicyURL
parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
String stackPolicyURL
Location of a file containing the updated stack policy. The URL must
point to a policy (max size: 16KB) located in an S3 bucket in the same
region as the stack. You can specify either the
StackPolicyBody or the StackPolicyURL
parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
com.amazonaws.internal.SdkInternalList<T> notificationARNs
Update the ARNs for the Amazon SNS topics that are associated with the stack.
String stackId
Unique identifier of the stack.
String templateBody
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must pass TemplateURL or
TemplateBody. If both are passed, only
TemplateBody is used.
String templateURL
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must pass TemplateURL or
TemplateBody. If both are passed, only
TemplateBody is used.
com.amazonaws.internal.SdkInternalList<T> parameters
A list of TemplateParameter structures.
String description
The description found within the template.
com.amazonaws.internal.SdkInternalList<T> capabilities
The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.
String capabilitiesReason
The list of resources that generated the values in the
Capabilities response element.
Boolean enabled
Integer quantity
com.amazonaws.internal.SdkInternalList<T> items
Integer quantity
com.amazonaws.internal.SdkInternalList<T> items
Integer quantity
com.amazonaws.internal.SdkInternalList<T> items
CachedMethods cachedMethods
String pathPattern
String targetOriginId
ForwardedValues forwardedValues
TrustedSigners trustedSigners
String viewerProtocolPolicy
Long minTTL
AllowedMethods allowedMethods
Boolean smoothStreaming
Long defaultTTL
Long maxTTL
Boolean compress
Integer quantity
com.amazonaws.internal.SdkInternalList<T> items
Integer quantity
com.amazonaws.internal.SdkInternalList<T> items
String id
String s3CanonicalUserId
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
Integer quantity
com.amazonaws.internal.SdkInternalList<T> items
String forward
CookieNames whitelistedNames
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity
String location
String eTag
DistributionConfig distributionConfig
Distribution distribution
String location
String eTag
String distributionId
InvalidationBatch invalidationBatch
String location
Invalidation invalidation
StreamingDistributionConfig streamingDistributionConfig
StreamingDistribution streamingDistribution
String location
String eTag
Integer quantity
com.amazonaws.internal.SdkInternalList<T> items
Integer quantity
com.amazonaws.internal.SdkInternalList<T> items
Integer hTTPPort
Integer hTTPSPort
String originProtocolPolicy
OriginSslProtocols originSslProtocols
String targetOriginId
ForwardedValues forwardedValues
TrustedSigners trustedSigners
String viewerProtocolPolicy
Long minTTL
AllowedMethods allowedMethods
Boolean smoothStreaming
Long defaultTTL
Long maxTTL
Boolean compress
String id
String status
Date lastModifiedTime
Integer inProgressInvalidationBatches
String domainName
ActiveTrustedSigners activeTrustedSigners
DistributionConfig distributionConfig
String callerReference
Aliases aliases
String defaultRootObject
Origins origins
DefaultCacheBehavior defaultCacheBehavior
CacheBehaviors cacheBehaviors
CustomErrorResponses customErrorResponses
String comment
LoggingConfig logging
String priceClass
Boolean enabled
ViewerCertificate viewerCertificate
Restrictions restrictions
String webACLId
String id
String status
Date lastModifiedTime
String domainName
Aliases aliases
Origins origins
DefaultCacheBehavior defaultCacheBehavior
CacheBehaviors cacheBehaviors
CustomErrorResponses customErrorResponses
String comment
String priceClass
Boolean enabled
ViewerCertificate viewerCertificate
Restrictions restrictions
String webACLId
Boolean queryString
CookiePreference cookies
Headers headers
String restrictionType
Integer quantity
com.amazonaws.internal.SdkInternalList<T> items
String id
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
String eTag
String id
CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity
String eTag
String id
DistributionConfig distributionConfig
String eTag
String id
Distribution distribution
String eTag
Invalidation invalidation
String id
StreamingDistributionConfig streamingDistributionConfig
String eTag
String id
StreamingDistribution streamingDistribution
String eTag
Integer quantity
com.amazonaws.internal.SdkInternalList<T> items
String id
String status
Date createTime
InvalidationBatch invalidationBatch
Integer quantity
com.amazonaws.internal.SdkInternalList<T> items
CloudFrontOriginAccessIdentityList cloudFrontOriginAccessIdentityList
DistributionList distributionList
DistributionList distributionList
InvalidationList invalidationList
StreamingDistributionList streamingDistributionList
String id
String domainName
String originPath
CustomHeaders customHeaders
S3OriginConfig s3OriginConfig
CustomOriginConfig customOriginConfig
Integer quantity
com.amazonaws.internal.SdkInternalList<T> items
Integer quantity
com.amazonaws.internal.SdkInternalList<T> items
Integer quantity
com.amazonaws.internal.SdkInternalList<T> items
GeoRestriction geoRestriction
String originAccessIdentity
String awsAccountNumber
KeyPairIds keyPairIds
String id
String status
Date lastModifiedTime
String domainName
ActiveTrustedSigners activeTrustedSigners
StreamingDistributionConfig streamingDistributionConfig
String callerReference
S3Origin s3Origin
Aliases aliases
String comment
StreamingLoggingConfig logging
TrustedSigners trustedSigners
String priceClass
Boolean enabled
Boolean enabled
Integer quantity
com.amazonaws.internal.SdkInternalList<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 label
The label of the new high-availability partition group.
String hapgArn
The ARN of the high-availability partition group.
String subnetId
The identifier of the subnet in your VPC in which to place the HSM.
String sshKey
The SSH public key to install on the HSM.
String eniIp
The IP address to assign to the HSM's ENI.
String iamRoleArn
The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
String externalId
The external ID from IamRoleArn, if present.
String subscriptionType
The subscription type.
String clientToken
A user-defined token to ensure idempotence. Subsequent calls to this action with the same token will be ignored.
String syslogIp
The IP address for the syslog monitoring server.
String hsmArn
The ARN of the HSM.
String clientArn
The ARN of the client.
String hapgArn
The ARN of the high-availability partition group to delete.
String status
The status of the action.
String hsmArn
The ARN of the HSM to delete.
String status
The status of the action.
String clientArn
The ARN of the client to delete.
String status
The status of the action.
String hapgArn
The ARN of the high-availability partition group to describe.
String hapgArn
The ARN of the high-availability partition group.
String hapgSerial
The serial number of the high-availability partition group.
com.amazonaws.internal.SdkInternalList<T> hsmsLastActionFailed
com.amazonaws.internal.SdkInternalList<T> hsmsPendingDeletion
com.amazonaws.internal.SdkInternalList<T> hsmsPendingRegistration
String label
The label for the high-availability partition group.
String lastModifiedTimestamp
The date and time the high-availability partition group was last modified.
com.amazonaws.internal.SdkInternalList<T> partitionSerialList
The list of partition serial numbers that belong to the high-availability partition group.
String state
The state of the high-availability partition group.
String hsmArn
The ARN of the HSM.
String status
The status of the HSM.
String statusDetails
Contains additional information about the status of the HSM.
String availabilityZone
The Availability Zone that the HSM is in.
String eniId
The identifier of the elastic network interface (ENI) attached to the HSM.
String eniIp
The IP address assigned to the HSM's ENI.
String subscriptionType
The subscription type.
String subscriptionStartDate
The subscription start date.
String subscriptionEndDate
The subscription end date.
String vpcId
The identifier of the VPC that the HSM is in.
String subnetId
The identifier of the subnet the HSM is in.
String iamRoleArn
The ARN of the IAM role assigned to the HSM.
String serialNumber
The serial number of the HSM.
String vendorName
The name of the HSM vendor.
String hsmType
The HSM model type.
String softwareVersion
The HSM software version.
String sshPublicKey
The public SSH key.
String sshKeyLastUpdated
The date and time the SSH key was last updated.
String serverCertUri
The URI of the certificate server.
String serverCertLastUpdated
The date and time the server certificate was last updated.
com.amazonaws.internal.SdkInternalList<T> partitions
The list of partitions on the HSM.
String clientArn
The ARN of the client.
String certificate
The certificate installed on the HSMs used by this client.
String certificateFingerprint
The certificate fingerprint.
String lastModifiedTimestamp
The date and time the client was last modified.
String label
The label of the client.
String clientArn
The ARN of the client.
String clientVersion
The client version.
com.amazonaws.internal.SdkInternalList<T> hapgList
A list of ARNs that identify the high-availability partition groups that are associated with the client.
com.amazonaws.internal.SdkInternalList<T> aZList
The list of Availability Zones that have available AWS CloudHSM capacity.
com.amazonaws.internal.SdkInternalList<T> hapgList
The list of high-availability partition groups.
String nextToken
If not null, more results are available. Pass this value to ListHapgs to retrieve the next set of items.
com.amazonaws.internal.SdkInternalList<T> hsmList
The list of ARNs that identify the HSMs.
String nextToken
If not null, more results are available. Pass this value to ListHsms to retrieve the next set of items.
String nextToken
The NextToken value from a previous call to ListLunaClients. Pass null if this is the first call.
com.amazonaws.internal.SdkInternalList<T> clientList
The list of clients.
String nextToken
If not null, more results are available. Pass this to ListLunaClients to retrieve the next set of items.
String hapgArn
The ARN of the high-availability partition group to modify.
String label
The new label for the high-availability partition group.
com.amazonaws.internal.SdkInternalList<T> partitionSerialList
The list of partition serial numbers to make members of the high-availability partition group.
String hapgArn
The ARN of the high-availability partition group.
String hsmArn
The ARN of the HSM to modify.
String subnetId
The new identifier of the subnet that the HSM is in.
String eniIp
The new IP address for the elastic network interface attached to the HSM.
String iamRoleArn
The new IAM role ARN.
String externalId
The new external ID.
String syslogIp
The new IP address for the syslog monitoring server.
String hsmArn
The ARN of the HSM.
String clientArn
The ARN of the client.
String options
Example: {"Statement":
[{"Effect":"Allow", "Action": "*", "Resource":
"arn:aws:cs:us-east-1:1234567890:search/movies", "Condition": {
"IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }},
{"Effect":"Allow", "Action": "*", "Resource":
"arn:aws:cs:us-east-1:1234567890:documents/movies", "Condition": {
"IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }} ] }
OptionStatus status
Boolean options
OptionStatus status
String code
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
DomainStatus domainStatus
String options
IndexField to use as the default search
field. The default is an empty string, which automatically searches
all text fields.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
OptionStatus status
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
IndexField indexField
IndexFieldType indicates which of the
options will be present. It is invalid to specify options for a type
other than the IndexFieldType.IndexFieldStatus indexField
IndexField and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
NamedRankExpression rankExpression
RankExpressionStatus rankExpression
RankExpression and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
DomainStatus domainStatus
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String indexFieldName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
IndexFieldStatus indexField
IndexField and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String rankName
RankExpression to delete.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
RankExpressionStatus rankExpression
RankExpression and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
AvailabilityOptionsStatus availabilityOptions
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
DefaultSearchFieldStatus defaultSearchField
IndexField to use for search requests
issued with the q parameter. The default is the empty
string, which automatically searches all text fields.com.amazonaws.internal.ListWithAutoConstructFlag<T> domainNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainStatusList
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
DescribeIndexFields response to the specified
fields.com.amazonaws.internal.ListWithAutoConstructFlag<T> indexFields
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> rankNames
DescribeRankExpressions response to the
specified fields.com.amazonaws.internal.ListWithAutoConstructFlag<T> rankExpressions
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
AccessPoliciesStatus accessPolicies
PolicyDocument that specifies access policies for the
search domain's services, and the current status of those policies.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
StemmingOptionsStatus stems
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
StopwordOptionsStatus stopwords
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
SynonymOptionsStatus synonyms
String domainId
Constraints:
Length: 1 - 64
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
Boolean created
Boolean deleted
Long numSearchableDocs
Constraints:
Range: 0 -
ServiceEndpoint docService
ServiceEndpoint searchService
Boolean requiresIndexDocuments
Boolean processing
String searchInstanceType
Integer searchPartitionCount
Constraints:
Range: 1 -
Integer searchInstanceCount
Constraints:
Range: 1 -
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
IndexDocuments action.String indexFieldName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String indexFieldType
Constraints:
Allowed Values: uint, literal, text
UIntOptions uIntOptions
IndexFieldType specifies the field is of type unsigned
integer.LiteralOptions literalOptions
IndexFieldType
specifies the field is of type literal.TextOptions textOptions
IndexFieldType
specifies the field is of type text.com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceAttributes
IndexField. When one or more
source attributes are specified, an optional data transformation can
be applied to the source data when populating the index field. You can
configure a maximum of 20 sources for an IndexField.IndexField options
IndexFieldType indicates which of the
options will be present. It is invalid to specify options for a type
other than the IndexFieldType.OptionStatus status
String defaultValue
Constraints:
Length: 0 - 1024
Boolean searchEnabled
Boolean facetEnabled
Boolean resultEnabled
String rankName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String rankExpression
RankExpression syntax is
based on JavaScript expressions and supports:a || b
evaluates to the value a, if a is true,
without evaluating b at all+ - * /
%abs ceil erf exp
floor lgamma ln log2 log10 max min sqrt powacosh acos asinh asin atanh
atan cosh cos sinh sin tanh tanrandtimemin max functions
that operate on a variable argument listIntermediate
results are calculated as double precision floating point values. The
final return value of a RankExpression is automatically
converted from floating point to a 32-bit unsigned integer by rounding
to the nearest integer, with a natural floor of 0 and a ceiling of
max(uint32_t), 4294967295. Mathematical errors such as dividing by 0
will fail during evaluation and return a value of 0.
The source
data for a RankExpression can be the name of an
IndexField of type uint, another
RankExpression or the reserved name
text_relevance. The text_relevance source is defined to return
an integer from 0 to 1000 (inclusive) to indicate how relevant a
document is to the search request, taking into account repetition of
search terms in the document and proximity of search terms to each
other in each matching IndexField in the document.
For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.
Constraints:
Length: 1 - 10240
Date creationDate
Date updateDate
Integer updateVersion
Constraints:
Range: 0 -
String state
RequiresIndexDocuments: the option's latest value
will not be visible in searches until IndexDocuments has been
called and indexing is complete.Processing: the
option's latest value is not yet visible in all searches but is in the
process of being activated. Active: the
option's latest value is completely visible. Any warnings or messages
generated during processing are provided in
Diagnostics.
Constraints:
Allowed Values: RequiresIndexDocuments, Processing, Active
Boolean pendingDeletion
NamedRankExpression options
OptionStatus status
String arn
String endpoint
String sourceDataFunction
Constraints:
Allowed Values: Copy, TrimTitle, Map
SourceData sourceDataCopy
IndexField.SourceDataTrimTitle sourceDataTrimTitle
IndexField. This can be used to create an
IndexField you can use for sorting.SourceDataMap sourceDataMap
IndexField.String sourceName
IndexField.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String defaultValue
Constraints:
Length: 0 - 1024
String sourceName
IndexField.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String defaultValue
Constraints:
Length: 0 - 1024
Map<K,V> cases
String sourceName
IndexField.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String defaultValue
Constraints:
Length: 0 - 1024
String separator
String language
Constraints:
Pattern: [a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*
String options
{ "stems": {"people": "person", "walking":
"walk"} }OptionStatus status
String options
{ "stopwords": ["a", "an", "the", "of"] }OptionStatus status
String options
{ "synonyms": {"cat": ["feline",
"kitten"], "puppy": "dog"} }OptionStatus status
String defaultValue
Constraints:
Length: 0 - 1024
Boolean facetEnabled
Boolean resultEnabled
String textProcessor
cs_text_no_stemming: turns off stemming for the
field.Default: none
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
Integer defaultValue
Constraints:
Range: 0 -
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
Boolean multiAZ
false.AvailabilityOptionsStatus availabilityOptions
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String defaultSearchField
q parameter, or if a match
expression specified with the bq parameter does not
constrain the search to a particular field. The default is an empty
string, which automatically searches all text fields.DefaultSearchFieldStatus defaultSearchField
DefaultSearchField configured for this
search domain and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String accessPolicies
Example: {"Statement":
[{"Effect":"Allow", "Action": "*", "Resource":
"arn:aws:cs:us-east-1:1234567890:search/movies", "Condition": {
"IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }},
{"Effect":"Allow", "Action": "*", "Resource":
"arn:aws:cs:us-east-1:1234567890:documents/movies", "Condition": {
"IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }} ] }
AccessPoliciesStatus accessPolicies
PolicyDocument that specifies access policies for the
search domain's services, and the current status of those policies.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String stems
{ "stems": {"people": "person", "walking":
"walk"} }StemmingOptionsStatus stems
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String stopwords
{ "stopwords": ["a", "an", "the", "of"] }StopwordOptionsStatus stopwords
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String synonyms
{ "synonyms": {"cat": ["feline",
"kitten"], "puppy": "dog"} }SynonymOptionsStatus synonyms
com.amazonaws.internal.SdkInternalList<T> buckets
A list of the calculated facet values and counts.
String status
The return status of a document upload request, error or
success.
String message
The description for a warning returned by the document service.
String id
The document ID of a document that matches the search request.
com.amazonaws.internal.SdkInternalMap<K,V> fields
The fields returned from a document that matches the search request.
com.amazonaws.internal.SdkInternalMap<K,V> exprs
The expressions returned from a document that matches the search request.
com.amazonaws.internal.SdkInternalMap<K,V> highlights
The highlights returned from a document that matches the search request.
Long found
The total number of documents that match the search request.
Long start
The index of the first matching document.
String cursor
A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set.
com.amazonaws.internal.SdkInternalList<T> hit
A document that matches the search request.
String cursor
Retrieves a cursor value you can use to page through large result sets.
Use the size parameter to control the number of hits to
include in each response. You can specify either the cursor
or start parameter in a request; they are mutually
exclusive. To get the first cursor, set the cursor value to
initial. In subsequent requests, specify the cursor value
returned in the hits section of the response.
For more information, see Paginating Results in the Amazon CloudSearch Developer Guide.
String expr
Defines one or more numeric expressions that can be used to sort results or specify search or filter criteria. You can also specify expressions as return fields.
You specify the expressions in JSON using the form
{"EXPRESSIONNAME":"EXPRESSION"}. You can define and use
multiple expressions in a search request. For example:
{"expression1":"_score*rating", "expression2":"(1/rank)*year"}
For information about the variables, operators, and functions you can use in expressions, see Writing Expressions in the Amazon CloudSearch Developer Guide.
String facet
Specifies one or more fields for which to get facet information, and
options that control how the facet information is returned. Each
specified field must be facet-enabled in the domain configuration. The
fields and options are specified in JSON using the form
{"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}
.
You can specify the following faceting options:
buckets specifies an array of the facet values or ranges to
count. Ranges are specified using the same syntax that you use to search
for a range of values. For more information, see Searching for a Range of Values in the Amazon CloudSearch
Developer Guide. Buckets are returned in the order they are specified
in the request. The sort and size options are
not valid if you specify buckets.
size specifies the maximum number of facets to include in
the results. By default, Amazon CloudSearch returns counts for the top
10. The size parameter is only valid when you specify the
sort option; it cannot be used in conjunction with
buckets.
sort specifies how you want to sort the facets in the
results: bucket or count. Specify
bucket to sort alphabetically or numerically by facet value
(in ascending order). Specify count to sort by the facet
counts computed for each facet value (in descending order). To retrieve
facet counts for particular values or ranges of values, use the
buckets option instead of sort.
If no facet options are specified, facet counts are computed for all field values, the facets are sorted by facet count, and the top 10 facets are returned in the results.
To count particular buckets of values, use the buckets
option. For example, the following request uses the buckets
option to calculate and return facet counts by decade.
{"year":{"buckets":["[1970,1979]","[1980,1989]","[1990,1999]","[2000,2009]","[2010,}"]}}
To sort facets by facet count, use the count option. For
example, the following request sets the sort option to
count to sort the facet values by facet count, with the
facet values that have the most matching documents listed first. Setting
the size option to 3 returns only the top three facet
values.
{"year":{"sort":"count","size":3}}
To sort the facets by value, use the bucket option. For
example, the following request sets the sort option to
bucket to sort the facet values numerically by year, with
earliest year listed first.
{"year":{"sort":"bucket"}}
For more information, see Getting and Using Facet Information in the Amazon CloudSearch Developer Guide.
String filterQuery
Specifies a structured query that filters the results of a search without
affecting how the results are scored and sorted. You use
filterQuery in conjunction with the query
parameter to filter the documents that match the constraints specified in
the query parameter. Specifying a filter controls only which
matching documents are included in the results, it has no effect on how
they are scored and sorted. The filterQuery parameter
supports the full structured query syntax.
For more information about using filters, see Filtering Matching Documents in the Amazon CloudSearch Developer Guide.
String highlight
Retrieves highlights for matches in the specified text or
text-array fields. Each specified field must be highlight
enabled in the domain configuration. The fields and options are specified
in JSON using the form
{"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}
.
You can specify the following highlight options:
format: specifies the format of the data in the text
field: text or html. When data is returned as
HTML, all non-alphanumeric characters are encoded. The default is
html.max_phrases: specifies the maximum number of occurrences
of the search term(s) you want to highlight. By default, the first
occurrence is highlighted.pre_tag: specifies the string to prepend to an
occurrence of a search term. The default for HTML highlights is
<em>. The default for text highlights is
*.post_tag: specifies the string to append to an
occurrence of a search term. The default for HTML highlights is
</em>. The default for text highlights is
*.
If no highlight options are specified for a field, the returned field
text is treated as HTML and the first match is highlighted with emphasis
tags: <em>search-term</em>.
For example, the following request retrieves highlights for the
actors and title fields.
{ "actors": {}, "title": {"format": "text","max_phrases": 2,"pre_tag": "","post_tag": ""} }
Boolean partial
Enables partial results to be returned if one or more index partitions are unavailable. When your search index is partitioned across multiple search instances, by default Amazon CloudSearch only returns results if every partition can be queried. This means that the failure of a single search instance can result in 5xx (internal server) errors. When you enable partial results, Amazon CloudSearch returns whatever results are available and includes the percentage of documents searched in the search results (percent-searched). This enables you to more gracefully degrade your users' search experience. For example, rather than displaying no results, you could display the partial results and a message indicating that the results might be incomplete due to a temporary system outage.
String query
Specifies the search criteria for the request. How you specify the search
criteria depends on the query parser used for the request and the parser
options specified in the queryOptions parameter. By default,
the simple query parser is used to process requests. To use
the structured, lucene, or dismax
query parser, you must also specify the queryParser
parameter.
For more information about specifying search criteria, see Searching Your Data in the Amazon CloudSearch Developer Guide.
String queryOptions
Configures options for the query parser specified in the
queryParser parameter. You specify the options in JSON using
the following form
{"OPTION1":"VALUE1","OPTION2":VALUE2"..."OPTIONN":"VALUEN"}.
The options you can configure vary according to which parser you use:
defaultOperator: The default operator used to combine
individual terms in the search string. For example:
defaultOperator: 'or'. For the dismax parser,
you specify a percentage that represents the percentage of terms in the
search string (rounded down) that must match, rather than a default
operator. A value of 0% is the equivalent to OR, and a value
of 100% is equivalent to AND. The percentage must be
specified as a value in the range 0-100 followed by the percent (%)
symbol. For example, defaultOperator: 50%. Valid values:
and, or, a percentage in the range 0%-100% (
dismax). Default: and (simple,
structured, lucene) or 100 (
dismax). Valid for: simple,
structured, lucene, and dismax.fields: An array of the fields to search when no fields
are specified in a search. If no fields are specified in a search and
this option is not specified, all text and text-array fields are
searched. You can specify a weight for each field to control the relative
importance of each field when Amazon CloudSearch calculates relevance
scores. To specify a field weight, append a caret (^) symbol
and the weight to the field name. For example, to boost the importance of
the title field over the description field you
could specify: "fields":["title^5","description"]. Valid
values: The name of any configured field and an optional numeric value
greater than zero. Default: All text and
text-array fields. Valid for: simple,
structured, lucene, and dismax.operators: An array of the operators or special
characters you want to disable for the simple query parser. If you
disable the and, or, or not
operators, the corresponding operators (+, |,
-) have no special meaning and are dropped from the search
string. Similarly, disabling prefix disables the wildcard
operator (*) and disabling phrase disables the
ability to search for phrases by enclosing phrases in double quotes.
Disabling precedence disables the ability to control order of precedence
using parentheses. Disabling near disables the ability to
use the ~ operator to perform a sloppy phrase search. Disabling the
fuzzy operator disables the ability to use the ~ operator to
perform a fuzzy search. escape disables the ability to use a
backslash (\) to escape special characters within the search
string. Disabling whitespace is an advanced option that prevents the
parser from tokenizing on whitespace, which can be useful for Vietnamese.
(It prevents Vietnamese words from being split incorrectly.) For example,
you could disable all operators other than the phrase operator to support
just simple term and phrase queries:
"operators":["and","not","or", "prefix"]. Valid values:
and, escape, fuzzy,
near, not, or, phrase, precedence, prefix, whitespace.
Default: All operators and special characters are enabled. Valid for:
simple.phraseFields: An array of the text or
text-array fields you want to use for phrase searches. When
the terms in the search string appear in close proximity within a field,
the field scores higher. You can specify a weight for each field to boost
that score. The phraseSlop option controls how much the
matches can deviate from the search string and still be boosted. To
specify a field weight, append a caret (^) symbol and the
weight to the field name. For example, to boost phrase matches in the
title field over the abstract field, you could
specify: "phraseFields":["title^3", "plot"] Valid values:
The name of any text or text-array field and an
optional numeric value greater than zero. Default: No fields. If you
don't specify any fields with phraseFields, proximity
scoring is disabled even if phraseSlop is specified. Valid
for: dismax.phraseSlop: An integer value that specifies how much
matches can deviate from the search phrase and still be boosted according
to the weights specified in the phraseFields option; for
example, phraseSlop: 2. You must also specify
phraseFields to enable proximity scoring. Valid values:
positive integers. Default: 0. Valid for: dismax.explicitPhraseSlop: An integer value that specifies how
much a match can deviate from the search phrase when the phrase is
enclosed in double quotes in the search string. (Phrases that exceed this
proximity distance are not considered a match.) For example, to specify a
slop of three for dismax phrase queries, you would specify
"explicitPhraseSlop":3. Valid values: positive integers.
Default: 0. Valid for: dismax.tieBreaker: When a term in the search string is found in
a document's field, a score is calculated for that field based on how
common the word is in that field compared to other documents. If the term
occurs in multiple fields within a document, by default only the highest
scoring field contributes to the document's overall score. You can
specify a tieBreaker value to enable the matches in
lower-scoring fields to contribute to the document's score. That way, if
two documents have the same max field score for a particular term, the
score for the document that has matches in more fields will be higher.
The formula for calculating the score with a tieBreaker is
(max field score) + (tieBreaker) * (sum of the scores for the rest of the matching fields)
. Set tieBreaker to 0 to disregard all but the highest
scoring field (pure max): "tieBreaker":0. Set to 1 to sum
the scores from all fields (pure sum): "tieBreaker":1. Valid
values: 0.0 to 1.0. Default: 0.0. Valid for: dismax.String queryParser
Specifies which query parser to use to process the request. If
queryParser is not specified, Amazon CloudSearch uses the
simple query parser.
Amazon CloudSearch supports four query parsers:
simple: perform simple searches of text and
text-array fields. By default, the simple query
parser searches all text and text-array fields.
You can specify which fields to search by with the
queryOptions parameter. If you prefix a search term with a
plus sign (+) documents must contain the term to be considered a match.
(This is the default, unless you configure the default operator with the
queryOptions parameter.) You can use the -
(NOT), | (OR), and * (wildcard) operators to
exclude particular terms, find results that match any of the specified
terms, or search for a prefix. To search for a phrase rather than
individual terms, enclose the phrase in double quotes. For more
information, see Searching for Text in the Amazon CloudSearch Developer Guide.
structured: perform advanced searches by combining
multiple expressions to define the search criteria. You can also search
within particular fields, search for values and ranges of values, and use
advanced options such as term boosting, matchall, and
near. For more information, see Constructing Compound Queries in the Amazon CloudSearch Developer
Guide.lucene: search using the Apache Lucene query parser
syntax. For more information, see Apache Lucene Query Parser Syntax.dismax: search using the simplified subset of the Apache
Lucene query parser syntax defined by the DisMax query parser. For more
information, see DisMax Query Parser Syntax.String returnValue
Specifies the field and expression values to include in the response.
Multiple fields or expressions are specified as a comma-separated list.
By default, a search response includes all return enabled fields (
_all_fields). To return only the document IDs for the
matching documents, specify _no_fields. To retrieve the
relevance score calculated for each document, specify _score
.
Long size
Specifies the maximum number of search hits to include in the response.
String sort
Specifies the fields or custom expressions to use to sort the search
results. Multiple fields or expressions are specified as a
comma-separated list. You must specify the sort direction (
asc or desc) for each field; for example,
year desc,title asc. To use a field to sort results, the
field must be sort-enabled in the domain configuration. Array type fields
cannot be used for sorting. If no sort parameter is
specified, results are sorted by their default relevance scores in
descending order: _score desc. You can also sort by document
ID (_id asc) and version (_version desc).
For more information, see Sorting Results in the Amazon CloudSearch Developer Guide.
Long start
Specifies the offset of the first search hit you want to return. Note
that the result set is zero-based; the first result is at index 0. You
can specify either the start or cursor
parameter in a request, they are mutually exclusive.
For more information, see Paginating Results in the Amazon CloudSearch Developer Guide.
SearchStatus status
The status information returned for the search request.
Hits hits
The documents that match the search criteria.
com.amazonaws.internal.SdkInternalMap<K,V> facets
The requested facet information.
String query
The query string specified in the suggest request.
Long found
The number of documents that were found to match the query string.
com.amazonaws.internal.SdkInternalList<T> suggestions
The documents that match the query string.
SuggestStatus status
The status of a SuggestRequest. Contains the resource ID (
rid) and how long it took to process the request (
timems).
SuggestModel suggest
Container for the matching search suggestion information.
InputStream documents
A batch of documents formatted in JSON or HTML.
String contentType
The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats:
Long contentLength
String status
The status of an UploadDocumentsRequest.
Long adds
The number of documents that were added to the search domain.
Long deletes
The number of documents that were deleted from the search domain.
com.amazonaws.internal.SdkInternalList<T> warnings
Any warnings returned by the document service about the documents being uploaded.
String options
OptionStatus status
String synonyms
String stopwords
["a", "an", "the", "of"]. The stopwords
dictionary must explicitly list each word you want to ignore.
Wildcards and regular expressions are not supported.String stemmingDictionary
{"term1": "stem1",
"term2": "stem2", "term3": "stem3"}. The stemming dictionary is
applied in addition to any algorithmic stemming. This enables you to
override the results of the algorithmic stemming to correct specific
cases of overstemming or understemming. The maximum size of a stemming
dictionary is 500 KB.String japaneseTokenizationDictionary
String algorithmicStemming
none,
minimal, light, or full. The
available levels vary depending on the language. For more information,
see Language Specific Text Processing Settings in the
Amazon CloudSearch Developer Guide
Constraints:
Allowed Values: none, minimal, light, full
String analysisSchemeName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String analysisSchemeLanguage
mul for multiple languages.
Constraints:
Allowed Values: ar, bg, ca, cs, da, de, el, en, es, eu, fa, fi, fr, ga, gl, he, hi, hu, hy, id, it, ja, ko, lv, mul, nl, no, pt, ro, ru, sv, th, tr, zh-Hans, zh-Hant
AnalysisOptions analysisOptions
AnalysisScheme options
Synonyms, Stopwords,
StemmingDictionary,
JapaneseTokenizationDictionary and
AlgorithmicStemming.OptionStatus status
Boolean options
OptionStatus status
String code
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
DomainStatus domainStatus
String defaultValue
Constraints:
Length: 0 - 1024
String sourceFields
Constraints:
Pattern: \s*[a-z*][a-z0-9_]*\*?\s*(,\s*[a-z*][a-z0-9_]*\*?\s*)*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
String defaultValue
Constraints:
Length: 0 - 1024
String sourceField
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name score is reserved and cannot
be used as a field name. To reference a document's ID, you can use the
name _id.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
Boolean sortEnabled
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
AnalysisScheme analysisScheme
Synonyms, Stopwords,
StemmingDictionary,
JapaneseTokenizationDictionary and
AlgorithmicStemming.AnalysisSchemeStatus analysisScheme
AnalysisScheme.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
Expression expression
ExpressionStatus expression
Expression and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
IndexField indexField
IndexFieldStatus indexField
IndexField and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
Suggester suggester
FuzzyMatching, SortExpression.SuggesterStatus suggester
Suggester and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String analysisSchemeName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
AnalysisSchemeStatus analysisScheme
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
DomainStatus domainStatus
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String expressionName
Expression to delete.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
ExpressionStatus expression
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String indexFieldName
Constraints:
Length: 1 - 64
Pattern: ([a-z][a-z0-9_]*\*?|\*[a-z0-9_]*)
IndexFieldStatus indexField
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String suggesterName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
SuggesterStatus suggester
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> analysisSchemeNames
Boolean deployed
true) or
include any pending changes (false). Defaults to
false.com.amazonaws.internal.ListWithAutoConstructFlag<T> analysisSchemes
AvailabilityOptionsStatus availabilityOptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainStatusList
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> expressionNames
DescribeExpressions response to the
specified expressions. If not specified, all expressions are shown.Boolean deployed
true) or
include any pending changes (false). Defaults to
false.com.amazonaws.internal.ListWithAutoConstructFlag<T> expressions
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
Boolean deployed
true) or
include any pending changes (false). Defaults to
false.com.amazonaws.internal.ListWithAutoConstructFlag<T> indexFields
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
ScalingParametersStatus scalingParameters
AccessPoliciesStatus accessPolicies
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> suggesterNames
Boolean deployed
true) or
include any pending changes (false). Defaults to
false.com.amazonaws.internal.ListWithAutoConstructFlag<T> suggesters
String sourceField
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String fuzzyMatching
none, low, or high. With none,
the specified string is treated as an exact prefix. With low,
suggestions must differ from the specified string by no more than one
character. With high, suggestions can differ by up to two characters.
The default is none.
Constraints:
Allowed Values: none, low, high
String sortExpression
_score value. To sort suggestions using a numeric field
or existing expression, simply specify the name of the field or
expression. If no expression is configured for the suggester, the
suggestions are sorted with the closest matches listed first.String domainId
Constraints:
Length: 1 - 64
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String aRN
Boolean created
Boolean deleted
ServiceEndpoint docService
ServiceEndpoint searchService
Boolean requiresIndexDocuments
Boolean processing
String searchInstanceType
Integer searchPartitionCount
Constraints:
Range: 1 -
Integer searchInstanceCount
Constraints:
Range: 1 -
Limits limits
Double defaultValue
String sourceFields
Constraints:
Pattern: \s*[a-z*][a-z0-9_]*\*?\s*(,\s*[a-z*][a-z0-9_]*\*?\s*)*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
Double defaultValue
String sourceField
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
Boolean sortEnabled
String expressionName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String expressionValue
Expression syntax is based on JavaScript
expressions. For more information, see Configuring Expressions in the Amazon
CloudSearch Developer Guide.
Constraints:
Length: 1 - 10240
Expression options
OptionStatus status
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
String indexFieldName
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name score is reserved and cannot
be used as a field name. To reference a document's ID, you can use the
name _id.
Constraints:
Length: 1 - 64
Pattern: ([a-z][a-z0-9_]*\*?|\*[a-z0-9_]*)
String indexFieldType
Constraints:
Allowed Values: int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array
IntOptions intOptions
IndexFieldType specifies the field is of type
int. All options are enabled by default.DoubleOptions doubleOptions
IndexFieldType specifies the field is of type
double. All options are enabled by default.LiteralOptions literalOptions
IndexFieldType
specifies the field is of type literal. All options are
enabled by default.TextOptions textOptions
IndexFieldType
specifies the field is of type text. A text
field is always searchable. All options are enabled by default.DateOptions dateOptions
IndexFieldType specifies
the field is of type date. All options are enabled by
default.LatLonOptions latLonOptions
IndexFieldType specifies the field is of type
latlon. All options are enabled by default.IntArrayOptions intArrayOptions
IndexFieldType specifies the field is of type
int-array. All options are enabled by default.DoubleArrayOptions doubleArrayOptions
IndexFieldType
specifies the field is of type double-array. All options
are enabled by default.LiteralArrayOptions literalArrayOptions
IndexFieldType specifies the field is of type
literal-array. All options are enabled by default.TextArrayOptions textArrayOptions
IndexFieldType specifies the field is of type
text-array. A text-array field is always
searchable. All options are enabled by default.DateArrayOptions dateArrayOptions
IndexFieldType specifies the field is of type
date-array. All options are enabled by default.IndexField options
IndexFieldType.OptionStatus status
Long defaultValue
String sourceFields
Constraints:
Pattern: \s*[a-z*][a-z0-9_]*\*?\s*(,\s*[a-z*][a-z0-9_]*\*?\s*)*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
Long defaultValue
String sourceField
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
Boolean sortEnabled
String defaultValue
Constraints:
Length: 0 - 1024
String sourceField
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name score is reserved and cannot
be used as a field name. To reference a document's ID, you can use the
name _id.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
Boolean sortEnabled
String defaultValue
Constraints:
Length: 0 - 1024
String sourceFields
Constraints:
Pattern: \s*[a-z*][a-z0-9_]*\*?\s*(,\s*[a-z*][a-z0-9_]*\*?\s*)*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
String defaultValue
Constraints:
Length: 0 - 1024
String sourceField
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name score is reserved and cannot
be used as a field name. To reference a document's ID, you can use the
name _id.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
Boolean sortEnabled
Date creationDate
Date updateDate
Integer updateVersion
Constraints:
Range: 0 -
String state
RequiresIndexDocuments: the option's latest value
will not be deployed until IndexDocuments has been called and
indexing is complete.Processing: the option's
latest value is in the process of being activated. Active: the option's latest value is completely
deployed.FailedToValidate: the option value is
not compatible with the domain's data and cannot be used to index the
data. You must either modify the option value or update or remove the
incompatible documents.
Constraints:
Allowed Values: RequiresIndexDocuments, Processing, Active, FailedToValidate
Boolean pendingDeletion
String desiredInstanceType
search.m1.small.
Constraints:
Allowed Values: search.m1.small, search.m1.large, search.m2.xlarge, search.m2.2xlarge, search.m3.medium, search.m3.large, search.m3.xlarge, search.m3.2xlarge
Integer desiredReplicationCount
Constraints:
Range: 0 -
Integer desiredPartitionCount
m2.2xlarge as the desired
instance type.
Constraints:
Range: 0 -
ScalingParameters options
OptionStatus status
String endpoint
search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com
or
doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com.String suggesterName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
DocumentSuggesterOptions documentSuggesterOptions
Suggester options
FuzzyMatching, SortExpression.OptionStatus status
String defaultValue
Constraints:
Length: 0 - 1024
String sourceFields
Constraints:
Pattern: \s*[a-z*][a-z0-9_]*\*?\s*(,\s*[a-z*][a-z0-9_]*\*?\s*)*
Boolean returnEnabled
Boolean highlightEnabled
String analysisScheme
text-array field.
Constraints:
Pattern: [\S]+
String defaultValue
Constraints:
Length: 0 - 1024
String sourceField
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name score is reserved and cannot
be used as a field name. To reference a document's ID, you can use the
name _id.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
Boolean returnEnabled
Boolean sortEnabled
Boolean highlightEnabled
String analysisScheme
text field.
Constraints:
Pattern: [\S]+
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
Boolean multiAZ
false.AvailabilityOptionsStatus availabilityOptions
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
ScalingParameters scalingParameters
ScalingParametersStatus scalingParameters
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String accessPolicies
AccessPoliciesStatus accessPolicies
String resourceId
Specifies the ARN of the trail to which one or more tags will be added.
The format of a trail ARN is
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail.
com.amazonaws.internal.SdkInternalList<T> tagsList
Contains a list of CloudTrail tags, up to a limit of 10.
String name
Specifies the name of the trail. The name must meet the following requirements:
my-_namespace and my--namespace are invalid.String s3BucketName
Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
String s3KeyPrefix
Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.
String snsTopicName
Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
Boolean includeGlobalServiceEvents
Specifies whether the trail is publishing events from global services such as IAM to the log files.
Boolean isMultiRegionTrail
Specifies whether the trail is created in the current region or in all regions. The default is false.
Boolean enableLogFileValidation
Specifies whether log file integrity validation is enabled. The default is false.
String cloudWatchLogsLogGroupArn
Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.
String cloudWatchLogsRoleArn
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
String kmsKeyId
Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.
Examples:
String name
Specifies the name of the trail.
String s3BucketName
Specifies the name of the Amazon S3 bucket designated for publishing log files.
String s3KeyPrefix
Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.
String snsTopicName
Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
Boolean includeGlobalServiceEvents
Specifies whether the trail is publishing events from global services such as IAM to the log files.
Boolean isMultiRegionTrail
Specifies whether the trail exists in one region or in all regions.
String trailARN
Specifies the ARN of the trail that was created.
Boolean logFileValidationEnabled
Specifies whether log file integrity validation is enabled.
String cloudWatchLogsLogGroupArn
Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.
String cloudWatchLogsRoleArn
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
String kmsKeyId
Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format:
arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012String name
Specifies the name or the CloudTrail ARN of the trail to be deleted. The
format of a trail ARN is
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail.
com.amazonaws.internal.SdkInternalList<T> trailNameList
Specifies a list of trail names, trail ARNs, or both, of the trails to
describe. The format of a trail ARN is
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail. If
an empty list is specified, information for the trail in the current
region is returned.
IncludeShadowTrails is
false, then information for all trails in the current region is returned.
Boolean includeShadowTrails
Specifies whether to include shadow trails in the response. A shadow trail is the replication in a region of a trail that was created in a different region. The default is true.
com.amazonaws.internal.SdkInternalList<T> trailList
The list of trail objects.
String eventId
The CloudTrail ID of the event returned.
String eventName
The name of the event returned.
Date eventTime
The date and time of the event returned.
String username
A user name or role name of the requester that called the API in the event returned.
com.amazonaws.internal.SdkInternalList<T> resources
A list of resources referenced by the event returned.
String cloudTrailEvent
A JSON string that contains a representation of the event returned.
String name
Specifies the name or the CloudTrail ARN of the trail for which you are
requesting status. To get the status of a shadow trail (a replication of
the trail in another region), you must specify its ARN. The format of a
trail ARN is
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail.
Boolean isLogging
Whether the CloudTrail is currently logging AWS API calls.
String latestDeliveryError
Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files to the designated bucket. For more information see the topic Error Responses in the Amazon S3 API Reference.
UpdateTrail to specify the new bucket,
or fix the existing objects so that CloudTrail can again write to the
bucket. String latestNotificationError
Displays any Amazon SNS error that CloudTrail encountered when attempting to send a notification. For more information about Amazon SNS errors, see the Amazon SNS Developer Guide.
Date latestDeliveryTime
Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.
Date latestNotificationTime
Specifies the date and time of the most recent Amazon SNS notification that CloudTrail has written a new log file to an account's Amazon S3 bucket.
Date startLoggingTime
Specifies the most recent date and time when CloudTrail started recording API calls for an AWS account.
Date stopLoggingTime
Specifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account.
String latestCloudWatchLogsDeliveryError
Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.
Date latestCloudWatchLogsDeliveryTime
Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.
Date latestDigestDeliveryTime
Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.
String latestDigestDeliveryError
Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver a digest file to the designated bucket. For more information see the topic Error Responses in the Amazon S3 API Reference.
UpdateTrail to specify the new bucket,
or fix the existing objects so that CloudTrail can again write to the
bucket. String latestDeliveryAttemptTime
This field is deprecated.
String latestNotificationAttemptTime
This field is deprecated.
String latestNotificationAttemptSucceeded
This field is deprecated.
String latestDeliveryAttemptSucceeded
This field is deprecated.
String timeLoggingStarted
This field is deprecated.
String timeLoggingStopped
This field is deprecated.
Date startTime
Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned.
Date endTime
Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used.
String nextToken
Reserved for future use.
com.amazonaws.internal.SdkInternalList<T> publicKeyList
Contains an array of PublicKey objects.
String nextToken
Reserved for future use.
com.amazonaws.internal.SdkInternalList<T> resourceIdList
Specifies a list of trail ARNs whose tags will be listed. The list has a
limit of 20 ARNs. The format of a trail ARN is
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail.
String nextToken
Reserved for future use.
com.amazonaws.internal.SdkInternalList<T> resourceTagList
String nextToken
Reserved for future use.
com.amazonaws.internal.SdkInternalList<T> lookupAttributes
Contains a list of lookup attributes. Currently the list can contain only one item.
Date startTime
Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.
Date endTime
Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.
Integer maxResults
The number of events to return. Possible values are 1 through 50. The default is 10.
String nextToken
The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
com.amazonaws.internal.SdkInternalList<T> events
A list of events returned based on the lookup attributes specified and the CloudTrail event. The events list is sorted by time. The most recent event is listed first.
String nextToken
The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
ByteBuffer value
The DER encoded public key value in PKCS#1 format.
Date validityStartTime
The starting time of validity of the public key.
Date validityEndTime
The ending time of validity of the public key.
String fingerprint
The fingerprint of the public key.
String resourceId
Specifies the ARN of the trail from which tags should be removed. The
format of a trail ARN is
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail.
com.amazonaws.internal.SdkInternalList<T> tagsList
Specifies a list of tags to be removed.
String resourceType
The type of a resource referenced by the event returned. When the resource type cannot be determined, null is returned. Some examples of resource types are: Instance for EC2, Trail for CloudTrail, DBInstance for RDS, and AccessKey for IAM. For a list of resource types supported for event lookup, see Resource Types Supported for Event Lookup.
String resourceName
The name of the resource referenced by the event returned. These are user-created names whose values will depend on the environment. For example, the resource name might be "auto-scaling-test-group" for an Auto Scaling Group or "i-1234567" for an EC2 Instance.
String resourceId
Specifies the ARN of the resource.
com.amazonaws.internal.SdkInternalList<T> tagsList
String name
Specifies the name or the CloudTrail ARN of the trail for which
CloudTrail logs AWS API calls. The format of a trail ARN is
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail.
String name
Specifies the name or the CloudTrail ARN of the trail for which
CloudTrail will stop logging AWS API calls. The format of a trail ARN is
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail.
String name
Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
String s3BucketName
Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.
String s3KeyPrefix
Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.The maximum length is 200 characters.
String snsTopicName
Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered. The maximum length is 256 characters.
Boolean includeGlobalServiceEvents
Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
Boolean isMultiRegionTrail
Specifies whether the trail belongs only to one region or exists in all regions.
String homeRegion
The region in which the trail was created.
String trailARN
The Amazon Resource Name of the trail. The TrailARN format
is arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail.
Boolean logFileValidationEnabled
Specifies whether log file validation is enabled.
String cloudWatchLogsLogGroupArn
Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
String cloudWatchLogsRoleArn
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
String kmsKeyId
Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format:
arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012String name
Specifies the name of the trail or trail ARN. If Name is a
trail name, the string must meet the following requirements:
my-_namespace and my--namespace are invalid.
If Name is a trail ARN, it must be in the format
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail.
String s3BucketName
Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
String s3KeyPrefix
Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.
String snsTopicName
Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
Boolean includeGlobalServiceEvents
Specifies whether the trail is publishing events from global services such as IAM to the log files.
Boolean isMultiRegionTrail
Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted.
Boolean enableLogFileValidation
Specifies whether log file validation is enabled. The default is false.
String cloudWatchLogsLogGroupArn
Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.
String cloudWatchLogsRoleArn
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
String kmsKeyId
Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.
Examples:
String name
Specifies the name of the trail.
String s3BucketName
Specifies the name of the Amazon S3 bucket designated for publishing log files.
String s3KeyPrefix
Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.
String snsTopicName
Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
Boolean includeGlobalServiceEvents
Specifies whether the trail is publishing events from global services such as IAM to the log files.
Boolean isMultiRegionTrail
Specifies whether the trail exists in one region or in all regions.
String trailARN
Specifies the ARN of the trail that was updated.
Boolean logFileValidationEnabled
Specifies whether log file integrity validation is enabled.
String cloudWatchLogsLogGroupArn
Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.
String cloudWatchLogsRoleArn
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
String kmsKeyId
Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format:
arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012String alarmName
The descriptive name for the alarm.
Date timestamp
The time stamp for the alarm history item.
String historyItemType
The type of alarm history item.
String historySummary
A human-readable summary of the alarm history.
String historyData
Machine-readable data about the alarm in JSON format.
Date timestamp
The time stamp used for the datapoint.
Double sampleCount
The number of metric values that contributed to the aggregate value of this datapoint.
Double average
The average of metric values that correspond to the datapoint.
Double sum
The sum of metric values used for the datapoint.
Double minimum
The minimum metric value used for the datapoint.
Double maximum
The maximum of the metric value used for the datapoint.
String unit
The standard unit used for the datapoint.
com.amazonaws.internal.SdkInternalList<T> alarmNames
A list of alarms to be deleted.
String alarmName
The name of the alarm.
String historyItemType
The type of alarm histories to retrieve.
Date startDate
The starting date to retrieve alarm history.
Date endDate
The ending date to retrieve alarm history.
Integer maxRecords
The maximum number of alarm history records to retrieve.
String nextToken
The token returned by a previous call to indicate that there is more data available.
com.amazonaws.internal.SdkInternalList<T> alarmHistoryItems
A list of alarm histories in JSON format.
String nextToken
A string that marks the start of the next batch of returned results.
String metricName
The name of the metric.
String namespace
The namespace of the metric.
String statistic
The statistic for the metric.
com.amazonaws.internal.SdkInternalList<T> dimensions
The list of dimensions associated with the metric.
Integer period
The period in seconds over which the statistic is applied.
String unit
The unit for the metric.
com.amazonaws.internal.SdkInternalList<T> metricAlarms
A list of information for each alarm with the specified metric.
com.amazonaws.internal.SdkInternalList<T> alarmNames
A list of alarm names to retrieve information for.
String alarmNamePrefix
The alarm name prefix. AlarmNames cannot be specified if
this parameter is specified.
String stateValue
The state value to be used in matching alarms.
String actionPrefix
The action name prefix.
Integer maxRecords
The maximum number of alarm descriptions to retrieve.
String nextToken
The token returned by a previous call to indicate that there is more data available.
com.amazonaws.internal.SdkInternalList<T> metricAlarms
A list of information for the specified alarms.
String nextToken
A string that marks the start of the next batch of returned results.
com.amazonaws.internal.SdkInternalList<T> alarmNames
The names of the alarms to disable actions for.
com.amazonaws.internal.SdkInternalList<T> alarmNames
The names of the alarms to enable actions for.
String namespace
The namespace of the metric.
String metricName
The name of the metric.
com.amazonaws.internal.SdkInternalList<T> dimensions
A list of dimensions describing qualities of the metric.
Date startTime
The time stamp to use for determining the first datapoint to return. The value specified is inclusive; results include datapoints with the time stamp specified.
Date endTime
The time stamp to use for determining the last datapoint to return. The value specified is exclusive; results will include datapoints up to the time stamp specified.
Integer period
The granularity, in seconds, of the returned datapoints.
Period must be at least 60 seconds and must be a multiple of
60. The default value is 60.
com.amazonaws.internal.SdkInternalList<T> statistics
The metric statistics to return.
String unit
The unit for the metric.
String label
A label describing the specified metric.
com.amazonaws.internal.SdkInternalList<T> datapoints
The datapoints for the specified metric.
String namespace
The namespace to filter against.
String metricName
The name of the metric to filter against.
com.amazonaws.internal.SdkInternalList<T> dimensions
A list of dimensions to filter against.
String nextToken
The token returned by a previous call to indicate that there is more data available.
com.amazonaws.internal.SdkInternalList<T> metrics
A list of metrics used to generate statistics for an AWS account.
String nextToken
A string that marks the start of the next batch of returned results.
String namespace
The namespace of the metric.
String metricName
The name of the metric.
com.amazonaws.internal.SdkInternalList<T> dimensions
A list of dimensions associated with the metric.
String alarmName
The name of the alarm.
String alarmArn
The Amazon Resource Name (ARN) of the alarm.
String alarmDescription
The description for the alarm.
Date alarmConfigurationUpdatedTimestamp
The time stamp of the last update to the alarm configuration.
Boolean actionsEnabled
Indicates whether actions should be executed during any changes to the alarm's state.
com.amazonaws.internal.SdkInternalList<T> oKActions
The list of actions to execute when this alarm transitions into an
OK state from any other state. Each action is specified as
an Amazon Resource Number (ARN). Currently the only actions supported are
publishing to an Amazon SNS topic and triggering an Auto Scaling policy.
com.amazonaws.internal.SdkInternalList<T> alarmActions
The list of actions to execute when this alarm transitions into an
ALARM state from any other state. Each action is specified
as an Amazon Resource Number (ARN). Currently the only actions supported
are publishing to an Amazon SNS topic and triggering an Auto Scaling
policy.
com.amazonaws.internal.SdkInternalList<T> insufficientDataActions
The list of actions to execute when this alarm transitions into an
INSUFFICIENT_DATA state from any other state. Each action is
specified as an Amazon Resource Number (ARN). Currently the only actions
supported are publishing to an Amazon SNS topic or triggering an Auto
Scaling policy.
String stateValue
The state value for the alarm.
String stateReason
A human-readable explanation for the alarm's state.
String stateReasonData
An explanation for the alarm's state in machine-readable JSON format
Date stateUpdatedTimestamp
The time stamp of the last update to the alarm's state.
String metricName
The name of the alarm's metric.
String namespace
The namespace of alarm's associated metric.
String statistic
The statistic to apply to the alarm's associated metric.
com.amazonaws.internal.SdkInternalList<T> dimensions
The list of dimensions associated with the alarm's associated metric.
Integer period
The period in seconds over which the statistic is applied.
String unit
The unit of the alarm's associated metric.
Integer evaluationPeriods
The number of periods over which data is compared to the specified threshold.
Double threshold
The value against which the specified statistic is compared.
String comparisonOperator
The arithmetic operation to use when comparing the specified
Statistic and Threshold. The specified
Statistic value is used as the first operand.
String metricName
The name of the metric.
com.amazonaws.internal.SdkInternalList<T> dimensions
A list of dimensions associated with the metric.
Date timestamp
The time stamp used for the metric. If not specified, the default value is set to the time the metric data was received.
Double value
The value for the metric.
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
A set of statistical values describing the metric.
String unit
The unit of the metric.
String alarmName
The descriptive name for the alarm. This name must be unique within the user's AWS account
String alarmDescription
The description for the alarm.
Boolean actionsEnabled
Indicates whether or not actions should be executed during any changes to the alarm's state.
com.amazonaws.internal.SdkInternalList<T> oKActions
The list of actions to execute when this alarm transitions into an
OK state from any other state. Each action is specified as
an Amazon Resource Number (ARN). Currently the only action supported is
publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.
com.amazonaws.internal.SdkInternalList<T> alarmActions
The list of actions to execute when this alarm transitions into an
ALARM state from any other state. Each action is specified
as an Amazon Resource Number (ARN). Currently the only action supported
is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.
com.amazonaws.internal.SdkInternalList<T> insufficientDataActions
The list of actions to execute when this alarm transitions into an
INSUFFICIENT_DATA state from any other state. Each action is
specified as an Amazon Resource Number (ARN). Currently the only action
supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling
policy.
String metricName
The name for the alarm's associated metric.
String namespace
The namespace for the alarm's associated metric.
String statistic
The statistic to apply to the alarm's associated metric.
com.amazonaws.internal.SdkInternalList<T> dimensions
The dimensions for the alarm's associated metric.
Integer period
The period in seconds over which the specified statistic is applied.
String unit
The unit for the alarm's associated metric.
Integer evaluationPeriods
The number of periods over which data is compared to the specified threshold.
Double threshold
The value against which the specified statistic is compared.
String comparisonOperator
The arithmetic operation to use when comparing the specified
Statistic and Threshold. The specified
Statistic value is used as the first operand.
String namespace
The namespace for the metric data.
com.amazonaws.internal.SdkInternalList<T> metricData
A list of data describing the metric.
String alarmName
The descriptive name for the alarm. This name must be unique within the user's AWS account. The maximum length is 255 characters.
String stateValue
The value of the state.
String stateReason
The reason that this alarm is set to this specific state (in human-readable text format)
String stateReasonData
The reason that this alarm is set to this specific state (in machine-readable JSON format)
String name
The name of the rule to be deleted.
String name
The name of the rule you want to describe details for.
String name
The rule's name.
String arn
The Amazon Resource Name (ARN) associated with the rule.
String eventPattern
The event pattern.
String scheduleExpression
The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
String state
Specifies whether the rule is enabled or disabled.
String description
The rule's description.
String roleArn
The Amazon Resource Name (ARN) of the IAM role associated with the rule.
String name
The name of the rule you want to disable.
String name
The name of the rule that you want to enable.
Date time
String source
The source of the event.
List<E> resources
AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
String detailType
Free-form string used to decide what fields to expect in the event detail.
String detail
In the JSON sense, an object containing fields, which may also contain nested sub-objects. No constraints are imposed on its contents.
Integer failedEntryCount
The number of failed entries.
List<E> entries
A list of successfully and unsuccessfully ingested events results. If the ingestion was successful, the entry will have the event ID in it. If not, then the ErrorCode and ErrorMessage can be used to identify the problem with the entry.
String name
The name of the rule that you are creating or updating.
String scheduleExpression
The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
String eventPattern
The event pattern.
String state
Indicates whether the rule is enabled or disabled.
String description
A description of the rule.
String roleArn
The Amazon Resource Name (ARN) of the IAM role associated with the rule.
String ruleArn
The Amazon Resource Name (ARN) that identifies the rule.
String targetId
The ID of the target requested to be removed by Amazon CloudWatch Events.
String errorCode
The error code representing why the target removal failed on this entry.
String errorMessage
The error message explaining why the target removal failed on this entry.
String name
The rule's name.
String arn
The Amazon Resource Name (ARN) of the rule.
String eventPattern
The event pattern of the rule.
String state
The rule's state.
String description
The description of the rule.
String scheduleExpression
The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
String roleArn
The Amazon Resource Name (ARN) associated with the role that is used for target invocation.
String id
The unique target assignment ID.
String arn
The Amazon Resource Name (ARN) associated of the target.
String input
Valid JSON text passed to the target. For more information about JSON text, see The JavaScript Object Notation (JSON) Data Interchange Format.
String inputPath
The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. For more information about JSON paths, see JSONPath.
Boolean result
Indicates whether the event matches the event pattern.
String repositoryName
The name of the repository in which you want to create the new branch.
String branchName
The name of the new branch to create.
String commitId
The ID of the commit to point the new branch to.
String repositoryName
The name of the new repository to be created.
String repositoryDescription
A comment or description about the new repository.
RepositoryMetadata repositoryMetadata
Information about the newly created repository.
String repositoryName
The name of the repository to delete.
String repositoryId
The ID of the repository that was deleted.
BranchInfo branch
The name of the branch.
String repositoryName
The name of the repository to get information about.
RepositoryMetadata repositoryMetadata
Information about the repository.
String nextToken
An enumeration token that allows the operation to batch the results of the operation. Batch sizes are 1,000 for list repository operations. When the client sends the token back to AWS CodeCommit, another page of 1,000 records is retrieved.
String sortBy
The criteria used to sort the results of a list repositories operation.
String order
The order in which to sort the results of a list repositories operation.
List<E> repositories
Lists the repositories called by the list repositories operation.
String nextToken
An enumeration token that allows the operation to batch the results of the operation. Batch sizes are 1,000 for list repository operations. When the client sends the token back to AWS CodeCommit, another page of 1,000 records is retrieved.
String accountId
The ID of the AWS account associated with the repository.
String repositoryId
The ID of the repository.
String repositoryName
The repository's name.
String repositoryDescription
A comment or description about the repository.
String defaultBranch
The repository's default branch name.
Date lastModifiedDate
The date and time the repository was last modified, in timestamp format.
Date creationDate
The date and time the repository was created, in timestamp format.
String cloneUrlHttp
The URL to use for cloning the repository over HTTPS.
String cloneUrlSsh
The URL to use for cloning the repository over SSH.
String arn
The Amazon Resource Name (ARN) of the repository.
com.amazonaws.internal.SdkInternalList<T> tags
The tag key-value pairs to add to the on-premises instances.
com.amazonaws.internal.SdkInternalList<T> instanceNames
The names of the on-premises instances to add tags to.
String applicationId
The application ID.
String applicationName
The application name.
Date createTime
The time that the application was created.
Boolean linkedToGitHub
True if the user has authenticated with GitHub for the specified application; otherwise, false.
com.amazonaws.internal.SdkInternalList<T> applicationNames
A list of application names, with multiple application names separated by spaces.
com.amazonaws.internal.SdkInternalList<T> applicationsInfo
Information about the applications.
com.amazonaws.internal.SdkInternalList<T> deploymentIds
A list of deployment IDs, with multiple deployment IDs separated by spaces.
com.amazonaws.internal.SdkInternalList<T> deploymentsInfo
Information about the deployments.
com.amazonaws.internal.SdkInternalList<T> instanceNames
The names of the on-premises instances to get information about.
com.amazonaws.internal.SdkInternalList<T> instanceInfos
Information about the on-premises instances.
String applicationName
The name of the application. This name must be unique with the applicable IAM user or AWS account.
String applicationId
A unique application ID.
String deploymentConfigName
The name of the deployment configuration to create.
MinimumHealthyHosts minimumHealthyHosts
The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.
The type parameter takes either of the following values:
The value parameter takes an integer.
For example, to set a minimum of 95% healthy instances, specify a type of FLEET_PERCENT and a value of 95.
String deploymentConfigId
A unique deployment configuration ID.
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String deploymentGroupName
The name of an existing deployment group for the specified application.
String deploymentConfigName
If specified, the deployment configuration name must be one of the predefined values, or it can be a custom deployment configuration:
To create a custom deployment configuration, call the create deployment configuration operation.
com.amazonaws.internal.SdkInternalList<T> ec2TagFilters
The Amazon EC2 tags to filter on.
com.amazonaws.internal.SdkInternalList<T> onPremisesInstanceTagFilters
The on-premises instance tags to filter on.
com.amazonaws.internal.SdkInternalList<T> autoScalingGroups
A list of associated Auto Scaling groups.
String serviceRoleArn
A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.
String deploymentGroupId
A unique deployment group ID.
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String deploymentGroupName
The deployment group's name.
RevisionLocation revision
The type of revision to deploy, along with information about the revision's location.
String deploymentConfigName
The name of an existing deployment configuration associated with the applicable IAM user or AWS account.
If not specified, the value configured in the deployment group will be used as the default. If the deployment group does not have a deployment configuration associated with it, then CodeDeployDefault.OneAtATime will be used by default.
String description
A comment about the deployment.
Boolean ignoreApplicationStopFailures
If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.
If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed.
String deploymentId
A unique deployment ID.
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String deploymentConfigName
The name of an existing deployment configuration associated with the applicable IAM user or AWS account.
com.amazonaws.internal.SdkInternalList<T> hooksNotCleanedUp
If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling. If the output does contain data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group.
String deploymentConfigId
The deployment configuration ID.
String deploymentConfigName
The deployment configuration name.
MinimumHealthyHosts minimumHealthyHosts
Information about the number or percentage of minimum healthy instances.
Date createTime
The time that the deployment configuration was created.
String applicationName
The application name.
String deploymentGroupId
The deployment group ID.
String deploymentGroupName
The deployment group name.
String deploymentConfigName
The deployment configuration name.
com.amazonaws.internal.SdkInternalList<T> ec2TagFilters
The Amazon EC2 tags to filter on.
com.amazonaws.internal.SdkInternalList<T> onPremisesInstanceTagFilters
The on-premises instance tags to filter on.
com.amazonaws.internal.SdkInternalList<T> autoScalingGroups
A list of associated Auto Scaling groups.
String serviceRoleArn
A service role ARN.
RevisionLocation targetRevision
Information about the deployment group's target revision, including the revision's type and its location.
String applicationName
The application name.
String deploymentGroupName
The deployment group name.
String deploymentConfigName
The deployment configuration name.
String deploymentId
The deployment ID.
RevisionLocation revision
Information about the location of application artifacts that are stored and the service to retrieve them from.
String status
The current state of the deployment as a whole.
ErrorInformation errorInformation
Information about any error associated with this deployment.
Date createTime
A timestamp indicating when the deployment was created.
Date startTime
A timestamp indicating when the deployment began deploying to the deployment group.
Note that in some cases, the reported value of the start time may be later than the complete time. This is due to differences in the clock settings of various back-end servers that participate in the overall deployment process.
Date completeTime
A timestamp indicating when the deployment was completed.
DeploymentOverview deploymentOverview
A summary of the deployment status of the instances in the deployment.
String description
A comment about the deployment.
String creator
How the deployment was created:
Boolean ignoreApplicationStopFailures
If true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.
If false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed.
Long pending
The number of instances that are pending in the deployment.
Long inProgress
The number of instances that are in progress in the deployment.
Long succeeded
The number of instances that have succeeded in the deployment.
Long failed
The number of instances that have failed in the deployment.
Long skipped
The number of instances that have been skipped in the deployment.
String instanceName
The name of the on-premises instance to deregister.
String errorCode
The associated error code:
String scriptName
The name of the script.
String message
The message associated with the error.
String logTail
The last portion of the associated diagnostic log.
String code
The error code:
String message
An accompanying error message.
String description
A comment about the revision.
com.amazonaws.internal.SdkInternalList<T> deploymentGroups
A list of deployment groups that use this revision.
Date firstUsedTime
When the revision was first used by AWS CodeDeploy.
Date lastUsedTime
When the revision was last used by AWS CodeDeploy.
Date registerTime
When the revision was registered with AWS CodeDeploy.
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
ApplicationInfo application
Information about the application.
String applicationName
The name of the application that corresponds to the revision.
RevisionLocation revision
Information about the application revision to get, including the revision's type and its location.
String applicationName
The name of the application that corresponds to the revision.
RevisionLocation revision
Additional information about the revision, including the revision's type and its location.
GenericRevisionInfo revisionInfo
General information about the revision.
String deploymentConfigName
The name of an existing deployment configuration associated with the applicable IAM user or AWS account.
DeploymentConfigInfo deploymentConfigInfo
Information about the deployment configuration.
DeploymentGroupInfo deploymentGroupInfo
Information about the deployment group.
InstanceSummary instanceSummary
Information about the instance.
String deploymentId
An existing deployment ID associated with the applicable IAM user or AWS account.
DeploymentInfo deploymentInfo
Information about the deployment.
String instanceName
The name of the on-premises instance to get information about
InstanceInfo instanceInfo
Information about the on-premises instance.
String repository
The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision.
Specified as account/repository.
String commitId
The SHA1 commit ID of the GitHub commit that references the that represents the bundled artifacts for the application revision.
String instanceName
The name of the on-premises instance.
String iamUserArn
The IAM user ARN associated with the on-premises instance.
String instanceArn
The ARN of the on-premises instance.
Date registerTime
The time that the on-premises instance was registered.
Date deregisterTime
If the on-premises instance was deregistered, the time that the on-premises instance was deregistered.
com.amazonaws.internal.SdkInternalList<T> tags
Information about the tags for the on-premises instance.
String deploymentId
The deployment ID.
String instanceId
The instance ID.
String status
The deployment status for this instance:
Date lastUpdatedAt
A timestamp indicating when the instance information was last updated.
com.amazonaws.internal.SdkInternalList<T> lifecycleEvents
A list of lifecycle events for this instance.
String lifecycleEventName
The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, AfterInstall, ApplicationStart, or ValidateService.
Diagnostics diagnostics
Diagnostic information about the deployment lifecycle event.
Date startTime
A timestamp indicating when the deployment lifecycle event started.
Date endTime
A timestamp indicating when the deployment lifecycle event ended.
String status
The deployment lifecycle event status:
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String sortBy
The column name to sort the list results by:
If not specified or set to null, the results will be returned in an arbitrary order.
String sortOrder
The order to sort the list results by:
If not specified, the results will be sorted in ascending order.
If set to null, the results will be sorted in an arbitrary order.
String s3Bucket
A specific Amazon S3 bucket name to limit the search for revisions.
If set to null, then all of the user's buckets will be searched.
String s3KeyPrefix
A specific key prefix for the set of Amazon S3 objects to limit the search for revisions.
String deployed
Whether to list revisions based on whether the revision is the target revision of an deployment group:
String nextToken
An identifier that was returned from the previous list application revisions call, which can be used to return the next set of applications in the list.
com.amazonaws.internal.SdkInternalList<T> revisions
A list of revision locations that contain the matching revisions.
String nextToken
If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list application revisions call to return the next set of application revisions in the list.
String nextToken
An identifier that was returned from the previous list applications call, which can be used to return the next set of applications in the list.
com.amazonaws.internal.SdkInternalList<T> applications
A list of application names.
String nextToken
If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list applications call to return the next set of applications in the list.
String nextToken
An identifier that was returned from the previous list deployment configurations call, which can be used to return the next set of deployment configurations in the list.
com.amazonaws.internal.SdkInternalList<T> deploymentConfigsList
A list of deployment configurations, including the built-in configurations such as CodeDeployDefault.OneAtATime.
String nextToken
If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list deployment configurations call to return the next set of deployment configurations in the list.
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String nextToken
An identifier that was returned from the previous list deployment groups call, which can be used to return the next set of deployment groups in the list.
String applicationName
The application name.
com.amazonaws.internal.SdkInternalList<T> deploymentGroups
A list of corresponding deployment group names.
String nextToken
If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list deployment groups call to return the next set of deployment groups in the list.
String deploymentId
The unique ID of a deployment.
String nextToken
An identifier that was returned from the previous list deployment instances call, which can be used to return the next set of deployment instances in the list.
com.amazonaws.internal.SdkInternalList<T> instanceStatusFilter
A subset of instances to list, by status:
com.amazonaws.internal.SdkInternalList<T> instancesList
A list of instances IDs.
String nextToken
If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list deployment instances call to return the next set of deployment instances in the list.
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String deploymentGroupName
The name of an existing deployment group for the specified application.
com.amazonaws.internal.SdkInternalList<T> includeOnlyStatuses
A subset of deployments to list, by status:
TimeRange createTimeRange
A deployment creation start- and end-time range for returning a subset of the list of deployments.
String nextToken
An identifier that was returned from the previous list deployments call, which can be used to return the next set of deployments in the list.
com.amazonaws.internal.SdkInternalList<T> deployments
A list of deployment IDs.
String nextToken
If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list deployments call to return the next set of deployments in the list.
String registrationStatus
The on-premises instances registration status:
com.amazonaws.internal.SdkInternalList<T> tagFilters
The on-premises instance tags that will be used to restrict the corresponding on-premises instance names that are returned.
String nextToken
An identifier that was returned from the previous list on-premises instances call, which can be used to return the next set of on-premises instances in the list.
com.amazonaws.internal.SdkInternalList<T> instanceNames
The list of matching on-premises instance names.
String nextToken
If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list on-premises instances call to return the next set of on-premises instances in the list.
Integer value
The minimum healthy instances value.
String type
The minimum healthy instances type:
For example, for 9 instances, if a HOST_COUNT of 6 is specified, deploy to up to 3 instances at a time. The deployment succeeds if 6 or more instances are successfully deployed to; otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to 5 instances at a time. The deployment succeeds if 4 or more instances are successfully deployed to; otherwise, the deployment fails.
String applicationName
The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.
String description
A comment about the revision.
RevisionLocation revision
Information about the application revision to register, including the revision's type and its location.
com.amazonaws.internal.SdkInternalList<T> tags
The tag key-value pairs to remove from the on-premises instances.
com.amazonaws.internal.SdkInternalList<T> instanceNames
The names of the on-premises instances to remove tags from.
String revisionType
The application revision's type:
S3Location s3Location
GitHubLocation gitHubLocation
String bucket
The name of the Amazon S3 bucket where the application revision is stored.
String key
The name of the Amazon S3 object that represents the bundled artifacts for the application revision.
String bundleType
The file type of the application revision. Must be one of the following:
String version
A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.
If the version is not specified, the system will use the most recent version by default.
String eTag
The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.
If the ETag is not specified as an input parameter, ETag validation of the object will be skipped.
String deploymentId
The unique ID of a deployment.
String applicationName
The application name corresponding to the deployment group to update.
String currentDeploymentGroupName
The current name of the existing deployment group.
String newDeploymentGroupName
The new name of the deployment group, if you want to change it.
String deploymentConfigName
The replacement deployment configuration name to use, if you want to change it.
com.amazonaws.internal.SdkInternalList<T> ec2TagFilters
The replacement set of Amazon EC2 tags to filter on, if you want to change them.
com.amazonaws.internal.SdkInternalList<T> onPremisesInstanceTagFilters
The replacement set of on-premises instance tags for filter on, if you want to change them.
com.amazonaws.internal.SdkInternalList<T> autoScalingGroups
The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.
String serviceRoleArn
A replacement service role's ARN, if you want to change it.
com.amazonaws.internal.SdkInternalList<T> hooksNotCleanedUp
If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the AWS account. If the output does contain data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the AWS account.
String status
Whether the job worker has received the specified job.
String jobId
The unique system-generated ID of the job.
String nonce
A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.
String clientToken
The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
String status
The status information for the third party job, if any.
String name
The name of the action configuration property.
Boolean required
Whether the configuration property is a required value.
Boolean key
Whether the configuration property is a key.
Boolean secret
Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.
When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret.
Boolean queryable
Indicates that the proprety will be used in conjunction with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.
If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
String description
The description of the action configuration property that will be displayed to users.
String type
The type of the configuration property.
String name
The name of the action within the context of a job.
String name
The action declaration's name.
ActionTypeId actionTypeId
The configuration information for the action type.
Integer runOrder
The order in which actions are run.
Map<K,V> configuration
The action declaration's configuration.
List<E> outputArtifacts
The name or ID of the result of the action declaration, such as a test or build artifact.
List<E> inputArtifacts
The name or ID of the artifact consumed by the action, such as a test or build artifact.
String roleArn
The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline.
String status
The status of the action, or for a completed action, the last status of the action.
String summary
A summary of the run of the action.
Date lastStatusChange
The last status change of the action.
String externalExecutionId
The external ID of the run of the action.
String externalExecutionUrl
The URL of a resource external to AWS that will be used when running the action, for example an external repository URL.
Integer percentComplete
A percentage of completeness of the action as it runs.
ErrorDetails errorDetails
The details of an error returned by a URL external to AWS.
String revisionId
The system-generated unique ID that identifies the revision number of the action.
String revisionChangeId
The unique identifier of the change that set the state to this revision, for example a deployment ID or timestamp.
Date created
The date and time when the most recent version of the action was created, in timestamp format.
String actionName
The name of the action.
ActionRevision currentRevision
ActionExecution latestExecution
String entityUrl
A URL link for more information about the state of the action, such as a deployment group details page.
String revisionUrl
A URL link for more information about the revision, such as a commit details page.
ActionTypeId id
ActionTypeSettings settings
The settings for the action type.
List<E> actionConfigurationProperties
The configuration properties for the action type.
ArtifactDetails inputArtifactDetails
The details of the input artifact for the action, such as its commit ID.
ArtifactDetails outputArtifactDetails
The details of the output artifact of the action, such as its commit ID.
String category
A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below.
String owner
The creator of the action being called.
String provider
The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy.
String version
A string that identifies the action type.
String thirdPartyConfigurationUrl
The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.
String entityUrlTemplate
The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display within the pipeline.
String executionUrlTemplate
The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.
String revisionUrlTemplate
The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
String name
The artifact's name.
String revision
The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).
ArtifactLocation location
The location of an artifact.
String type
The type of artifact in the location.
S3ArtifactLocation s3Location
The Amazon S3 bucket that contains the artifact.
String type
The type of the artifact store, such as S3.
String location
The location for storing the artifacts for a pipeline, such as an S3 bucket or folder.
EncryptionKey encryptionKey
String category
The category of the custom action, such as a source action or a build action.
String provider
The provider of the service used in the custom action, such as AWS CodeDeploy.
String version
The version number of the custom action.
1. This is required.ActionTypeSettings settings
List<E> configurationProperties
The configuration properties for the custom action.
ArtifactDetails inputArtifactDetails
ArtifactDetails outputArtifactDetails
ActionType actionType
PipelineDeclaration pipeline
PipelineDeclaration pipeline
String name
The name of the pipeline to be deleted.
String pipelineName
The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
String stageName
The name of the stage where you want to disable the inbound or outbound transition of artifacts.
String transitionType
Specifies whether artifacts will be prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).
String reason
The reason given to the user why a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.
String pipelineName
The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.
String stageName
The name of the stage where you want to enable the transition of artifacts, either into the stage (inbound) or from that stage to the next stage (outbound).
String transitionType
Specifies whether artifacts will be allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already-processed artifacts will be allowed to transition to the next stage (outbound).
String summary
The summary of the current status of the actions.
String externalExecutionId
The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.
Integer percentComplete
The percentage of work completed on the action, represented on a scale of zero to one hundred percent.
String jobId
The unique system-generated ID for the job.
JobDetails jobDetails
The details of the job.
If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.
PipelineDeclaration pipeline
String name
The name of the pipeline about which you want to get information.
String pipelineName
The name of the pipeline for which you want to get the state.
Integer pipelineVersion
The version number of the pipeline.
1.List<E> stageStates
A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.
Date created
The date and time the pipeline was created, in timestamp format.
Date updated
The date and time the pipeline was last updated, in timestamp format.
ThirdPartyJobDetails jobDetails
The details of the job, including any protected values defined for the job.
String name
The name of the artifact to be worked on, for example, "My App".
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
String id
The unique system-generated ID of the job.
JobData data
Additional data about a job.
String nonce
A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.
String accountId
The ID of the AWS account to use when performing the job.
ActionTypeId actionTypeId
ActionConfiguration actionConfiguration
PipelineContext pipelineContext
List<E> inputArtifacts
The artifact supplied to the job.
List<E> outputArtifacts
The output of the job.
AWSSessionCredentials artifactCredentials
String continuationToken
A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.
EncryptionKey encryptionKey
String nextToken
An identifier that was returned from the previous list pipelines call, which can be used to return the next set of pipelines in the list.
String name
The name of the output of an artifact, such as "My App".
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
Output artifact names must be unique within a pipeline.
String pipelineName
The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.
StageContext stage
The stage of the pipeline.
ActionContext action
String name
The name of the action to be performed.
String roleArn
The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.
ArtifactStore artifactStore
List<E> stages
The stage in which to perform the action.
Integer version
The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically incremented when a pipeline is updated.
ActionTypeId actionTypeId
Integer maxBatchSize
The maximum number of jobs to return in a poll for jobs call.
Map<K,V> queryParam
A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value will be returned.
ActionTypeId actionTypeId
Integer maxBatchSize
The maximum number of jobs to return in a poll for jobs call.
String pipelineName
The name of the pipeline that will start processing the revision to the source.
String stageName
The name of the stage that contains the action that will act upon the revision.
String actionName
The name of the action that will process the revision.
ActionRevision actionRevision
String jobId
The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.
FailureDetails failureDetails
The details about the failure of a job.
String jobId
The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.
CurrentRevision currentRevision
The ID of the current revision of the artifact successfully worked upon by the job.
String continuationToken
A system-generated token, such as a AWS CodeDeploy deployment ID, that the successful job used to complete a job asynchronously.
ExecutionDetails executionDetails
The execution details of the successful job, such as the actions taken by the job worker.
String jobId
The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.
String clientToken
The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
FailureDetails failureDetails
String jobId
The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs.
String clientToken
The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
CurrentRevision currentRevision
String continuationToken
A system-generated token, such as a AWS CodeDeploy deployment ID, that a job uses in order to continue the job asynchronously.
ExecutionDetails executionDetails
String name
The name of the stage.
String stageName
The name of the stage.
TransitionState inboundTransitionState
The state of the inbound transition, which is either enabled or disabled.
List<E> actionStates
The state of the stage.
String name
The name of the pipeline to start.
String pipelineExecutionId
The unique system-generated ID of the pipeline that was started.
ActionTypeId actionTypeId
ActionConfiguration actionConfiguration
PipelineContext pipelineContext
List<E> inputArtifacts
The name of the artifact that will be worked upon by the action, if any. This name might be system-generated, such as "MyApp", or might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.
List<E> outputArtifacts
The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or might be defined by the user when the action is created.
AWSSessionCredentials artifactCredentials
String continuationToken
A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.
EncryptionKey encryptionKey
String id
The identifier used to identify the job details in AWS CodePipeline.
ThirdPartyJobData data
The data to be returned by the third party job worker.
String nonce
A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.
Boolean enabled
Whether the transition between stages is enabled (true) or disabled (false).
String lastChangedBy
The ID of the user who last changed the transition state.
Date lastChangedAt
The timestamp when the transition state was last changed.
String disabledReason
The user-specified reason why the transition between two stages of a pipeline was disabled.
PipelineDeclaration pipeline
The name of the pipeline to be updated.
PipelineDeclaration pipeline
The structure of the updated pipeline.
String identityPoolName
A string that you provide.
Boolean allowUnauthenticatedIdentities
TRUE if the identity pool supports unauthenticated logins.
Map<K,V> supportedLoginProviders
Optional key:value pairs mapping provider names to provider app IDs.
String developerProviderName
The "domain" by which Cognito will refer to your users. This name acts as
a placeholder that allows your backend and the Cognito service to
communicate about the developer provider. For the
DeveloperProviderName, you can use letters as well as period
(.), underscore (_), and dash (-).
Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.
List<E> openIdConnectProviderARNs
A list of OpendID Connect provider ARNs.
String identityPoolId
String identityPoolName
A string that you provide.
Boolean allowUnauthenticatedIdentities
Map<K,V> supportedLoginProviders
Optional key:value pairs mapping provider names to provider app IDs.
String developerProviderName
The "domain" by which Cognito will refer to your users.
List<E> openIdConnectProviderARNs
A list of OpendID Connect provider ARNs.
String accessKeyId
The Access Key portion of the credentials.
String secretKey
The Secret Access Key portion of the credentials
String sessionToken
The Session Token portion of the credentials
Date expiration
The date at which these credentials will expire.
String identityPoolId
String identityPoolId
String identityPoolId
String identityPoolName
A string that you provide.
Boolean allowUnauthenticatedIdentities
Map<K,V> supportedLoginProviders
Optional key:value pairs mapping provider names to provider app IDs.
String developerProviderName
The "domain" by which Cognito will refer to your users.
List<E> openIdConnectProviderARNs
A list of OpendID Connect provider ARNs.
String identityId
A unique identifier in the format REGION:GUID.
String identityId
List<E> logins
Date creationDate
Date on which the identity was created.
Date lastModifiedDate
Date on which the identity was last modified.
String identityId
A unique identifier in the format REGION:GUID.
Credentials credentials
Credentials for the provided identity ID.
String identityPoolId
An identity pool ID in the format REGION:GUID.
String accountId
String identityPoolId
Map<K,V> logins
A set of optional name-value pairs that map provider names to provider tokens.
The available provider names for Logins are as follows:
graph.facebook.comaccounts.google.comwww.amazon.comapi.twitter.comwww.digits.comString identityId
String identityPoolId
An identity pool ID in the format REGION:GUID.
String identityId
A unique identifier in the format REGION:GUID.
Map<K,V> logins
A set of optional name-value pairs that map provider names to provider
tokens. Each name-value pair represents a user from a public provider or
developer provider. If the user is from a developer provider, the
name-value pair will follow the syntax
"developer_provider_name": "developer_user_identifier". The
developer provider is the "domain" by which Cognito will refer to your
users; you provided this domain while creating/updating the identity
pool. The developer user identifier is an identifier from your backend
that uniquely identifies a user. When you create an identity pool, you
can specify the supported logins.
Long tokenDuration
The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration.
String identityId
Map<K,V> logins
String identityId
List<E> logins
Date creationDate
Date on which the identity was created.
Date lastModifiedDate
Date on which the identity was last modified.
String identityPoolId
Integer maxResults
String nextToken
Boolean hideDisabled
An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.
String identityPoolId
An identity pool ID in the format REGION:GUID.
String identityId
A unique identifier in the format REGION:GUID.
String developerUserIdentifier
A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.
Integer maxResults
The maximum number of identities to return.
String nextToken
A pagination token. The first call you make will have
NextToken set to null. After that the service will return
NextToken values as needed. For example, let's say you make
a request with MaxResults set to 10, and there are 20
matches in the database. The service will return a pagination token as a
part of the response. This token can be used to call the API again and
get results starting from the 11th match.
String identityId
A unique identifier in the format REGION:GUID.
List<E> developerUserIdentifierList
This is the list of developer user identifiers associated with an identity ID. Cognito supports the association of multiple developer user identifiers with an identity ID.
String nextToken
A pagination token. The first call you make will have
NextToken set to null. After that the service will return
NextToken values as needed. For example, let's say you make
a request with MaxResults set to 10, and there are 20
matches in the database. The service will return a pagination token as a
part of the response. This token can be used to call the API again and
get results starting from the 11th match.
String sourceUserIdentifier
User identifier for the source user. The value should be a
DeveloperUserIdentifier.
String destinationUserIdentifier
User identifier for the destination user. The value should be a
DeveloperUserIdentifier.
String developerProviderName
The "domain" by which Cognito will refer to your users. This is a
(pseudo) domain name that you provide while creating an identity pool.
This name acts as a placeholder that allows your backend and the Cognito
service to communicate about the developer provider. For the
DeveloperProviderName, you can use letters as well as period
(.), underscore (_), and dash (-).
String identityPoolId
An identity pool ID in the format REGION:GUID.
String identityId
A unique identifier in the format REGION:GUID.
String identityId
A unique identifier in the format REGION:GUID.
String identityPoolId
An identity pool ID in the format REGION:GUID.
String developerProviderName
The "domain" by which Cognito will refer to your users.
String developerUserIdentifier
String identityPoolId
String identityPoolName
A string that you provide.
Boolean allowUnauthenticatedIdentities
Map<K,V> supportedLoginProviders
Optional key:value pairs mapping provider names to provider app IDs.
String developerProviderName
The "domain" by which Cognito will refer to your users.
List<E> openIdConnectProviderARNs
A list of OpendID Connect provider ARNs.
String identityPoolId
String identityPoolName
A string that you provide.
Boolean allowUnauthenticatedIdentities
Map<K,V> supportedLoginProviders
Optional key:value pairs mapping provider names to provider app IDs.
String developerProviderName
The "domain" by which Cognito will refer to your users.
List<E> openIdConnectProviderARNs
A list of OpendID Connect provider ARNs.
String identityPoolId
String identityPoolId
String streamName
String roleArn
String streamingStatus
ENABLED - Streaming of updates to identity pool is enabled.
DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.
String identityId
String datasetName
Date creationDate
Date lastModifiedDate
String lastModifiedBy
Long dataStorage
Long numRecords
String identityPoolId
String identityId
String datasetName
Dataset dataset
String identityPoolId
String identityId
String datasetName
Dataset dataset
String identityPoolId
IdentityPoolUsage identityPoolUsage
String identityPoolId
String identityId
IdentityUsage identityUsage
String identityPoolId
String identityPoolId
Date bulkPublishStartTime
Date bulkPublishCompleteTime
String bulkPublishStatus
NOT_STARTED - No bulk publish has been requested for this identity pool
IN_PROGRESS - Data is being published to the configured stream
SUCCEEDED - All data for the identity pool has been published to the configured stream
FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.
String failureMessage
String identityPoolId
The Cognito Identity Pool ID for the request
com.amazonaws.internal.SdkInternalMap<K,V> events
The Cognito Events returned from the GetCognitoEvents request
String identityPoolId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool for which to return a configuration.
String identityPoolId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
PushSync pushSync
Options to apply to this identity pool for push synchronization.
CognitoStreams cognitoStreams
String identityPoolId
Long syncSessionsCount
Long dataStorage
Date lastModifiedDate
String identityId
String identityPoolId
Date lastModifiedDate
Integer datasetCount
Long dataStorage
String identityPoolId
String identityId
String nextToken
Integer maxResults
com.amazonaws.internal.SdkInternalList<T> datasets
Integer count
String nextToken
com.amazonaws.internal.SdkInternalList<T> identityPoolUsages
Integer maxResults
Integer count
String nextToken
String identityPoolId
String identityId
String datasetName
Long lastSyncCount
String nextToken
Integer maxResults
String syncSessionToken
com.amazonaws.internal.SdkInternalList<T> records
String nextToken
Integer count
Long datasetSyncCount
String lastModifiedBy
com.amazonaws.internal.SdkInternalList<T> mergedDatasetNames
Boolean datasetExists
Boolean datasetDeletedAfterRequestedSyncCount
String syncSessionToken
com.amazonaws.internal.SdkInternalList<T> applicationArns
List of SNS platform application ARNs that could be used by clients.
String roleArn
A role configured to allow Cognito to call SNS on behalf of the developer.
String key
String value
Long syncCount
Date lastModifiedDate
String lastModifiedBy
Date deviceLastModifiedDate
String op
String key
String value
Long syncCount
Date deviceLastModifiedDate
String identityPoolId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to.
String identityId
The unique ID for this identity.
String platform
The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).
String token
The push token.
String deviceId
The unique ID generated for this device by Cognito.
String identityPoolId
The Cognito Identity Pool to use when configuring Cognito Events
com.amazonaws.internal.SdkInternalMap<K,V> events
The events to configure
String identityPoolId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool to modify.
PushSync pushSync
Options to apply to this identity pool for push synchronization.
CognitoStreams cognitoStreams
String identityPoolId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
PushSync pushSync
Options to apply to this identity pool for push synchronization.
CognitoStreams cognitoStreams
String identityPoolId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which the identity belongs.
String identityId
Unique ID for this identity.
String datasetName
The name of the dataset to subcribe to.
String deviceId
The unique ID generated for this device by Cognito.
String identityPoolId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which this identity belongs.
String identityId
Unique ID for this identity.
String datasetName
The name of the dataset from which to unsubcribe.
String deviceId
The unique ID generated for this device by Cognito.
String identityPoolId
String identityId
String datasetName
String deviceId
The unique ID generated for this device by Cognito.
com.amazonaws.internal.SdkInternalList<T> recordPatches
String syncSessionToken
String clientContext
com.amazonaws.internal.SdkInternalList<T> records
String complianceType
Indicates whether an AWS resource or AWS Config rule is compliant.
A resource is compliant if it complies with all of the AWS Config rules that evaluate it, and it is noncompliant if it does not comply with one or more of these rules.
A rule is compliant if all of the resources that the rule evaluates comply with it, and it is noncompliant if any of these resources do not comply.
ComplianceContributorCount complianceContributorCount
The number of AWS resources or AWS Config rules that cause a result of
NON_COMPLIANT, up to a maximum of 25.
String configRuleName
The name of the AWS Config rule.
Compliance compliance
Indicates whether the AWS Config rule is compliant.
String resourceType
The type of the AWS resource that was evaluated.
String resourceId
The ID of the AWS resource that was evaluated.
Compliance compliance
Indicates whether the AWS resource complies with all of the AWS Config rules that evaluated it.
ComplianceContributorCount compliantResourceCount
The number of AWS Config rules or AWS resources that are compliant, up to a maximum of 25 for rules and 100 for resources.
ComplianceContributorCount nonCompliantResourceCount
The number of AWS Config rules or AWS resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources.
Date complianceSummaryTimestamp
The time that AWS Config created the compliance summary.
String resourceType
The type of AWS resource.
ComplianceSummary complianceSummary
The number of AWS resources that are compliant or noncompliant, up to a maximum of 100 for each compliance.
String lastStatus
Status of the last attempted delivery.
String lastErrorCode
The error code from the last attempted delivery.
String lastErrorMessage
The error message from the last attempted delivery.
Date lastAttemptTime
The time of the last attempted delivery.
Date lastSuccessfulTime
The time of the last successful delivery.
Date nextDeliveryTime
The time that the next delivery occurs.
String configRuleName
The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.
String configRuleArn
The Amazon Resource Name (ARN) of the AWS Config rule.
String configRuleId
The ID of the AWS Config rule.
String description
The description that you provide for the AWS Config rule.
Scope scope
Defines which resources the AWS Config rule evaluates. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one or more resource IDs. Specify a scope to constrain the resources that are evaluated. If you do not specify a scope, the AWS Config Rule evaluates all resources in the recording group.
Source source
Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.
String inputParameters
A string in JSON format that is passed to the AWS Config rule Lambda function.
String maximumExecutionFrequency
The maximum frequency at which the AWS Config rule runs evaluations.
If your rule is periodic, meaning it runs an evaluation when AWS Config
delivers a configuration snapshot, then it cannot run evaluations more
frequently than AWS Config delivers the snapshots. For periodic rules,
set the value of the MaximumExecutionFrequency key to be
equal to or greater than the value of the deliveryFrequency
key, which is part of ConfigSnapshotDeliveryProperties. To
update the frequency with which AWS Config delivers your snapshots, use
the PutDeliveryChannel action.
String configRuleState
Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.
AWS Config sets the state of a rule to DELETING temporarily
after you use the DeleteConfigRule request to delete the
rule. After AWS Config finishes deleting a rule, the rule and all of its
evaluations are erased and no longer available.
You cannot add a rule to AWS Config that has the state set to
DELETING. If you want to delete a rule, you must use the
DeleteConfigRule request.
String configRuleName
The name of the AWS Config rule.
String configRuleArn
The Amazon Resource Name (ARN) of the AWS Config rule.
String configRuleId
The ID of the AWS Config rule.
Date lastSuccessfulInvocationTime
The time that AWS Config last successfully invoked the AWS Config rule to evaluate your AWS resources.
Date lastFailedInvocationTime
The time that AWS Config last failed to invoke the AWS Config rule to evaluate your AWS resources.
Date lastSuccessfulEvaluationTime
The time that AWS Config last successfully evaluated your AWS resources against the rule.
Date lastFailedEvaluationTime
The time that AWS Config last failed to evaluate your AWS resources against the rule.
Date firstActivatedTime
The time that you first activated the AWS Config rule.
String lastErrorCode
The error code that AWS Config returned when the rule last failed.
String lastErrorMessage
The error message that AWS Config returned when the rule last failed.
Boolean firstEvaluationStarted
Indicates whether AWS Config has evaluated your resources against the rule at least once.
true - AWS Config has evaluated your AWS resources
against the rule at least once.false - AWS Config has not once finished evaluating your
AWS resources against the rule.String deliveryFrequency
The frequency with which a AWS Config recurringly delivers configuration snapshots.
String lastStatus
Status of the last attempted delivery.
Note Providing an SNS topic on a DeliveryChannel for AWS Config is optional. If the SNS delivery is turned off, the last status will be Not_Applicable.
String lastErrorCode
The error code from the last attempted delivery.
String lastErrorMessage
The error message from the last attempted delivery.
Date lastStatusChangeTime
The time from the last status change.
String version
The version number of the resource configuration.
String accountId
The 12 digit AWS account ID associated with the resource.
Date configurationItemCaptureTime
The time when the configuration recording was initiated.
String configurationItemStatus
The configuration item status.
String configurationStateId
An identifier that indicates the ordering of the configuration items of a resource.
String configurationItemMD5Hash
Unique MD5 hash that represents the configuration item's state.
You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.
String arn
The Amazon Resource Name (ARN) of the resource.
String resourceType
The type of AWS resource.
String resourceId
The ID of the resource (for example., sg-xxxxxx).
String resourceName
The custom name of the resource, if available.
String awsRegion
The region where the resource resides.
String availabilityZone
The Availability Zone associated with the resource.
Date resourceCreationTime
The time stamp when the resource was created.
Map<K,V> tags
A mapping of key value tags associated with the resource.
com.amazonaws.internal.SdkInternalList<T> relatedEvents
A list of CloudTrail event IDs.
A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What is AWS CloudTrail?.
An empty field indicates that the current configuration was not initiated by any event.
com.amazonaws.internal.SdkInternalList<T> relationships
A list of related AWS resources.
String configuration
The description of the resource configuration.
String name
The name of the recorder. By default, AWS Config automatically assigns the name "default" when creating the configuration recorder. You cannot change the assigned name.
String roleARN
Amazon Resource Name (ARN) of the IAM role used to describe the AWS resources associated with the account.
RecordingGroup recordingGroup
Specifies the types of AWS resource for which AWS Config records configuration changes.
String name
The name of the configuration recorder.
Date lastStartTime
The time the recorder was last started.
Date lastStopTime
The time the recorder was last stopped.
Boolean recording
Specifies whether the recorder is currently recording or not.
String lastStatus
The last (previous) status of the recorder.
String lastErrorCode
The error code indicating that the recording failed.
String lastErrorMessage
The message indicating that the recording failed due to an error.
Date lastStatusChangeTime
The time when the status was last changed.
String configRuleName
The name of the AWS Config rule that you want to delete.
String deliveryChannelName
The name of the delivery channel to delete.
String deliveryChannelName
The name of the delivery channel through which the snapshot is delivered.
String configSnapshotId
The ID of the snapshot that is being created.
String name
The name of the delivery channel. By default, AWS Config automatically assigns the name "default" when creating the delivery channel. You cannot change the assigned name.
String s3BucketName
The name of the Amazon S3 bucket used to store configuration history for the delivery channel.
String s3KeyPrefix
The prefix for the specified Amazon S3 bucket.
String snsTopicARN
The Amazon Resource Name (ARN) of the SNS topic that AWS Config delivers notifications to.
ConfigSnapshotDeliveryProperties configSnapshotDeliveryProperties
String name
The name of the delivery channel.
ConfigExportDeliveryInfo configSnapshotDeliveryInfo
A list containing the status of the delivery of the snapshot to the specified Amazon S3 bucket.
ConfigExportDeliveryInfo configHistoryDeliveryInfo
A list that contains the status of the delivery of the configuration history to the specified Amazon S3 bucket.
ConfigStreamDeliveryInfo configStreamDeliveryInfo
A list containing the status of the delivery of the configuration stream notification to the specified Amazon SNS topic.
com.amazonaws.internal.SdkInternalList<T> configRuleNames
Specify one or more AWS Config rule names to filter the results by rule.
com.amazonaws.internal.SdkInternalList<T> complianceTypes
Filters the results by compliance. The valid values are
Compliant and NonCompliant.
String nextToken
The nextToken string returned on a previous page that you
use to get the next page of results in a paginated response.
com.amazonaws.internal.SdkInternalList<T> complianceByConfigRules
Indicates whether each of the specified AWS Config rules is compliant.
String nextToken
The string that you use in a subsequent request to get the next page of results in a paginated response.
String resourceType
The types of AWS resources for which you want compliance information; for
example, AWS::EC2::Instance. For this action, you can
specify that the resource type is an AWS account by specifying
AWS::::Account.
String resourceId
The ID of the AWS resource for which you want compliance information. You
can specify only one resource ID. If you specify a resource ID, you must
also specify a type for ResourceType.
com.amazonaws.internal.SdkInternalList<T> complianceTypes
Filters the results by compliance. The valid values are
Compliant and NonCompliant.
Integer limit
The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.
String nextToken
The nextToken string returned on a previous page that you
use to get the next page of results in a paginated response.
com.amazonaws.internal.SdkInternalList<T> complianceByResources
Indicates whether the specified AWS resource complies with all of the AWS Config rules that evaluate it.
String nextToken
The string that you use in a subsequent request to get the next page of results in a paginated response.
com.amazonaws.internal.SdkInternalList<T> configRuleNames
The name of the AWS managed Config rules for which you want status information. If you do not specify any names, AWS Config returns status information for all AWS managed Config rules that you use.
com.amazonaws.internal.SdkInternalList<T> configRulesEvaluationStatus
Status information about your AWS managed Config rules.
com.amazonaws.internal.SdkInternalList<T> configRuleNames
The names of the AWS Config rules for which you want details. If you do not specify any names, AWS Config returns details for all your rules.
String nextToken
The nextToken string returned on a previous page that you
use to get the next page of results in a paginated response.
com.amazonaws.internal.SdkInternalList<T> configRules
The details about your AWS Config rules.
String nextToken
The string that you use in a subsequent request to get the next page of results in a paginated response.
com.amazonaws.internal.SdkInternalList<T> configurationRecorderNames
A list of configuration recorder names.
com.amazonaws.internal.SdkInternalList<T> configurationRecorders
A list that contains the descriptions of the specified configuration recorders.
com.amazonaws.internal.SdkInternalList<T> configurationRecorderNames
The name(s) of the configuration recorder. If the name is not specified, the action returns the current status of all the configuration recorders associated with the account.
com.amazonaws.internal.SdkInternalList<T> configurationRecordersStatus
A list that contains status of the specified recorders.
com.amazonaws.internal.SdkInternalList<T> deliveryChannelNames
A list of delivery channel names.
com.amazonaws.internal.SdkInternalList<T> deliveryChannels
A list that contains the descriptions of the specified delivery channel.
com.amazonaws.internal.SdkInternalList<T> deliveryChannelNames
A list of delivery channel names.
com.amazonaws.internal.SdkInternalList<T> deliveryChannelsStatus
A list that contains the status of a specified delivery channel.
String complianceResourceType
The type of AWS resource that was evaluated.
String complianceResourceId
The ID of the AWS resource that was evaluated.
String complianceType
Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.
String annotation
Supplementary information about how the evaluation determined the compliance.
Date orderingTimestamp
The time of the event in AWS Config that triggered the evaluation. For event-based evaluations, the time indicates when AWS Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when AWS Config delivered the configuration snapshot that triggered the evaluation.
EvaluationResultIdentifier evaluationResultIdentifier
Uniquely identifies the evaluation result.
String complianceType
Indicates whether the AWS resource complies with the AWS Config rule that evaluated it.
Date resultRecordedTime
The time when AWS Config recorded the evaluation result.
Date configRuleInvokedTime
The time when the AWS Config rule evaluated the AWS resource.
String annotation
Supplementary information about how the evaluation determined the compliance.
String resultToken
An encrypted token that associates an evaluation with an AWS Config rule. The token identifies the rule, the AWS resource being evaluated, and the event that triggered the evaluation.
EvaluationResultQualifier evaluationResultQualifier
Identifies an AWS Config rule used to evaluate an AWS resource, and provides the type and ID of the evaluated resource.
Date orderingTimestamp
The time of the event that triggered the evaluation of your AWS resources. The time can indicate when AWS Config delivered a configuration item change notification, or it can indicate when AWS Config delivered the configuration snapshot, depending on which event triggered the evaluation.
String configRuleName
The name of the AWS Config rule for which you want compliance information.
com.amazonaws.internal.SdkInternalList<T> complianceTypes
Specify to filter the results by compliance. The valid values are
Compliant, NonCompliant, and
NotApplicable.
Integer limit
The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.
String nextToken
The nextToken string returned on a previous page that you
use to get the next page of results in a paginated response.
com.amazonaws.internal.SdkInternalList<T> evaluationResults
Indicates whether the AWS resource complies with the specified AWS Config rule.
String nextToken
The string that you use in a subsequent request to get the next page of results in a paginated response.
String resourceType
The type of the AWS resource for which you want compliance information.
String resourceId
The ID of the AWS resource for which you want compliance information.
com.amazonaws.internal.SdkInternalList<T> complianceTypes
Specify to filter the results by compliance. The valid values are
Compliant, NonCompliant, and
NotApplicable.
String nextToken
The nextToken string returned on a previous page that you
use to get the next page of results in a paginated response.
com.amazonaws.internal.SdkInternalList<T> evaluationResults
Indicates whether the specified AWS resource complies each AWS Config rule.
String nextToken
The string that you use in a subsequent request to get the next page of results in a paginated response.
ComplianceSummary complianceSummary
The number of AWS Config rules that are compliant and the number that are noncompliant, up to a maximum of 25 for each.
com.amazonaws.internal.SdkInternalList<T> resourceTypes
Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type.
For this request, you can specify an AWS resource type such as
AWS::EC2::Instance, and you can specify that the resource
type is an AWS account by specifying AWS::::Account.
com.amazonaws.internal.SdkInternalList<T> complianceSummariesByResourceType
The number of resources that are compliant and the number that are noncompliant. If one or more resource types were provided with the request, the numbers are returned for each resource type. The maximum number returned is 100.
String resourceType
The resource type.
String resourceId
The ID of the resource (for example., sg-xxxxxx).
Date laterTime
The time stamp that indicates a later time. If not specified, current time is taken.
Date earlierTime
The time stamp that indicates an earlier time. If not specified, the action returns paginated results that contain configuration items that start from when the first configuration item was recorded.
String chronologicalOrder
The chronological order for configuration items listed. By default the results are listed in reverse chronological order.
Integer limit
The maximum number of configuration items returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.
String nextToken
The nextToken string returned on a previous page that you
use to get the next page of results in a paginated response.
com.amazonaws.internal.SdkInternalList<T> configurationItems
A list that contains the configuration history of one or more resources.
String nextToken
The string that you use in a subsequent request to get the next page of results in a paginated response.
String resourceType
The type of resources that you want AWS Config to list in the response.
com.amazonaws.internal.SdkInternalList<T> resourceIds
The IDs of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.
String resourceName
The custom name of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.
Integer limit
The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.
Boolean includeDeletedResources
Specifies whether AWS Config includes deleted resources in the results. By default, deleted resources are not included.
String nextToken
The nextToken string returned on a previous page that you
use to get the next page of results in a paginated response.
com.amazonaws.internal.SdkInternalList<T> resourceIdentifiers
The details that identify a resource that is discovered by AWS Config, including the resource type, ID, and (if available) the custom resource name.
String nextToken
The string that you use in a subsequent request to get the next page of results in a paginated response.
ConfigRule configRule
ConfigurationRecorder configurationRecorder
The configuration recorder object that records each configuration change made to the resources.
DeliveryChannel deliveryChannel
The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic.
com.amazonaws.internal.SdkInternalList<T> evaluations
The assessments that the AWS Lambda function performs. Each evaluation identifies an AWS resource and indicates whether it complies with the AWS Config rule that invokes the AWS Lambda function.
String resultToken
An encrypted token that associates an evaluation with an AWS Config rule. Identifies the rule and the event that triggered the evaluation
com.amazonaws.internal.SdkInternalList<T> failedEvaluations
Requests that failed because of a client or server error.
Boolean allSupported
Specifies whether AWS Config records configuration changes for every supported type of regional resource.
If you set this option to true, when AWS Config adds support
for a new type of regional resource, it automatically starts recording
resources of that type.
If you set this option to true, you cannot enumerate a list
of resourceTypes.
Boolean includeGlobalResourceTypes
Specifies whether AWS Config includes all supported types of global resources with the resources that it records.
Before you can set this option to true, you must set the
allSupported option to true.
If you set this option to true, when AWS Config adds support
for a new type of global resource, it automatically starts recording
resources of that type.
com.amazonaws.internal.SdkInternalList<T> resourceTypes
A comma-separated list that specifies the types of AWS resources for
which AWS Config records configuration changes (for example,
AWS::EC2::Instance or AWS::CloudTrail::Trail).
Before you can set this option to true, you must set the
allSupported option to false.
If you set this option to true, when AWS Config adds support
for a new type of resource, it will not record resources of that type
unless you manually add that type to your recording group.
For a list of valid resourceTypes values, see the
resourceType Value column in Supported AWS Resource Types.
String resourceType
The resource type of the related resource.
String resourceId
The ID of the related resource (for example, sg-xxxxxx).
String resourceName
The custom name of the related resource, if available.
String relationshipName
The type of relationship with the related resource.
String resourceType
The type of resource.
String resourceId
The ID of the resource (for example., sg-xxxxxx).
String resourceName
The custom name of the resource (if available).
Date resourceDeletionTime
The time that the resource was deleted.
com.amazonaws.internal.SdkInternalList<T> complianceResourceTypes
The resource types of only those AWS resources that you want AWS Config
to evaluate against the rule. You can specify only one type if you also
specify resource IDs for ComplianceResourceId.
String tagKey
The tag key that is applied to only those AWS resources that you want AWS Config to evaluate against the rule.
String tagValue
The tag value applied to only those AWS resources that you want AWS
Config to evaluate against the rule. If you specify a value for
TagValue, you must also specify a value for
TagKey.
String complianceResourceId
The IDs of only those AWS resources that you want AWS Config to evaluate
against the rule. If you specify a resource ID, you must specify one
resource type for ComplianceResourceTypes.
String owner
Indicates whether AWS or the customer owns and manages the AWS Config rule.
String sourceIdentifier
For AWS managed Config rules, a pre-defined identifier from a list. To reference the list, see Using AWS Managed Config Rules.
For customer managed Config rules, the identifier is the Amazon Resource Name (ARN) of the rule's AWS Lambda function.
com.amazonaws.internal.SdkInternalList<T> sourceDetails
Provides the source and type of the event that causes AWS Config to evaluate your AWS resources.
String eventSource
The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources.
String messageType
The type of SNS message that triggers AWS Config to run an evaluation.
For evaluations that are initiated when AWS Config delivers a
configuration item change notification, you must use
ConfigurationItemChangeNotification. For evaluations that
are initiated when AWS Config delivers a configuration snapshot, you must
use ConfigurationSnapshotDeliveryCompleted.
String configurationRecorderName
The name of the recorder object that records each configuration change made to the resources.
String configurationRecorderName
The name of the recorder object that records each configuration change made to the resources.
String pipelineId
The ID of the pipeline.
com.amazonaws.internal.SdkInternalList<T> parameterValues
A list of parameter values to pass to the pipeline at activation.
Date startTimestamp
The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.
String pipelineId
The ID of the pipeline.
com.amazonaws.internal.SdkInternalList<T> tags
The tags to add, as key/value pairs.
String name
The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.
String uniqueId
A unique identifier. This identifier is not the same as the pipeline
identifier assigned by AWS Data Pipeline. You are responsible for
defining the format and ensuring the uniqueness of this identifier. You
use this parameter to ensure idempotency during repeated calls to
CreatePipeline. For example, if the first call to
CreatePipeline does not succeed, you can pass in the same
unique identifier and pipeline name combination on a subsequent call to
CreatePipeline. CreatePipeline ensures that if
a pipeline already exists with the same name and unique identifier, a new
pipeline is not created. Instead, you'll receive the pipeline identifier
from the previous attempt. The uniqueness of the name and unique
identifier combination is scoped to the AWS account or IAM user
credentials.
String description
The description for the pipeline.
com.amazonaws.internal.SdkInternalList<T> tags
A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.
String pipelineId
The ID that AWS Data Pipeline assigns the newly created pipeline. For
example, df-06372391ZG65EXAMPLE.
String pipelineId
The ID of the pipeline.
String pipelineId
The ID of the pipeline that contains the object definitions.
com.amazonaws.internal.SdkInternalList<T> objectIds
The IDs of the pipeline objects that contain the definitions to be
described. You can pass as many as 25 identifiers in a single call to
DescribeObjects.
Boolean evaluateExpressions
Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
String marker
The starting point for the results to be returned. For the first call,
this value should be empty. As long as there are more results, continue
to call DescribeObjects with the marker value from the
previous call to retrieve the next set of results.
com.amazonaws.internal.SdkInternalList<T> pipelineObjects
An array of object definitions.
String marker
The starting point for the next page of results. To view the next page of
results, call DescribeObjects again with this marker value.
If the value is null, there are no more results.
Boolean hasMoreResults
Indicates whether there are more results to return.
com.amazonaws.internal.SdkInternalList<T> pipelineIds
The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call ListPipelines.
com.amazonaws.internal.SdkInternalList<T> pipelineDescriptionList
An array of descriptions for the specified pipelines.
String evaluatedExpression
The evaluated expression.
com.amazonaws.internal.SdkInternalList<T> pipelineObjects
The objects defined in the pipeline.
com.amazonaws.internal.SdkInternalList<T> parameterObjects
The parameter objects used in the pipeline definition.
com.amazonaws.internal.SdkInternalList<T> parameterValues
The parameter values used in the pipeline definition.
String document
A description of an EC2 instance that is generated when the instance is launched and exposed to the instance via the instance metadata service in the form of a JSON representation of an object.
String signature
A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.
String marker
The starting point for the results to be returned. For the first call,
this value should be empty. As long as there are more results, continue
to call ListPipelines with the marker value from the
previous call to retrieve the next set of results.
com.amazonaws.internal.SdkInternalList<T> pipelineIdList
The pipeline identifiers. If you require additional information about the pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition.
String marker
The starting point for the next page of results. To view the next page of
results, call ListPipelinesOutput again with this marker
value. If the value is null, there are no more results.
Boolean hasMoreResults
Indicates whether there are more results that can be obtained by a subsequent call.
String type
The logical operation to be performed: equal (EQ), equal
reference (REF_EQ), less than or equal (LE),
greater than or equal (GE), or between (BETWEEN
). Equal reference (REF_EQ) can be used only with reference
fields. The other comparison types can be used only with String fields.
The comparison types you can use apply only to certain object fields, as
detailed below.
The comparison operators EQ and REF_EQ act on the following fields:
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".
com.amazonaws.internal.SdkInternalList<T> values
The value that the actual field value will be compared with.
String id
The ID of the parameter object.
com.amazonaws.internal.SdkInternalList<T> attributes
The attributes of the parameter object.
String pipelineId
The pipeline identifier that was assigned by AWS Data Pipeline. This is a
string of the form df-297EG78HU43EEXAMPLE.
String name
The name of the pipeline.
com.amazonaws.internal.SdkInternalList<T> fields
A list of read-only fields that contain metadata about the pipeline:
String description
Description of the pipeline.
com.amazonaws.internal.SdkInternalList<T> tags
A list of tags to associated with a pipeline. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.
String id
The ID of the object.
String name
The name of the object.
com.amazonaws.internal.SdkInternalList<T> fields
Key-value pairs that define the properties of the object.
String workerGroup
The type of task the task runner is configured to accept and process. The
worker group is set as a field on objects in the pipeline when they are
created. You can only specify a single value for workerGroup
in the call to PollForTask. There are no wildcard values
permitted in workerGroup; the string must be an exact,
case-sensitive, match.
String hostname
The public DNS name of the calling task runner.
InstanceIdentity instanceIdentity
Identity information for the EC2 instance that is hosting the task
runner. You can get this value from the instance using
http://169.254.169.254/latest/meta-data/instance-id. For
more information, see Instance Metadata in the Amazon Elastic Compute Cloud User
Guide. Passing in this value proves that your task runner is running
on an EC2 instance, and ensures the proper AWS Data Pipeline service
charges are applied to your pipeline.
TaskObject taskObject
The information needed to complete the task that is being assigned to the
task runner. One of the fields returned in this object is
taskId, which contains an identifier for the task being
assigned. The calling task runner uses taskId in subsequent
calls to ReportTaskProgress and SetTaskStatus.
String pipelineId
The ID of the pipeline.
com.amazonaws.internal.SdkInternalList<T> pipelineObjects
The objects that define the pipeline. These objects overwrite the existing pipeline definition.
com.amazonaws.internal.SdkInternalList<T> parameterObjects
The parameter objects used with the pipeline.
com.amazonaws.internal.SdkInternalList<T> parameterValues
The parameter values used with the pipeline.
com.amazonaws.internal.SdkInternalList<T> validationErrors
The validation errors that are associated with the objects defined in
pipelineObjects.
com.amazonaws.internal.SdkInternalList<T> validationWarnings
The validation warnings that are associated with the objects defined in
pipelineObjects.
Boolean errored
Indicates whether there were validation errors, and the pipeline
definition is stored but cannot be activated until you correct the
pipeline and call PutPipelineDefinition to commit the
corrected pipeline.
com.amazonaws.internal.SdkInternalList<T> selectors
List of selectors that define the query. An object must satisfy all of the selectors to match the query.
String pipelineId
The ID of the pipeline.
Query query
The query that defines the objects to be returned. The Query
object can contain a maximum of ten selectors. The conditions in the
query are limited to top-level String fields in the object. These filters
can be applied to components, instances, and attempts.
String sphere
Indicates whether the query applies to components or instances. The
possible values are: COMPONENT, INSTANCE, and
ATTEMPT.
String marker
The starting point for the results to be returned. For the first call,
this value should be empty. As long as there are more results, continue
to call QueryObjects with the marker value from the previous
call to retrieve the next set of results.
Integer limit
The maximum number of object names that QueryObjects will
return in a single call. The default value is 100.
com.amazonaws.internal.SdkInternalList<T> ids
The identifiers that match the query selectors.
String marker
The starting point for the next page of results. To view the next page of
results, call QueryObjects again with this marker value. If
the value is null, there are no more results.
Boolean hasMoreResults
Indicates whether there are more results that can be obtained by a subsequent call.
String pipelineId
The ID of the pipeline.
com.amazonaws.internal.SdkInternalList<T> tagKeys
The keys of the tags to remove.
String taskId
The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.
com.amazonaws.internal.SdkInternalList<T> fields
Key-value pairs that define the properties of the ReportTaskProgressInput object.
Boolean canceled
If true, the calling task runner should cancel processing of the task. The task runner does not need to call SetTaskStatus for canceled tasks.
String taskrunnerId
The ID of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application. If you have written a custom task runner, you should assign a unique identifier for the task runner.
String workerGroup
The type of task the task runner is configured to accept and process. The
worker group is set as a field on objects in the pipeline when they are
created. You can only specify a single value for workerGroup
. There are no wildcard values permitted in workerGroup; the
string must be an exact, case-sensitive, match.
String hostname
The public DNS name of the task runner.
Boolean terminate
Indicates whether the calling task runner should terminate.
String fieldName
The name of the field that the operator will be applied to. The field name is the "key" portion of the field definition in the pipeline definition syntax that is used by the AWS Data Pipeline API. If the field is not set on the object, the condition fails.
Operator operator
String pipelineId
The ID of the pipeline that contains the objects.
com.amazonaws.internal.SdkInternalList<T> objectIds
The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.
String status
The status to be set on all the objects specified in
objectIds. For components, use PAUSE or
RESUME. For instances, use TRY_CANCEL,
RERUN, or MARK_FINISHED.
String taskId
The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.
String taskStatus
If FINISHED, the task successfully completed. If
FAILED, the task ended unsuccessfully. Preconditions use
false.
String errorId
If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system.
String errorMessage
If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.
String errorStackTrace
If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.
String key
The key name of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.
String value
The optional value portion of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.
String taskId
An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.
String pipelineId
The ID of the pipeline that provided the task.
String attemptId
The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.
Map<K,V> objects
Connection information for the location where the task runner will publish the output of the task.
String pipelineId
The ID of the pipeline.
com.amazonaws.internal.SdkInternalList<T> pipelineObjects
The objects that define the pipeline changes to validate against the pipeline.
com.amazonaws.internal.SdkInternalList<T> parameterObjects
The parameter objects used with the pipeline.
com.amazonaws.internal.SdkInternalList<T> parameterValues
The parameter values used with the pipeline.
com.amazonaws.internal.SdkInternalList<T> validationErrors
Any validation errors that were found.
com.amazonaws.internal.SdkInternalList<T> validationWarnings
Any validation warnings that were found.
Boolean errored
Indicates whether there were validation errors.
String id
The identifier of the object that contains the validation error.
com.amazonaws.internal.SdkInternalList<T> errors
A description of the validation error.
String id
The identifier of the object that contains the validation warning.
com.amazonaws.internal.SdkInternalList<T> warnings
A description of the validation warning.
String arn
The artifact's ARN.
String name
The artifact's name.
String type
The artifact's type.
Allowed values include the following:
APPIUM_JAVA_OUTPUT: The Appium Java output type.
APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type.
APPIUM_SERVER_OUTPUT: The Appium server output type.
AUTOMATION_OUTPUT: The automation output type.
CALABASH_JSON_OUTPUT: The Calabash JSON output type.
CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type.
CALABASH_PRETTY_OUTPUT: The Calabash pretty output type.
CALABASH_STANDARD_OUTPUT: The Calabash standard output type.
DEVICE_LOG: The device log type.
EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test.
INSTRUMENTATION_OUTPUT: The instrumentation type.
MESSAGE_LOG: The message log type.
RESULT_LOG: The result log type.
SCREENSHOT: The screenshot type.
SERVICE_LOG: The service log type.
UNKNOWN: An unknown type.
String extension
The artifact's file extension.
String url
The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the artifact's file.
Integer total
The total number of entities.
Integer passed
The number of passed entities.
Integer failed
The number of failed entities.
Integer warned
The number of warned entities.
Integer errored
The number of errored entities.
Integer stopped
The number of stopped entities.
Integer skipped
The number of skipped entities.
DevicePool devicePool
The newly created device pool.
String name
The project's name.
Project project
The newly created project.
String projectArn
The ARN of the project for the upload.
String name
The upload's file name.
String type
The upload's upload type.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
Note If you call CreateUpload with
WEB_APP specified, AWS Device Farm throws an
ArgumentException error.
String contentType
The upload's content type (for example, "application/octet-stream").
Upload upload
The newly created upload.
String arn
Represents the Amazon Resource Name (ARN) of the Device Farm device pool you wish to delete.
String arn
Represents the Amazon Resource Name (ARN) of the Device Farm project you wish to delete.
String arn
The Amazon Resource Name (ARN) for the run you wish to delete.
String arn
Represents the Amazon Resource Name (ARN) of the Device Farm upload you wish to delete.
String arn
The device's ARN.
String name
The device's display name.
String manufacturer
The device's manufacturer name.
String model
The device's model name.
String formFactor
The device's form factor.
Allowed values include:
PHONE: The phone form factor.
TABLET: The tablet form factor.
String platform
The device's platform.
Allowed values include:
ANDROID: The Android platform.
IOS: The iOS platform.
String os
The device's operating system type.
CPU cpu
Information about the device's CPU.
Resolution resolution
Long heapSize
The device's heap size, expressed in bytes.
Long memory
The device's total memory size, expressed in bytes.
String image
The device's image name.
String carrier
The device's carrier.
String radio
The device's radio.
Double total
When specified, represents the total minutes used by the resource to run tests.
Double metered
When specified, represents only the sum of metered minutes used by the resource to run tests.
Double unmetered
When specified, represents only the sum of unmetered minutes used by the resource to run tests.
String arn
The device pool's ARN.
String name
The device pool's name.
String description
The device pool's description.
String type
The device pool's type.
Allowed values include:
CURATED: A device pool that is created and managed by AWS Device Farm.
PRIVATE: A device pool that is created and managed by the device pool developer.
List<E> rules
Information about the device pool's rules.
AccountSettings accountSettings
String devicePoolArn
The device pool's ARN.
String appArn
The ARN of the app that is associated with the specified device pool.
String testType
The test type for the specified device pool.
Allowed values include the following:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
String arn
The device pool's ARN.
DevicePool devicePool
String arn
The device type's ARN.
Device device
String arn
The job's ARN.
Job job
String arn
The project's ARN.
Project project
String arn
The run's ARN.
Run run
String arn
The suite's ARN.
Suite suite
String arn
The test's ARN.
Test test
String arn
The upload's ARN.
Upload upload
String arn
The job's ARN.
String name
The job's name.
String type
The job's type.
Allowed values include the following:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
Date created
When the job was created.
String status
The job's status.
Allowed values include:
COMPLETED: A completed status.
PENDING: A pending status.
PROCESSING: A processing status.
RUNNING: A running status.
SCHEDULING: A scheduling status.
String result
The job's result.
Allowed values include:
ERRORED: An error condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
STOPPED: A stopped condition.
PASSED: A passing condition.
PENDING: A pending condition.
WARNED: A warning condition.
Date started
The job's start time.
Date stopped
The job's stop time.
Counters counters
The job's result counters.
String message
A message about the job's result.
Device device
DeviceMinutes deviceMinutes
Represents the total (metered or unmetered) minutes used by the job.
String arn
The Run, Job, Suite, or Test ARN.
String type
The artifacts' type.
Allowed values include:
String nextToken
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
String arn
The project ARN.
String type
The device pools' type.
Allowed values include:
CURATED: A device pool that is created and managed by AWS Device Farm.
PRIVATE: A device pool that is created and managed by the device pool developer.
String nextToken
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
List<E> devicePools
Information about the device pools.
String nextToken
If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
Map<K,V> uniqueProblems
Information about the unique problems.
Allowed values include:
ERRORED: An error condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
STOPPED: A stopped condition.
PASSED: A passing condition.
PENDING: A pending condition.
WARNED: A warning condition.
String nextToken
If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
ProblemDetail run
Information about the associated run.
ProblemDetail job
Information about the associated job.
ProblemDetail suite
Information about the associated suite.
ProblemDetail test
Information about the associated test.
Device device
Information about the associated device.
String result
The problem's result.
Allowed values include:
ERRORED: An error condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
STOPPED: A stopped condition.
PASSED: A passing condition.
PENDING: A pending condition.
WARNED: A warning condition.
String message
A message about the problem's result.
Boolean wifi
True if Wi-Fi is enabled at the beginning of the test; otherwise, false.
Boolean bluetooth
True if Bluetooth is enabled at the beginning of the test; otherwise, false.
Boolean nfc
True if NFC is enabled at the beginning of the test; otherwise, false.
Boolean gps
True if GPS is enabled at the beginning of the test; otherwise, false.
String attribute
The rule's attribute.
Allowed values include:
ARN: The ARN.
FORM_FACTOR: The form factor (for example, phone or tablet).
MANUFACTURER: The manufacturer.
PLATFORM: The platform (for example, Android or iOS).
String operator
The rule's operator.
EQUALS: The equals operator.
GREATER_THAN: The greater-than operator.
IN: The in operator.
LESS_THAN: The less-than operator.
NOT_IN: The not-in operator.
String value
The rule's value.
String arn
The run's ARN.
String name
The run's name.
String type
The run's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
String platform
The run's platform.
Allowed values include:
ANDROID: The Android platform.
IOS: The iOS platform.
Date created
When the run was created.
String status
The run's status.
Allowed values include:
COMPLETED: A completed status.
PENDING: A pending status.
PROCESSING: A processing status.
RUNNING: A running status.
SCHEDULING: A scheduling status.
String result
The run's result.
Allowed values include:
ERRORED: An error condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
STOPPED: A stopped condition.
PASSED: A passing condition.
PENDING: A pending condition.
WARNED: A warning condition.
Date started
The run's start time.
Date stopped
The run's stop time.
Counters counters
The run's result counters.
String message
A message about the run's result.
Integer totalJobs
The total number of jobs for the run.
Integer completedJobs
The total number of completed jobs.
String billingMethod
Specifies the billing method for a test run: metered or
unmetered. If the parameter is not specified, the default
value is unmetered.
DeviceMinutes deviceMinutes
Represents the total (metered or unmetered) minutes used by the test run.
String arn
The sample's ARN.
String type
The sample's type.
Must be one of the following values:
CPU: A CPU sample type. This is expressed as the app processing CPU time (including child processes) as reported by process, as a percentage.
MEMORY: A memory usage sample type. This is expressed as the total proportional set size of an app process, in kilobytes.
NATIVE_AVG_DRAWTIME
NATIVE_FPS
NATIVE_FRAMES
NATIVE_MAX_DRAWTIME
NATIVE_MIN_DRAWTIME
OPENGL_AVG_DRAWTIME
OPENGL_FPS
OPENGL_FRAMES
OPENGL_MAX_DRAWTIME
OPENGL_MIN_DRAWTIME
RX
RX_RATE: The total number of bytes per second (TCP and UDP) that are sent, by app process.
THREADS: A threads sample type. This is expressed as the total number of threads per app process.
TX
TX_RATE: The total number of bytes per second (TCP and UDP) that are received, by app process.
String url
The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the sample's file.
String extraDataPackageArn
The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm will extract to external data for Android or the app's sandbox for iOS.
String networkProfileArn
Reserved for internal use.
String locale
Information about the locale that is used for the run.
Location location
Information about the location that is used for the run.
Radios radios
Information about the radio states for the run.
List<E> auxiliaryApps
A list of auxiliary apps for the run.
String billingMethod
Specifies the billing method for a test run: metered or
unmetered. If the parameter is not specified, the default
value is unmetered.
String projectArn
The ARN of the project for the run to be scheduled.
String appArn
The ARN of the app to schedule a run.
String devicePoolArn
The ARN of the device pool for the run to be scheduled.
String name
The name for the run to be scheduled.
ScheduleRunTest test
Information about the test for the run to be scheduled.
ScheduleRunConfiguration configuration
Information about the settings for the run to be scheduled.
Run run
Information about the scheduled run.
String type
The test's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
String testPackageArn
The ARN of the uploaded test that will be run.
String filter
The test's filter.
Map<K,V> parameters
The test's parameters, such as test framework parameters and fixture settings.
String arn
The suite's ARN.
String name
The suite's name.
String type
The suite's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
Date created
When the suite was created.
String status
The suite's status.
Allowed values include:
COMPLETED: A completed status.
PENDING: A pending status.
PROCESSING: A processing status.
RUNNING: A running status.
SCHEDULING: A scheduling status.
String result
The suite's result.
Allowed values include:
ERRORED: An error condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
STOPPED: A stopped condition.
PASSED: A passing condition.
PENDING: A pending condition.
WARNED: A warning condition.
Date started
The suite's start time.
Date stopped
The suite's stop time.
Counters counters
The suite's result counters.
String message
A message about the suite's result.
DeviceMinutes deviceMinutes
Represents the total (metered or unmetered) minutes used by the test suite.
String arn
The test's ARN.
String name
The test's name.
String type
The test's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
Date created
When the test was created.
String status
The test's status.
Allowed values include:
COMPLETED: A completed status.
PENDING: A pending status.
PROCESSING: A processing status.
RUNNING: A running status.
SCHEDULING: A scheduling status.
String result
The test's result.
Allowed values include:
ERRORED: An error condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
STOPPED: A stopped condition.
PASSED: A passing condition.
PENDING: A pending condition.
WARNED: A warning condition.
Date started
The test's start time.
Date stopped
The test's stop time.
Counters counters
The test's result counters.
String message
A message about the test's result.
DeviceMinutes deviceMinutes
Represents the total (metered or unmetered) minutes used by the test.
String arn
The Amazon Resourc Name (ARN) of the Device Farm device pool you wish to update.
String name
A string representing the name of the device pool you wish to update.
String description
A description of the device pool you wish to update.
List<E> rules
Represents the rules you wish to modify for the device pool. Updating rules is optional; however, if you choose to update rules for your request, the update will replace the existing rules.
DevicePool devicePool
Project project
String arn
The upload's ARN.
String name
The upload's file name.
Date created
When the upload was created.
String type
The upload's type.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
String status
The upload's status.
Must be one of the following values:
FAILED: A failed status.
INITIALIZED: An initialized status.
PROCESSING: A processing status.
SUCCEEDED: A succeeded status.
String url
The pre-signed Amazon S3 URL that was used to store a file through a corresponding PUT request.
String metadata
The upload's metadata. For example, for Android, this contains information that is parsed from the manifest and is displayed in the AWS Device Farm console after the associated app is uploaded.
String contentType
The upload's content type (for example, "application/octet-stream").
String message
A message about the upload's result.
String bandwidth
Bandwidth of the connection.
Example: "500Mbps"
Default: None
String connectionName
Name of the provisioned connection.
Example: "500M Connection to AWS"
Default: None
String ownerAccount
Numeric account Id of the customer for whom the connection will be provisioned.
Example: 123443215678
Default: None
String interconnectId
ID of the interconnect on which the connection will be provisioned.
Example: dxcon-456abc78
Default: None
Integer vlan
The dedicated VLAN provisioned to the connection.
Example: 101
Default: None
String ownerAccount
String connectionId
String connectionName
String connectionState
String region
String location
String bandwidth
Bandwidth of the connection.
Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)
Default: None
Integer vlan
String partnerName
String connectionId
The connection ID on which the private virtual interface is provisioned.
Default: None
String ownerAccount
The AWS account that will own the new private virtual interface.
Default: None
NewPrivateVirtualInterfaceAllocation newPrivateVirtualInterfaceAllocation
Detailed information for the private virtual interface to be provisioned.
Default: None
String ownerAccount
String virtualInterfaceId
String location
String connectionId
String virtualInterfaceType
String virtualInterfaceName
Integer vlan
Integer asn
String authKey
String amazonAddress
String customerAddress
String virtualInterfaceState
String customerRouterConfig
Information for generating the customer router configuration.
String virtualGatewayId
com.amazonaws.internal.SdkInternalList<T> routeFilterPrefixes
String connectionId
The connection ID on which the public virtual interface is provisioned.
Default: None
String ownerAccount
The AWS account that will own the new public virtual interface.
Default: None
NewPublicVirtualInterfaceAllocation newPublicVirtualInterfaceAllocation
Detailed information for the public virtual interface to be provisioned.
Default: None
String ownerAccount
String virtualInterfaceId
String location
String connectionId
String virtualInterfaceType
String virtualInterfaceName
Integer vlan
Integer asn
String authKey
String amazonAddress
String customerAddress
String virtualInterfaceState
String customerRouterConfig
Information for generating the customer router configuration.
String virtualGatewayId
com.amazonaws.internal.SdkInternalList<T> routeFilterPrefixes
String connectionId
String connectionState
String virtualInterfaceId
String virtualGatewayId
ID of the virtual private gateway that will be attached to the virtual interface.
A virtual private gateway can be managed via the Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.
Default: None
String virtualInterfaceState
String virtualInterfaceId
String virtualInterfaceState
String ownerAccount
String connectionId
String connectionName
String connectionState
String region
String location
String bandwidth
Bandwidth of the connection.
Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)
Default: None
Integer vlan
String partnerName
String ownerAccount
String connectionId
String connectionName
String connectionState
String region
String location
String bandwidth
Bandwidth of the connection.
Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)
Default: None
Integer vlan
String partnerName
String interconnectName
The name of the interconnect.
Example: "1G Interconnect to AWS"
Default: None
String bandwidth
The port bandwidth
Example: 1Gbps
Default: None
Available values: 1Gbps,10Gbps
String location
Where the interconnect is located
Example: EqSV5
Default: None
String connectionId
NewPrivateVirtualInterface newPrivateVirtualInterface
Detailed information for the private virtual interface to be created.
Default: None
String ownerAccount
String virtualInterfaceId
String location
String connectionId
String virtualInterfaceType
String virtualInterfaceName
Integer vlan
Integer asn
String authKey
String amazonAddress
String customerAddress
String virtualInterfaceState
String customerRouterConfig
Information for generating the customer router configuration.
String virtualGatewayId
com.amazonaws.internal.SdkInternalList<T> routeFilterPrefixes
String connectionId
NewPublicVirtualInterface newPublicVirtualInterface
Detailed information for the public virtual interface to be created.
Default: None
String ownerAccount
String virtualInterfaceId
String location
String connectionId
String virtualInterfaceType
String virtualInterfaceName
Integer vlan
Integer asn
String authKey
String amazonAddress
String customerAddress
String virtualInterfaceState
String customerRouterConfig
Information for generating the customer router configuration.
String virtualGatewayId
com.amazonaws.internal.SdkInternalList<T> routeFilterPrefixes
String connectionId
String ownerAccount
String connectionId
String connectionName
String connectionState
String region
String location
String bandwidth
Bandwidth of the connection.
Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)
Default: None
Integer vlan
String partnerName
String interconnectId
String interconnectState
String virtualInterfaceId
String virtualInterfaceState
String interconnectId
ID of the interconnect on which a list of connection is provisioned.
Example: dxcon-abc123
Default: None
com.amazonaws.internal.SdkInternalList<T> connections
A list of connections.
String connectionId
com.amazonaws.internal.SdkInternalList<T> connections
A list of connections.
String interconnectId
com.amazonaws.internal.SdkInternalList<T> interconnects
A list of interconnects.
com.amazonaws.internal.SdkInternalList<T> locations
A list of colocation hubs where network providers have equipment. Most regions have multiple locations available.
com.amazonaws.internal.SdkInternalList<T> virtualGateways
A list of virtual private gateways.
com.amazonaws.internal.SdkInternalList<T> virtualInterfaces
A list of virtual interfaces.
String cidr
CIDR notation for the advertised route. Multiple routes are separated by commas.
Example: 10.10.10.0/24,10.10.11.0/24
String ownerAccount
String virtualInterfaceId
String location
String connectionId
String virtualInterfaceType
String virtualInterfaceName
Integer vlan
Integer asn
String authKey
String amazonAddress
String customerAddress
String virtualInterfaceState
String customerRouterConfig
Information for generating the customer router configuration.
String virtualGatewayId
com.amazonaws.internal.SdkInternalList<T> routeFilterPrefixes
String requestId
The identifier of the request that caused the exception.
String requestId
String computerId
The identifier of the computer.
String computerName
The computer name.
com.amazonaws.internal.SdkInternalList<T> computerAttributes
An array of Attribute objects containing the LDAP attributes that belong to the computer account.
String name
The fully-qualified name of the on-premises directory, such as
corp.example.com.
String shortName
The NetBIOS name of the on-premises directory, such as CORP.
String password
The password for the on-premises user account.
String description
A textual description for the directory.
String size
The size of the directory.
DirectoryConnectSettings connectSettings
A DirectoryConnectSettings object that contains additional information for the operation.
String directoryId
The identifier of the new directory.
String directoryId
The identifier of the directory in which to create the computer account.
String computerName
The name of the computer account.
String password
A one-time password that is used to join the computer to the directory. You should generate a random, strong password to use for this parameter.
String organizationalUnitDistinguishedName
The fully-qualified distinguished name of the organizational unit to place the computer account in.
com.amazonaws.internal.SdkInternalList<T> computerAttributes
An array of Attribute objects that contain any LDAP attributes to apply to the computer account.
String name
The fully qualified name for the directory, such as
corp.example.com.
String shortName
The short name of the directory, such as CORP.
String password
The password for the directory administrator. The directory creation
process creates a directory administrator account with the username
Administrator and this password.
String description
A textual description for the directory.
String size
The size of the directory.
DirectoryVpcSettings vpcSettings
A DirectoryVpcSettings object that contains additional information for the operation.
String directoryId
The identifier of the directory that was created.
String name
The fully qualified domain name for the directory, such as
corp.example.com. This name will resolve inside your VPC
only. It does not need to be publicly resolvable.
String shortName
The NetBIOS name for your domain. A short identifier for your domain,
such as CORP. If you don't specify a NetBIOS name, it will
default to the first part of your directory DNS. For example,
CORP for the directory DNS corp.example.com.
String password
The password for the default administrative user named Admin
.
String description
A textual description for the directory. This label will appear on the
AWS console Directory Details page after the directory is
created.
DirectoryVpcSettings vpcSettings
String directoryId
String snapshotId
The identifier of the snapshot that was created.
String directoryId
String remoteDomainName
String trustPassword
String trustDirection
String trustType
String trustId
String directoryId
The identifier of the directory to delete.
String directoryId
The directory identifier.
String snapshotId
The identifier of the directory snapshot to be deleted.
String snapshotId
The identifier of the directory snapshot that was deleted.
String trustId
String trustId
com.amazonaws.internal.SdkInternalList<T> directoryIds
A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.
An empty list results in an InvalidParameterException being
thrown.
String nextToken
The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call.
Integer limit
The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.
com.amazonaws.internal.SdkInternalList<T> directoryDescriptions
The list of DirectoryDescription objects that were retrieved.
It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.
String nextToken
If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDirectories to retrieve the next set of items.
String directoryId
The identifier of the directory for which to retrieve snapshot information.
com.amazonaws.internal.SdkInternalList<T> snapshotIds
A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.
String nextToken
The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.
Integer limit
The maximum number of objects to return.
com.amazonaws.internal.SdkInternalList<T> snapshots
The list of Snapshot objects that were retrieved.
It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.
String nextToken
If not null, more results are available. Pass this value in the NextToken member of a subsequent call to DescribeSnapshots.
String directoryId
com.amazonaws.internal.SdkInternalList<T> trustIds
A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned.
An empty list results in an InvalidParameterException being
thrown.
String nextToken
The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts. Pass null if this is the first call.
Integer limit
com.amazonaws.internal.SdkInternalList<T> trusts
The list of Trust objects that were retrieved.
It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.
String nextToken
If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeTrusts to retrieve the next set of items.
String vpcId
The identifier of the VPC in which the AD Connector is created.
com.amazonaws.internal.SdkInternalList<T> subnetIds
A list of subnet identifiers in the VPC in which the AD Connector is created.
com.amazonaws.internal.SdkInternalList<T> customerDnsIps
A list of one or more IP addresses of DNS servers or domain controllers in the on-premises directory.
String customerUserName
The username of an account in the on-premises directory that is used to connect to the directory. This account must have the following privileges:
String vpcId
The identifier of the VPC that the AD Connector is in.
com.amazonaws.internal.SdkInternalList<T> subnetIds
A list of subnet identifiers in the VPC that the AD connector is in.
String customerUserName
The username of the service account in the on-premises directory.
String securityGroupId
The security group identifier for the AD Connector directory.
com.amazonaws.internal.SdkInternalList<T> availabilityZones
A list of the Availability Zones that the directory is in.
com.amazonaws.internal.SdkInternalList<T> connectIps
The IP addresses of the AD Connector servers.
String directoryId
The directory identifier.
String name
The fully-qualified name of the directory.
String shortName
The short name of the directory.
String size
The directory size.
String alias
The alias for the directory. If no alias has been created for the
directory, the alias is the directory identifier, such as
d-XXXXXXXXXX.
String accessUrl
The access URL for the directory, such as
http://alias.awsapps.com
. If no alias has been created for the directory,
alias is the directory
identifier, such as d-XXXXXXXXXX.
String description
The textual description for the directory.
com.amazonaws.internal.SdkInternalList<T> dnsIpAddrs
The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in the on-premises directory to which the AD Connector is connected.
String stage
The current stage of the directory.
Date launchTime
Specifies when the directory was created.
Date stageLastUpdatedDateTime
The date and time that the stage was last updated.
String type
The directory size.
DirectoryVpcSettingsDescription vpcSettings
A DirectoryVpcSettingsDescription object that contains additional information about a directory. This member is only present if the directory is a Simple AD or Managed AD directory.
DirectoryConnectSettingsDescription connectSettings
A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory. This member is only present if the directory is an AD Connector directory.
RadiusSettings radiusSettings
A RadiusSettings object that contains information about the RADIUS server configured for this directory.
String radiusStatus
The status of the RADIUS MFA server connection.
String stageReason
Additional information about the directory stage.
Boolean ssoEnabled
Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.
String requestId
Integer cloudOnlyDirectoriesLimit
The maximum number of cloud directories allowed in the region.
Integer cloudOnlyDirectoriesCurrentCount
The current number of cloud directories in the region.
Boolean cloudOnlyDirectoriesLimitReached
Indicates if the cloud directory limit has been reached.
Integer cloudOnlyMicrosoftADLimit
Integer cloudOnlyMicrosoftADCurrentCount
Boolean cloudOnlyMicrosoftADLimitReached
Integer connectedDirectoriesLimit
The maximum number of connected directories allowed in the region.
Integer connectedDirectoriesCurrentCount
The current number of connected directories in the region.
Boolean connectedDirectoriesLimitReached
Indicates if the connected directory limit has been reached.
String requestId
String vpcId
The identifier of the VPC in which to create the directory.
com.amazonaws.internal.SdkInternalList<T> subnetIds
The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service creates a directory server and a DNS server in each of these subnets.
String vpcId
The identifier of the VPC that the directory is in.
com.amazonaws.internal.SdkInternalList<T> subnetIds
The identifiers of the subnets for the directory servers.
String securityGroupId
The security group identifier for the directory. If the directory was created before 8/1/2014, this is the identifier of the directory members security group that was created when the directory was created. If the directory was created after this date, this value is null.
com.amazonaws.internal.SdkInternalList<T> availabilityZones
The list of Availability Zones that the directory is in.
String directoryId
The identifier of the directory for which to disable MFA.
String directoryId
The identifier of the directory for which to disable single-sign on.
String userName
The username of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. This account must have privileges to remove a service principal name.
If the AD Connector service account does not have privileges to remove a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to disable single sign-on and are not stored by the service. The AD Connector service account is not changed.
String password
The password of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.
String directoryId
The identifier of the directory for which to enable MFA.
RadiusSettings radiusSettings
A RadiusSettings object that contains information about the RADIUS server.
String directoryId
The identifier of the directory for which to enable single-sign on.
String userName
The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name.
If the AD Connector service account does not have privileges to add a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to enable single sign-on and are not stored by the service. The AD Connector service account is not changed.
String password
The password of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.
String requestId
String requestId
DirectoryLimits directoryLimits
A DirectoryLimits object that contains the directory limits for the current region.
String directoryId
Contains the identifier of the directory to obtain the limits for.
SnapshotLimits snapshotLimits
A SnapshotLimits object that contains the manual snapshot limits for the specified directory.
String requestId
String requestId
String requestId
com.amazonaws.internal.SdkInternalList<T> radiusServers
An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer.
Integer radiusPort
The port that your RADIUS server is using for communications. Your on-premises network must allow inbound traffic over this port from the AWS Directory Service servers.
Integer radiusTimeout
The amount of time, in seconds, to wait for the RADIUS server to respond.
Integer radiusRetries
The maximum number of times that communication with the RADIUS server is attempted.
String sharedSecret
The shared secret code that was specified when your RADIUS endpoints were created.
String authenticationProtocol
The protocol specified for your RADIUS endpoints.
String displayLabel
Not currently used.
Boolean useSameUsername
Not currently used.
String snapshotId
The identifier of the snapshot to restore from.
String requestId
String directoryId
The directory identifier.
String snapshotId
The snapshot identifier.
String type
The snapshot type.
String name
The descriptive name of the snapshot.
String status
The snapshot status.
Date startTime
The date and time that the snapshot was taken.
String requestId
Integer manualSnapshotsLimit
The maximum number of manual snapshots allowed.
Integer manualSnapshotsCurrentCount
The current number of manual snapshots of the directory.
Boolean manualSnapshotsLimitReached
Indicates if the manual snapshot limit has been reached.
String directoryId
String trustId
String remoteDomainName
String trustType
String trustDirection
String trustState
Date createdDateTime
Date lastUpdatedDateTime
Date stateLastUpdatedDateTime
String requestId
String directoryId
The identifier of the directory for which to update the RADIUS server information.
RadiusSettings radiusSettings
A RadiusSettings object that contains information about the RADIUS server.
String trustId
String trustId
String s
A String data type.
String n
A Number data type.
ByteBuffer b
A Binary data type.
List<E> sS
A String Set data type.
List<E> nS
A Number Set data type.
List<E> bS
A Binary Set data type.
Map<K,V> m
A Map of attribute values.
List<E> l
A List of attribute values.
Boolean nULLValue
A Null data type.
Boolean bOOL
A Boolean data type.
AttributeValue value
String action
Specifies how to perform the update. Valid values are PUT
(default), DELETE, and ADD. The behavior
depends on whether the specified primary key already exists in the table.
If an item with the specified Key is found in the table:
PUT - Adds the specified attribute to the item. If the
attribute already exists, it is replaced by the new value.
DELETE - If no value is specified, the attribute and its
value are removed from the item. The data type of the specified value
must match the existing value's data type.
If a set of values is specified, then those values are subtracted
from the old set. For example, if the attribute value was the set
[a,b,c] and the DELETE action specified
[a,c], then the final attribute value would be
[b]. Specifying an empty set is an error.
ADD - If the attribute does not already exist, then the
attribute and its values are added to the item. If the attribute does
exist, then the behavior of ADD depends on the data type of
the attribute:
If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for
an item that doesn't exist before the update, DynamoDB uses 0 as the
initial value.
In addition, if you use ADD to update an existing item, and
intend to increment or decrement an attribute value which does not yet
exist, DynamoDB uses 0 as the initial value. For example,
suppose that the item you want to update does not yet have an attribute
named itemcount, but you decide to ADD the number
3 to this attribute anyway, even though it currently does
not exist. DynamoDB will create the itemcount attribute, set its
initial value to 0, and finally add 3 to it.
The result will be a new itemcount attribute in the item, with a
value of 3.
If the existing data type is a set, and if the Value is also a
set, then the Value is added to the existing set. (This is a
set operation, not mathematical addition.) For example, if the
attribute value was the set [1,2], and the ADD
action specified [3], then the final attribute value would
be [1,2,3]. An error occurs if an Add action is specified
for a set attribute and the attribute type specified does not match the
existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid for an existing attribute whose data type is
number or is a set. Do not use ADD for any other data types.
If no item with the specified Key is found:
PUT - DynamoDB creates a new item with the specified primary
key, and then adds the attribute.
DELETE - Nothing happens; there is no attribute to delete.
ADD - DynamoDB creates an item with the supplied primary key
and number (or set of numbers) for the attribute value. The only data
types allowed are number and number set; no other data types can be
specified.
Map<K,V> requestItems
A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per BatchGetItem request.
Each element in the map of items to retrieve consists of the following:
ConsistentRead - If true, a strongly consistent read
is used; if false (the default), an eventually consistent
read is used.
ExpressionAttributeNames - One or more substitution tokens for attribute names in the ProjectionExpression parameter. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Keys - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide all of the key attributes. For example, with a hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
ProjectionExpression - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
AttributesToGet -
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
String returnConsumedCapacity
Map<K,V> responses
A map of table name to a list of items. Each object in Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.
Map<K,V> unprocessedKeys
A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.
Each element consists of:
Keys - An array of primary key attribute values that define specific items in the table.
AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.
ConsistentRead - The consistency of a read operation. If set to
true, then a strongly consistent read is used; otherwise, an
eventually consistent read is used.
If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.
List<E> consumedCapacity
The read capacity units consumed by the operation.
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
Map<K,V> requestItems
A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:
DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:
Key - A map of primary key attribute values that uniquely identify the ! item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
String returnConsumedCapacity
String returnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to
SIZE, the response includes statistics about item
collections, if any, that were modified during the operation are returned
in the response. If set to NONE (the default), no statistics
are returned.
Map<K,V> unprocessedItems
A map of tables and requests against those tables that were not processed. The UnprocessedItems value is in the same form as RequestItems, so you can provide this value directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.
Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to perform (DeleteRequest or PutRequest).
DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:
Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.
Map<K,V> itemCollectionMetrics
A list of tables that were processed by BatchWriteItem and, for each table, information about any item collections that were affected by individual DeleteItem or PutItem operations.
Each entry consists of the following subelements:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
List<E> consumedCapacity
The capacity units consumed by the operation.
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
Double capacityUnits
The total number of capacity units consumed on a table or an index.
List<E> attributeValueList
One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based
on ASCII character code values. For example, a is greater
than A, and a is greater than B.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
String comparisonOperator
A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is supported for all datatypes,
including lists and maps.
AttributeValueList can contain only one AttributeValue
element of type String, Number, Binary, String Set, Number Set, or Binary
Set. If an item contains an AttributeValue element of a different
type than the one provided in the request, the value does not match. For
example, {"S":"6"} does not equal {"N":"6"}.
Also, {"N":"6"} does not equal
{"NS":["6", "2", "1"]}.
NE : Not equal. NE is supported for all
datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of
type String, Number, Binary, String Set, Number Set, or Binary Set. If an
item contains an AttributeValue of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2", "1"]}
.
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
LT : Less than.
AttributeValueList can contain only one AttributeValue of
type String, Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one provided
in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
NOT_NULL : The attribute exists. NOT_NULL is
supported for all datatypes, including lists and maps.
This operator tests for the existence of an attribute, not its data type.
If the data type of attribute "a" is null, and you evaluate
it using NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type is
not relevant to the NOT_NULL comparison operator.
NULL : The attribute does not exist. NULL is
supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data
type. If the data type of attribute "a" is null, and you
evaluate it using NULL, the result is a Boolean
false. This is because the attribute "a" exists; its
data type is not relevant to the NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is of type String, then the operator checks
for a substring match. If the target attribute of the comparison is of
type Binary, then the operator looks for a subsequence of the target that
matches the input. If the target attribute of the comparison is a set ("
SS", "NS", or "BS"), then the
operator evaluates to true if it finds an exact match with any member of
the set.
CONTAINS is supported for lists: When evaluating "
a CONTAINS b", "a" can be a list; however, "
b" cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is a String, then the operator checks for the
absence of a substring match. If the target attribute of the comparison
is Binary, then the operator checks for the absence of a subsequence of
the target that matches the input. If the target attribute of the
comparison is a set ("SS", "NS", or "
BS"), then the operator evaluates to true if it does
not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating "
a NOT CONTAINS b", "a
" can be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first value, and less
than or equal to the second value.
AttributeValueList must contain two AttributeValue elements
of the same type, either String, Number, or Binary (not a set type). A
target attribute matches if the target value is greater than, or equal
to, the first element and less than, or equal to, the second element. If
an item contains an AttributeValue element of a different type
than the one provided in the request, the value does not match. For
example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare to
{"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
String tableName
The name of the table that was affected by the operation.
Double capacityUnits
The total number of capacity units consumed by the operation.
Capacity table
The amount of throughput consumed on the table affected by the operation.
Map<K,V> localSecondaryIndexes
The amount of throughput consumed on each local index affected by the operation.
Map<K,V> globalSecondaryIndexes
The amount of throughput consumed on each global index affected by the operation.
String indexName
The name of the global secondary index to be created.
List<E> keySchema
The key schema for the global secondary index.
Projection projection
ProvisionedThroughput provisionedThroughput
List<E> attributeDefinitions
An array of attributes that describe the key schema for the table and indexes.
String tableName
The name of the table to create.
List<E> keySchema
Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.
Each KeySchemaElement in the array is composed of:
AttributeName - The name of this key attribute.
KeyType - Determines whether the key attribute is
HASH or RANGE.
For a primary key that consists of a hash attribute, you must provide
exactly one element with a KeyType of HASH.
For a primary key that consists of hash and range attributes, you must
provide exactly two elements, in this order: The first element must have
a KeyType of HASH, and the second element must have a
KeyType of RANGE.
For more information, see Specifying the Primary Key in the Amazon DynamoDB Developer Guide.
List<E> localSecondaryIndexes
One or more local secondary indexes (the maximum is five) to be created on the table. Each index is scoped to a given hash key value. There is a 10 GB size limit per hash key; otherwise, the size of a local secondary index is unconstrained.
Each local secondary index in the array includes the following:
IndexName - The name of the local secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same hash key attribute as the table.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY - Only the index and primary keys are projected
into the index.
INCLUDE - Only the specified table attributes are projected
into the index. The list of projected attributes are in
NonKeyAttributes.
ALL - All of the table attributes are projected into the
index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
List<E> globalSecondaryIndexes
One or more global secondary indexes (the maximum is five) to be created on the table. Each global secondary index in the array includes the following:
IndexName - The name of the global secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the global secondary index.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY - Only the index and primary keys are projected
into the index.
INCLUDE - Only the specified table attributes are projected
into the index. The list of projected attributes are in
NonKeyAttributes.
ALL - All of the table attributes are projected into the
index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.
ProvisionedThroughput provisionedThroughput
StreamSpecification streamSpecification
The settings for DynamoDB Streams on the table. These settings consist of:
StreamEnabled - Indicates whether Streams is to be enabled (true) or disabled (false).
StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values for StreamViewType are:
KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
TableDescription tableDescription
String indexName
The name of the global secondary index to be deleted.
String tableName
The name of the table from which to delete the item.
Map<K,V> key
A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
Map<K,V> expected
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the DeleteItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based
on ASCII character code values. For example, a is greater
than A, and a is greater than B.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is supported for all datatypes,
including lists and maps.
AttributeValueList can contain only one AttributeValue
element of type String, Number, Binary, String Set, Number Set, or Binary
Set. If an item contains an AttributeValue element of a different
type than the one provided in the request, the value does not match. For
example, {"S":"6"} does not equal {"N":"6"}.
Also, {"N":"6"} does not equal
{"NS":["6", "2", "1"]}.
NE : Not equal. NE is supported for all
datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of
type String, Number, Binary, String Set, Number Set, or Binary Set. If an
item contains an AttributeValue of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2", "1"]}
.
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
LT : Less than.
AttributeValueList can contain only one AttributeValue of
type String, Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one provided
in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
NOT_NULL : The attribute exists. NOT_NULL is
supported for all datatypes, including lists and maps.
This operator tests for the existence of an attribute, not its data type.
If the data type of attribute "a" is null, and you evaluate
it using NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type is
not relevant to the NOT_NULL comparison operator.
NULL : The attribute does not exist. NULL is
supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data
type. If the data type of attribute "a" is null, and you
evaluate it using NULL, the result is a Boolean
false. This is because the attribute "a" exists; its
data type is not relevant to the NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is of type String, then the operator checks
for a substring match. If the target attribute of the comparison is of
type Binary, then the operator looks for a subsequence of the target that
matches the input. If the target attribute of the comparison is a set ("
SS", "NS", or "BS"), then the
operator evaluates to true if it finds an exact match with any member of
the set.
CONTAINS is supported for lists: When evaluating "
a CONTAINS b", "a" can be a list; however, "
b" cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is a String, then the operator checks for the
absence of a substring match. If the target attribute of the comparison
is Binary, then the operator checks for the absence of a subsequence of
the target that matches the input. If the target attribute of the
comparison is a set ("SS", "NS", or "
BS"), then the operator evaluates to true if it does
not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating "
a NOT CONTAINS b", "a
" can be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first value, and less
than or equal to the second value.
AttributeValueList must contain two AttributeValue elements
of the same type, either String, Number, or Binary (not a set type). A
target attribute matches if the target value is greater than, or equal
to, the first element and less than, or equal to, the second element. If
an item contains an AttributeValue element of a different type
than the one provided in the request, the value does not match. For
example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare to
{"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true, DynamoDB will check to see if that
attribute value already exists in the table. If it is found, then the
condition evaluates to true; otherwise the condition evaluate to false.
If Exists is false, DynamoDB assumes that the
attribute value does not exist in the table. If in fact the value
does not exist, then the assumption is valid and the condition evaluates
to true. If the value is found, despite the assumption that it does not
exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
String conditionalOperator
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND - If all of the conditions evaluate to true, then the
entire map evaluates to true.
OR - If at least one of the conditions evaluate to true,
then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the
default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
String returnValues
Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:
NONE - If ReturnValues is not specified, or if its
value is NONE, then nothing is returned. (This setting is
the default for ReturnValues.)
ALL_OLD - The content of the old item is returned.
String returnConsumedCapacity
String returnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to
SIZE, the response includes statistics about item
collections, if any, that were modified during the operation are returned
in the response. If set to NONE (the default), no statistics
are returned.
String conditionExpression
A condition that must be satisfied in order for a conditional DeleteItem to succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators:
= | | | | = | = | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
Map<K,V> attributes
A map of attribute names to AttributeValue objects, representing
the item as it appeared before the DeleteItem operation. This map
appears in the response only if ReturnValues was specified as
ALL_OLD in the request.
ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.
Each ItemCollectionMetrics element consists of:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
String tableName
The name of the table to delete.
TableDescription tableDescription
String streamArn
The Amazon Resource Name (ARN) for the stream.
Integer limit
The maximum number of shard objects to return. The upper limit is 100.
String exclusiveStartShardId
The shard ID of the first item that this operation will evaluate. Use the
value that was returned for LastEvaluatedShardId in the
previous operation.
StreamDescription streamDescription
A complete description of the stream, including its creation date and time, the DynamoDB table associated with the stream, the shard IDs within the stream, and the beginning and ending sequence numbers of stream records within the shards.
String tableName
The name of the table to describe.
TableDescription table
AttributeValue value
Boolean exists
Causes DynamoDB to evaluate the value before attempting a conditional operation:
If Exists is true, DynamoDB will check to see if that
attribute value already exists in the table. If it is found, then the
operation succeeds. If it is not found, the operation fails with a
ConditionalCheckFailedException.
If Exists is false, DynamoDB assumes that the
attribute value does not exist in the table. If in fact the value does
not exist, then the assumption is valid and the operation succeeds. If
the value is found, despite the assumption that it does not exist, the
operation fails with a ConditionalCheckFailedException.
The default setting for Exists is true. If you supply
a Value all by itself, DynamoDB assumes the attribute exists: You
don't have to set Exists to true, because it is
implied.
DynamoDB returns a ValidationException if:
Exists is true but there is no Value to check.
(You expect a value to exist, but don't specify what that value is.)
Exists is false but you also provide a Value.
(You cannot expect an attribute to have a value, while also expecting it
not to exist.)
String comparisonOperator
A comparator for evaluating attributes in the AttributeValueList. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is supported for all datatypes,
including lists and maps.
AttributeValueList can contain only one AttributeValue
element of type String, Number, Binary, String Set, Number Set, or Binary
Set. If an item contains an AttributeValue element of a different
type than the one provided in the request, the value does not match. For
example, {"S":"6"} does not equal {"N":"6"}.
Also, {"N":"6"} does not equal
{"NS":["6", "2", "1"]}.
NE : Not equal. NE is supported for all
datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of
type String, Number, Binary, String Set, Number Set, or Binary Set. If an
item contains an AttributeValue of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2", "1"]}
.
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
LT : Less than.
AttributeValueList can contain only one AttributeValue of
type String, Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one provided
in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
NOT_NULL : The attribute exists. NOT_NULL is
supported for all datatypes, including lists and maps.
This operator tests for the existence of an attribute, not its data type.
If the data type of attribute "a" is null, and you evaluate
it using NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type is
not relevant to the NOT_NULL comparison operator.
NULL : The attribute does not exist. NULL is
supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data
type. If the data type of attribute "a" is null, and you
evaluate it using NULL, the result is a Boolean
false. This is because the attribute "a" exists; its
data type is not relevant to the NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is of type String, then the operator checks
for a substring match. If the target attribute of the comparison is of
type Binary, then the operator looks for a subsequence of the target that
matches the input. If the target attribute of the comparison is a set ("
SS", "NS", or "BS"), then the
operator evaluates to true if it finds an exact match with any member of
the set.
CONTAINS is supported for lists: When evaluating "
a CONTAINS b", "a" can be a list; however, "
b" cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is a String, then the operator checks for the
absence of a substring match. If the target attribute of the comparison
is Binary, then the operator checks for the absence of a subsequence of
the target that matches the input. If the target attribute of the
comparison is a set ("SS", "NS", or "
BS"), then the operator evaluates to true if it does
not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating "
a NOT CONTAINS b", "a
" can be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first value, and less
than or equal to the second value.
AttributeValueList must contain two AttributeValue elements
of the same type, either String, Number, or Binary (not a set type). A
target attribute matches if the target value is greater than, or equal
to, the first element and less than, or equal to, the second element. If
an item contains an AttributeValue element of a different type
than the one provided in the request, the value does not match. For
example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare to
{"NS":["6", "2", "1"]}
List<E> attributeValueList
One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based
on ASCII character code values. For example, a is greater
than A, and a is greater than B.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
String tableName
The name of the table containing the requested item.
Map<K,V> key
A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve.
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
List<E> attributesToGet
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
Boolean consistentRead
Determines the read consistency model: If set to true, then
the operation uses strongly consistent reads; otherwise, the operation
uses eventually consistent reads.
String returnConsumedCapacity
String projectionExpression
A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> item
A map of attribute names to AttributeValue objects, as specified by AttributesToGet.
ConsumedCapacity consumedCapacity
List<E> records
The stream records from the shard, which were retrieved using the shard iterator.
String nextShardIterator
The next position in the shard from which to start sequentially reading
stream records. If set to null, the shard has been closed
and the requested iterator will not return any more data.
String streamArn
The Amazon Resource Name (ARN) for the stream.
String shardId
The identifier of the shard. The iterator will be returned for this shard ID.
String shardIteratorType
Determines how the shard iterator is used to start reading stream records from the shard:
AT_SEQUENCE_NUMBER - Start reading exactly from the position
denoted by a specific sequence number.
AFTER_SEQUENCE_NUMBER - Start reading right after the
position denoted by a specific sequence number.
TRIM_HORIZON - Start reading at the last (untrimmed) stream
record, which is the oldest record in the shard. In DynamoDB Streams,
there is a 24 hour limit on data retention. Stream records whose age
exceeds this limit are subject to removal (trimming) from the stream.
LATEST - Start reading just after the most recent stream
record in the shard, so that you always read the most recent data in the
shard.
String sequenceNumber
The sequence number of a stream record in the shard from which to start reading.
String shardIterator
The position in the shard from which to start reading stream records sequentially. A shard iterator specifies this position using the sequence number of a stream record in a shard.
String indexName
The name of the global secondary index. The name must be unique among all other indexes on this table.
List<E> keySchema
The complete key schema for a global secondary index, which consists of
one or more pairs of attribute names and key types (HASH or
RANGE).
Projection projection
ProvisionedThroughput provisionedThroughput
String indexName
The name of the global secondary index.
List<E> keySchema
The complete key schema for the global secondary index, consisting of one
or more pairs of attribute names and key types (HASH or
RANGE).
Projection projection
String indexStatus
The current state of the global secondary index:
CREATING - The index is being created.
UPDATING - The index is being updated.
DELETING - The index is being deleted.
ACTIVE - The index is ready for use.
Boolean backfilling
Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a hash key attribute cannot have any duplicates.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.
For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
ProvisionedThroughputDescription provisionedThroughput
Long indexSizeBytes
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
Long itemCount
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
String indexArn
The Amazon Resource Name (ARN) that uniquely identifies the index.
UpdateGlobalSecondaryIndexAction update
The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.
CreateGlobalSecondaryIndexAction create
The parameters required for creating a global secondary index on an existing table:
IndexName
KeySchema
AttributeDefinitions
Projection
ProvisionedThroughput
DeleteGlobalSecondaryIndexAction delete
The name of an existing global secondary index to be removed.
Map<K,V> itemCollectionKey
The hash key value of the item collection. This value is the same as the hash key of the item.
List<E> sizeEstimateRangeGB
An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
List<E> keys
The primary key attribute values that define the items and the attributes associated with the items.
List<E> attributesToGet
One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.
Boolean consistentRead
The consistency of a read operation. If set to true, then a
strongly consistent read is used; otherwise, an eventually consistent
read is used.
String projectionExpression
A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
String tableName
If this parameter is provided, then only the streams associated with this table name are returned.
Integer limit
The maximum number of streams to return. The upper limit is 100.
String exclusiveStartStreamArn
The ARN (Amazon Resource Name) of the first item that this operation will
evaluate. Use the value that was returned for
LastEvaluatedStreamArn in the previous operation.
List<E> streams
A list of stream descriptors associated with the current account and endpoint.
String lastEvaluatedStreamArn
The stream ARN of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedStreamArn is empty, then the "last page" of
results has been processed and there is no more data to be retrieved.
If LastEvaluatedStreamArn is not empty, it does not
necessarily mean that there is more data in the result set. The only way
to know when you have reached the end of the result set is when
LastEvaluatedStreamArn is empty.
String exclusiveStartTableName
The first table name that this operation will evaluate. Use the value that was returned for LastEvaluatedTableName in a previous operation, so that you can obtain the next page of results.
Integer limit
A maximum number of table names to return. If this parameter is not specified, the limit is 100.
List<E> tableNames
The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100.
If LastEvaluatedTableName also appears in the output, you can use this value as the ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the next page of results.
String lastEvaluatedTableName
The name of the last table in the current page of results. Use this value as the ExclusiveStartTableName in a new request to obtain the next page of results, until all the table names are returned.
If you do not receive a LastEvaluatedTableName value in the response, this means that there are no more table names to be retrieved.
String indexName
The name of the local secondary index. The name must be unique among all other indexes on this table.
List<E> keySchema
The complete key schema for the local secondary index, consisting of one
or more pairs of attribute names and key types (HASH or
RANGE).
Projection projection
String indexName
Represents the name of the local secondary index.
List<E> keySchema
The complete index key schema, which consists of one or more pairs of
attribute names and key types (HASH or RANGE).
Projection projection
Long indexSizeBytes
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
Long itemCount
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
String indexArn
The Amazon Resource Name (ARN) that uniquely identifies the index.
String projectionType
The set of attributes that are projected into the index:
KEYS_ONLY - Only the index and primary keys are projected
into the index.
INCLUDE - Only the specified table attributes are projected
into the index. The list of projected attributes are in
NonKeyAttributes.
ALL - All of the table attributes are projected into the
index.
List<E> nonKeyAttributes
Represents the non-key attribute names which will be projected into the index.
For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
Long readCapacityUnits
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
Long writeCapacityUnits
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
Date lastIncreaseDateTime
The date and time of the last provisioned throughput increase for this table.
Date lastDecreaseDateTime
The date and time of the last provisioned throughput decrease for this table.
Long numberOfDecreasesToday
The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.
Long readCapacityUnits
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
Long writeCapacityUnits
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
String tableName
The name of the table to contain the item.
Map<K,V> item
A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. For example, with a hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item map is an AttributeValue object.
Map<K,V> expected
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the PutItem operation.
This parameter does not support attributes of type List or Map.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based
on ASCII character code values. For example, a is greater
than A, and a is greater than B.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is supported for all datatypes,
including lists and maps.
AttributeValueList can contain only one AttributeValue
element of type String, Number, Binary, String Set, Number Set, or Binary
Set. If an item contains an AttributeValue element of a different
type than the one provided in the request, the value does not match. For
example, {"S":"6"} does not equal {"N":"6"}.
Also, {"N":"6"} does not equal
{"NS":["6", "2", "1"]}.
NE : Not equal. NE is supported for all
datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of
type String, Number, Binary, String Set, Number Set, or Binary Set. If an
item contains an AttributeValue of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2", "1"]}
.
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
LT : Less than.
AttributeValueList can contain only one AttributeValue of
type String, Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one provided
in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
NOT_NULL : The attribute exists. NOT_NULL is
supported for all datatypes, including lists and maps.
This operator tests for the existence of an attribute, not its data type.
If the data type of attribute "a" is null, and you evaluate
it using NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type is
not relevant to the NOT_NULL comparison operator.
NULL : The attribute does not exist. NULL is
supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data
type. If the data type of attribute "a" is null, and you
evaluate it using NULL, the result is a Boolean
false. This is because the attribute "a" exists; its
data type is not relevant to the NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is of type String, then the operator checks
for a substring match. If the target attribute of the comparison is of
type Binary, then the operator looks for a subsequence of the target that
matches the input. If the target attribute of the comparison is a set ("
SS", "NS", or "BS"), then the
operator evaluates to true if it finds an exact match with any member of
the set.
CONTAINS is supported for lists: When evaluating "
a CONTAINS b", "a" can be a list; however, "
b" cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is a String, then the operator checks for the
absence of a substring match. If the target attribute of the comparison
is Binary, then the operator checks for the absence of a subsequence of
the target that matches the input. If the target attribute of the
comparison is a set ("SS", "NS", or "
BS"), then the operator evaluates to true if it does
not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating "
a NOT CONTAINS b", "a
" can be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first value, and less
than or equal to the second value.
AttributeValueList must contain two AttributeValue elements
of the same type, either String, Number, or Binary (not a set type). A
target attribute matches if the target value is greater than, or equal
to, the first element and less than, or equal to, the second element. If
an item contains an AttributeValue element of a different type
than the one provided in the request, the value does not match. For
example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare to
{"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true, DynamoDB will check to see if that
attribute value already exists in the table. If it is found, then the
condition evaluates to true; otherwise the condition evaluate to false.
If Exists is false, DynamoDB assumes that the
attribute value does not exist in the table. If in fact the value
does not exist, then the assumption is valid and the condition evaluates
to true. If the value is found, despite the assumption that it does not
exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
String returnValues
Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are:
NONE - If ReturnValues is not specified, or if its
value is NONE, then nothing is returned. (This setting is
the default for ReturnValues.)
ALL_OLD - If PutItem overwrote an attribute
name-value pair, then the content of the old item is returned.
Other "Valid Values" are not relevant to PutItem.
String returnConsumedCapacity
String returnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to
SIZE, the response includes statistics about item
collections, if any, that were modified during the operation are returned
in the response. If set to NONE (the default), no statistics
are returned.
String conditionalOperator
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND - If all of the conditions evaluate to true, then the
entire map evaluates to true.
OR - If at least one of the conditions evaluate to true,
then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the
default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
String conditionExpression
A condition that must be satisfied in order for a conditional PutItem operation to succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators:
= | | | | = | = | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
Map<K,V> attributes
The attribute values as they appeared before the PutItem
operation, but only if ReturnValues is specified as
ALL_OLD in the request. Each element consists of an
attribute name and an attribute value.
ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.
Each ItemCollectionMetrics element consists of:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
Map<K,V> item
A map of attribute name to attribute values, representing the primary key of an item to be processed by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item which are part of an index key schema for the table, their types must match the index key schema.
String tableName
The name of the table containing the requested items.
String indexName
The name of an index to query. This index can be any local secondary index or global secondary index on the table. Note that if you use the IndexName parameter, you must also provide TableName.
String select
The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
ALL_ATTRIBUTES - Returns all of the item attributes from the
specified table or index. If you query a local secondary index, then for
each matching item in the index DynamoDB will fetch the entire item from
the parent table. If the index is configured to project all item
attributes, then all of the data can be obtained from the local secondary
index, and no fetching is required.
ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an
index. Retrieves all attributes that have been projected into the index.
If the index is configured to project all attributes, this return value
is equivalent to specifying ALL_ATTRIBUTES.
COUNT - Returns the number of matching items, rather than
the matching items themselves.
SPECIFIC_ATTRIBUTES - Returns only the attributes listed in
AttributesToGet. This return value is equivalent to specifying
AttributesToGet without specifying any value for Select.
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither Select nor AttributesToGet are specified,
DynamoDB defaults to ALL_ATTRIBUTES when accessing a table,
and ALL_PROJECTED_ATTRIBUTES when accessing an index. You
cannot use both Select and AttributesToGet together in a
single request, unless the value for Select is
SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying
AttributesToGet without any value for Select.)
If you use the ProjectionExpression parameter, then the value for
Select can only be SPECIFIC_ATTRIBUTES. Any other
value for Select will return an error.
List<E> attributesToGet
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both AttributesToGet and Select together in
a Query request, unless the value for Select is
SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying
AttributesToGet without any value for Select.)
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
Integer limit
The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.
Boolean consistentRead
Determines the read consistency model: If set to true, then
the operation uses strongly consistent reads; otherwise, the operation
uses eventually consistent reads.
Strongly consistent reads are not supported on global secondary indexes.
If you query a global secondary index with ConsistentRead set to
true, you will receive a ValidationException.
Map<K,V> keyConditions
This is a legacy parameter, for backward compatibility. New applications should use KeyConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
The selection criteria for the query. For a query on a table, you can
have conditions only on the table primary key attributes. You must
provide the hash key attribute name and value as an EQ
condition. You can optionally provide a second condition, referring to
the range key attribute.
If you don't provide a range key condition, all of the items that match the hash key will be retrieved. If a FilterExpression or QueryFilter is present, it will be applied after the items are retrieved.
For a query on an index, you can have conditions only on the index key
attributes. You must provide the index hash attribute name and value as
an EQ condition. You can optionally provide a second
condition, referring to the index key range attribute.
Each KeyConditions element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based
on ASCII character code values. For example, a is greater
than A, and a is greater than B.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on.
For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
The following are descriptions of these comparison operators.
EQ : Equal.
AttributeValueList can contain only one AttributeValue of
type String, Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one specified
in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2", "1"]}
.
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
LT : Less than.
AttributeValueList can contain only one AttributeValue of
type String, Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one provided
in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
BETWEEN : Greater than or equal to the first value, and less
than or equal to the second value.
AttributeValueList must contain two AttributeValue elements
of the same type, either String, Number, or Binary (not a set type). A
target attribute matches if the target value is greater than, or equal
to, the first element and less than, or equal to, the second element. If
an item contains an AttributeValue element of a different type
than the one provided in the request, the value does not match. For
example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare to
{"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
Map<K,V> queryFilter
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A condition that evaluates the query results after the items are read and returns only the desired values.
This parameter does not support attributes of type List or Map.
A QueryFilter is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
If you provide more than one condition in the QueryFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Note that QueryFilter does not allow key attributes. You cannot define a filter condition on a hash key or range key.
Each QueryFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based
on ASCII character code values. For example, a is greater
than A, and a is greater than B.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For complete descriptions of all comparison operators, see the Condition data type.
String conditionalOperator
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a QueryFilter map:
AND - If all of the conditions evaluate to true, then the
entire map evaluates to true.
OR - If at least one of the conditions evaluate to true,
then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the
default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
Boolean scanIndexForward
Specifies the order in which to return the query results - either
ascending (true) or descending (false).
Items with the same hash key are stored in sorted order by range key .If the range key data type is Number, the results are stored in numeric order. For type String, the results are returned in order of ASCII character code values. For type Binary, DynamoDB treats each byte of the binary data as unsigned.
If ScanIndexForward is true, DynamoDB returns the
results in order, by range key. This is the default behavior.
If ScanIndexForward is false, DynamoDB sorts the
results in descending order by range key, and then returns the results to
the client.
Map<K,V> exclusiveStartKey
The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
String returnConsumedCapacity
String projectionExpression
A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
String filterExpression
A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.
A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
FilterExpression replaces the legacy QueryFilter and ConditionalOperator parameters.
String keyConditionExpression
The condition that specifies the key value(s) for items to be retrieved by the Query action.
The condition must perform an equality test on a single hash key value. The condition can also perform one of several comparison tests on a single range key value. Query can use KeyConditionExpression to retrieve one item with a given hash and range key value, or several items that have the same hash key value but different range key values.
The hash key equality test is required, and must be specified in the following format:
hashAttributeName = :hashval
If you also want to provide a range key condition, it must be combined using AND with the hash key condition. Following is an example, using the = comparison operator for the range key:
hashAttributeName = :hashval AND
rangeAttributeName = :rangeval
Valid comparisons for the range key condition are as follows:
rangeAttributeName = :rangeval - true if
the range key is equal to :rangeval.
rangeAttributeName
:rangeval - true if the range key is less than
:rangeval.
rangeAttributeName =
:rangeval - true if the range key is less than or equal to
:rangeval.
rangeAttributeName
:rangeval - true if the range key is greater than
:rangeval.
rangeAttributeName =
:rangeval - true if the range key is greater than or equal
to :rangeval.
rangeAttributeName BETWEEN :rangeval1
AND :rangeval2 - true if the range key is greater
than or equal to :rangeval1, and less than or equal to
:rangeval2.
begins_with (rangeAttributeName,
:rangeval) - true if the range key begins with a
particular operand. (You cannot use this function with a range key that
is of type Number.) Note that the function name begins_with
is case-sensitive.
Use the ExpressionAttributeValues parameter to replace tokens such
as :hashval and :rangeval with actual values at
runtime.
You can optionally use the ExpressionAttributeNames parameter to replace the names of the hash and range attributes with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following KeyConditionExpression parameter causes an error because Size is a reserved word:
Size = :myval
To work around this, define a placeholder (such a #S) to
represent the attribute name Size. KeyConditionExpression
then is as follows:
#S = :myvalFor a list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.
For more information on ExpressionAttributeNames and ExpressionAttributeValues, see Using Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.
KeyConditionExpression replaces the legacy KeyConditions parameter.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
List<E> items
An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.
Integer count
The number of items in the response.
If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before> the filter was applied.
If you did not use a filter in the request, then Count and ScannedCount are the same.
Integer scannedCount
The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount is the same as Count.
Map<K,V> lastEvaluatedKey
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.
If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.
ConsumedCapacity consumedCapacity
String eventID
A globally unique identifier for the event that was recorded in this stream record.
String eventName
The type of data modification that was performed on the DynamoDB table:
INSERT - a new item was added to the table.
MODIFY - one or more of the item's attributes were updated.
REMOVE - the item was deleted from the table
String eventVersion
The version number of the stream record format. Currently, this is 1.0.
String eventSource
The AWS service from which the stream record originated. For DynamoDB Streams, this is aws:dynamodb.
String awsRegion
The region in which the GetRecords request was received.
StreamRecord dynamodb
The main body of the stream record, containing all of the DynamoDB-specific fields.
String tableName
The name of the table containing the requested items; or, if you provide
IndexName, the name of the table to which that index
belongs.
String indexName
The name of a secondary index to scan. This index can be any local
secondary index or global secondary index. Note that if you use the
IndexName parameter, you must also provide
TableName.
List<E> attributesToGet
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
Integer limit
The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.
String select
The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, or the count of matching items.
ALL_ATTRIBUTES - Returns all of the item attributes.
COUNT - Returns the number of matching items, rather than
the matching items themselves.
SPECIFIC_ATTRIBUTES - Returns only the attributes listed in
AttributesToGet. This return value is equivalent to specifying
AttributesToGet without specifying any value for Select.
If neither Select nor AttributesToGet are specified,
DynamoDB defaults to ALL_ATTRIBUTES. You cannot use both
AttributesToGet and Select together in a single request,
unless the value for Select is SPECIFIC_ATTRIBUTES.
(This usage is equivalent to specifying AttributesToGet without
any value for Select.)
Map<K,V> scanFilter
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A condition that evaluates the scan results and returns only the desired values.
This parameter does not support attributes of type List or Map.
If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each ScanFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator .
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based
on ASCII character code values. For example, a is greater
than A, and a is greater than B.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For complete descriptions of all comparison operators, see Condition.
String conditionalOperator
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a ScanFilter map:
AND - If all of the conditions evaluate to true, then the
entire map evaluates to true.
OR - If at least one of the conditions evaluate to true,
then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the
default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
Map<K,V> exclusiveStartKey
The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
String returnConsumedCapacity
Integer totalSegments
For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4.
The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
Integer segment
For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.
Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
If you provide Segment, you must also provide TotalSegments.
String projectionExpression
A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
String filterExpression
A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.
A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
FilterExpression replaces the legacy ScanFilter and ConditionalOperator parameters.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
Boolean consistentRead
A Boolean value that determines the read consistency model during the scan:
If ConsistentRead is false, then Scan will use
eventually consistent reads. The data returned from Scan might not
contain the results of other recently completed write operations
(PutItem, UpdateItem or DeleteItem). The Scan response might
include some stale data.
If ConsistentRead is true, then Scan will use
strongly consistent reads. All of the write operations that completed
before the Scan began are guaranteed to be contained in the
Scan response.
The default setting for ConsistentRead is false,
meaning that eventually consistent reads will be used.
Strongly consistent reads are not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.
List<E> items
An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.
Integer count
The number of items in the response.
If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.
If you did not use a filter in the request, then Count is the same as ScannedCount.
Integer scannedCount
The number of items evaluated, before any ScanFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount is the same as Count.
Map<K,V> lastEvaluatedKey
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.
If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.
ConsumedCapacity consumedCapacity
String shardId
The system-generated identifier for this shard.
SequenceNumberRange sequenceNumberRange
The range of possible sequence numbers for the shard.
String parentShardId
The shard ID of the current shard's parent.
String streamArn
The Amazon Resource Name (ARN) for the stream.
String tableName
The DynamoDB table with which the stream is associated.
String streamLabel
A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:
the AWS customer ID.
the table name
the StreamLabel
String streamArn
The Amazon Resource Name (ARN) for the stream.
String streamLabel
A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:
the AWS customer ID.
the table name
the StreamLabel
String streamStatus
Indicates the current status of the stream:
ENABLING - Streams is currently being enabled on the
DynamoDB table.
ENABLING - the stream is enabled.
DISABLING - Streams is currently being disabled on the
DynamoDB table.
DISABLED - the stream is disabled.
String streamViewType
Indicates the format of the records within this stream:
KEYS_ONLY - only the key attributes of items that were
modified in the DynamoDB table.
NEW_IMAGE - entire item from the table, as it appeared after
they were modified.
OLD_IMAGE - entire item from the table, as it appeared
before they were modified.
NEW_AND_OLD_IMAGES - both the new and the old images of the
items from the table.
Date creationRequestDateTime
The date and time when the request to create this stream was issued.
String tableName
The DynamoDB table with which the stream is associated.
List<E> keySchema
The key attribute(s) of the stream's DynamoDB table.
List<E> shards
The shards that comprise the stream.
String lastEvaluatedShardId
The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedShardId is empty, then the "last page" of
results has been processed and there is currently no more data to be
retrieved.
If LastEvaluatedShardId is not empty, it does not
necessarily mean that there is more data in the result set. The only way
to know when you have reached the end of the result set is when
LastEvaluatedShardId is empty.
Map<K,V> keys
The primary key attribute(s) for the DynamoDB item that was modified.
Map<K,V> newImage
The item in the DynamoDB table as it appeared after it was modified.
Map<K,V> oldImage
The item in the DynamoDB table as it appeared before it was modified.
String sequenceNumber
The sequence number of the stream record.
Long sizeBytes
The size of the stream record, in bytes.
String streamViewType
The type of data from the modified DynamoDB item that was captured in this stream record:
KEYS_ONLY - only the key attributes of the modified item.
NEW_IMAGE - the entire item, as it appears after it was
modified.
OLD_IMAGE - the entire item, as it appeared before it was
modified.
NEW_AND_OLD_IMAGES — both the new and the old item images of
the item.
Boolean streamEnabled
Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
String streamViewType
The DynamoDB Streams settings for the table. These settings consist of:
StreamEnabled - Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:
KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
List<E> attributeDefinitions
An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.
Each AttributeDefinition object in this array is composed of:
AttributeName - The name of the attribute.
AttributeType - The data type for the attribute.
String tableName
The name of the table.
List<E> keySchema
The primary key structure for the table. Each KeySchemaElement consists of:
AttributeName - The name of the attribute.
KeyType - The key type for the attribute. Can be either
HASH or RANGE.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
String tableStatus
The current state of the table:
CREATING - The table is being created.
UPDATING - The table is being updated.
DELETING - The table is being deleted.
ACTIVE - The table is ready for use.
Date creationDateTime
The date and time when the table was created, in UNIX epoch time format.
ProvisionedThroughputDescription provisionedThroughput
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
Long tableSizeBytes
The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
Long itemCount
The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
String tableArn
The Amazon Resource Name (ARN) that uniquely identifies the table.
List<E> localSecondaryIndexes
Represents one or more local secondary indexes on the table. Each index is scoped to a given hash key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
IndexName - The name of the local secondary index.
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY - Only the index and primary keys are projected
into the index.
INCLUDE - Only the specified table attributes are projected
into the index. The list of projected attributes are in
NonKeyAttributes.
ALL - All of the table attributes are projected into the
index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the DELETING state, no information about
indexes will be returned.
List<E> globalSecondaryIndexes
The global secondary indexes, if any, on the table. Each index is scoped to a given hash key value. Each element is composed of:
Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)
IndexName - The name of the global secondary index.
IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexStatus - The current status of the global secondary index:
CREATING - The index is being created.
UPDATING - The index is being updated.
DELETING - The index is being deleted.
ACTIVE - The index is ready for use.
ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY - Only the index and primary keys are projected
into the index.
INCLUDE - Only the specified table attributes are projected
into the index. The list of projected attributes are in
NonKeyAttributes.
ALL - All of the table attributes are projected into the
index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the DELETING state, no information about
indexes will be returned.
StreamSpecification streamSpecification
The current DynamoDB Streams configuration for the table.
String latestStreamLabel
A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:
the AWS customer ID.
the table name.
the StreamLabel.
String latestStreamArn
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
String indexName
The name of the global secondary index to be updated.
ProvisionedThroughput provisionedThroughput
String tableName
The name of the table containing the item to update.
Map<K,V> key
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
Map<K,V> attributeUpdates
This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements.
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any nonkey attributes.
Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.
Each AttributeUpdates element consists of an attribute name to modify, along with the following:
Value - The new value, if applicable, for this attribute.
Action - A value that specifies how to perform the update. This
action is only valid for an existing attribute whose data type is Number
or is a set; do not use ADD for other data types.
If an item with the specified primary key is found in the table, the following values perform the following actions:
PUT - Adds the specified attribute to the item. If the
attribute already exists, it is replaced by the new value.
DELETE - Removes the attribute and its value, if no value is
specified for DELETE. The data type of the specified value
must match the existing value's data type.
If a set of values is specified, then those values are subtracted from
the old set. For example, if the attribute value was the set
[a,b,c] and the DELETE action specifies
[a,c], then the final attribute value is [b].
Specifying an empty set is an error.
ADD - Adds the specified value to the item, if the attribute
does not already exist. If the attribute does exist, then the behavior of
ADD depends on the data type of the attribute:
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for
an item that doesn't exist before the update, DynamoDB uses 0 as the
initial value.
Similarly, if you use ADD for an existing item to increment
or decrement an attribute value that doesn't exist before the update,
DynamoDB uses 0 as the initial value. For example, suppose
that the item you want to update doesn't have an attribute named
itemcount, but you decide to ADD the number
3 to this attribute anyway. DynamoDB will create the
itemcount attribute, set its initial value to 0, and
finally add 3 to it. The result will be a new
itemcount attribute, with a value of 3.
If the existing data type is a set, and if Value is also a set,
then Value is appended to the existing set. For example, if the
attribute value is the set [1,2], and the ADD
action specified [3], then the final attribute value is
[1,2,3]. An error occurs if an ADD action is
specified for a set attribute and the attribute type specified does not
match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, Value must also be a set of strings.
If no item with the specified key is found in the table, the following values perform the following actions:
PUT - Causes DynamoDB to create a new item with the
specified primary key, and then adds the attribute.
DELETE - Nothing happens, because attributes cannot be
deleted from a nonexistent item. The operation succeeds, but DynamoDB
does not create a new item.
ADD - Causes DynamoDB to create an item with the supplied
primary key and number (or set of numbers) for the attribute value. The
only data types allowed are Number and Number Set.
If you provide any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
Map<K,V> expected
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based
on ASCII character code values. For example, a is greater
than A, and a is greater than B.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is supported for all datatypes,
including lists and maps.
AttributeValueList can contain only one AttributeValue
element of type String, Number, Binary, String Set, Number Set, or Binary
Set. If an item contains an AttributeValue element of a different
type than the one provided in the request, the value does not match. For
example, {"S":"6"} does not equal {"N":"6"}.
Also, {"N":"6"} does not equal
{"NS":["6", "2", "1"]}.
NE : Not equal. NE is supported for all
datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of
type String, Number, Binary, String Set, Number Set, or Binary Set. If an
item contains an AttributeValue of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2", "1"]}
.
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
LT : Less than.
AttributeValueList can contain only one AttributeValue of
type String, Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one provided
in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If an item
contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to
{"NS":["6", "2", "1"]}.
NOT_NULL : The attribute exists. NOT_NULL is
supported for all datatypes, including lists and maps.
This operator tests for the existence of an attribute, not its data type.
If the data type of attribute "a" is null, and you evaluate
it using NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type is
not relevant to the NOT_NULL comparison operator.
NULL : The attribute does not exist. NULL is
supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data
type. If the data type of attribute "a" is null, and you
evaluate it using NULL, the result is a Boolean
false. This is because the attribute "a" exists; its
data type is not relevant to the NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is of type String, then the operator checks
for a substring match. If the target attribute of the comparison is of
type Binary, then the operator looks for a subsequence of the target that
matches the input. If the target attribute of the comparison is a set ("
SS", "NS", or "BS"), then the
operator evaluates to true if it finds an exact match with any member of
the set.
CONTAINS is supported for lists: When evaluating "
a CONTAINS b", "a" can be a list; however, "
b" cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain only one AttributeValue
element of type String, Number, or Binary (not a set type). If the target
attribute of the comparison is a String, then the operator checks for the
absence of a substring match. If the target attribute of the comparison
is Binary, then the operator checks for the absence of a subsequence of
the target that matches the input. If the target attribute of the
comparison is a set ("SS", "NS", or "
BS"), then the operator evaluates to true if it does
not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating "
a NOT CONTAINS b", "a
" can be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first value, and less
than or equal to the second value.
AttributeValueList must contain two AttributeValue elements
of the same type, either String, Number, or Binary (not a set type). A
target attribute matches if the target value is greater than, or equal
to, the first element and less than, or equal to, the second element. If
an item contains an AttributeValue element of a different type
than the one provided in the request, the value does not match. For
example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare to
{"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true, DynamoDB will check to see if that
attribute value already exists in the table. If it is found, then the
condition evaluates to true; otherwise the condition evaluate to false.
If Exists is false, DynamoDB assumes that the
attribute value does not exist in the table. If in fact the value
does not exist, then the assumption is valid and the condition evaluates
to true. If the value is found, despite the assumption that it does not
exist, the condition evaluates to false.
Note that the default value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
This parameter does not support attributes of type List or Map.
String conditionalOperator
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND - If all of the conditions evaluate to true, then the
entire map evaluates to true.
OR - If at least one of the conditions evaluate to true,
then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the
default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
String returnValues
Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:
NONE - If ReturnValues is not specified, or if its
value is NONE, then nothing is returned. (This setting is
the default for ReturnValues.)
ALL_OLD - If UpdateItem overwrote an attribute
name-value pair, then the content of the old item is returned.
UPDATED_OLD - The old versions of only the updated
attributes are returned.
ALL_NEW - All of the attributes of the new version of the
item are returned.
UPDATED_NEW - The new versions of only the updated
attributes are returned.
String returnConsumedCapacity
String returnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to
SIZE, the response includes statistics about item
collections, if any, that were modified during the operation are returned
in the response. If set to NONE (the default), no statistics
are returned.
String updateExpression
An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.
The following action values are available for UpdateExpression.
SET - Adds one or more attributes and values to an item. If
any of these attribute already exist, they are replaced by the new
values. You can also use SET to add or subtract from an
attribute that is of type Number. For example:
SET myNum = myNum + :val
SET supports the following functions:
if_not_exists (path, operand) - if the item does not contain
an attribute at the specified path, then if_not_exists
evaluates to operand; otherwise, it evaluates to path. You can use this
function to avoid overwriting an attribute that may already be present in
the item.
list_append (operand, operand) - evaluates to a list with a
new element added to it. You can append the new element to the start or
the end of the list by reversing the order of the operands.
These function names are case-sensitive.
REMOVE - Removes one or more attributes from an item.
ADD - Adds the specified value to the item, if the attribute
does not already exist. If the attribute does exist, then the behavior of
ADD depends on the data type of the attribute:
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use ADD to increment or decrement a number value for
an item that doesn't exist before the update, DynamoDB uses
0 as the initial value.
Similarly, if you use ADD for an existing item to increment
or decrement an attribute value that doesn't exist before the update,
DynamoDB uses 0 as the initial value. For example, suppose
that the item you want to update doesn't have an attribute named
itemcount, but you decide to ADD the number
3 to this attribute anyway. DynamoDB will create the
itemcount attribute, set its initial value to 0, and
finally add 3 to it. The result will be a new
itemcount attribute in the item, with a value of 3.
If the existing data type is a set and if Value is also a set,
then Value is added to the existing set. For example, if the
attribute value is the set [1,2], and the ADD
action specified [3], then the final attribute value is
[1,2,3]. An error occurs if an ADD action is
specified for a set attribute and the attribute type specified does not
match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
The ADD action only supports Number and set data types. In
addition, ADD can only be used on top-level attributes, not
nested attributes.
DELETE - Deletes an element from a set.
If a set of values is specified, then those values are subtracted from
the old set. For example, if the attribute value was the set
[a,b,c] and the DELETE action specifies
[a,c], then the final attribute value is [b].
Specifying an empty set is an error.
The DELETE action only supports set data types. In addition,
DELETE can only be used on top-level attributes, not nested
attributes.
You can have many actions in a single expression, such as the following:
SET a=:value1, b=:value2 DELETE :value3, :value4, :value5
For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
UpdateExpression replaces the legacy AttributeUpdates parameter.
String conditionExpression
A condition that must be satisfied in order for a conditional update to succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
Comparison operators:
= | | | | = | = | BETWEEN | IN
Logical operators: AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
Map<K,V> expressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeValues
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
Map<K,V> attributes
A map of attribute values as they appeared before the UpdateItem
operation. This map only appears if ReturnValues was specified as
something other than NONE in the request. Each element
represents one attribute.
ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
List<E> attributeDefinitions
An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.
String tableName
The name of the table to be updated.
ProvisionedThroughput provisionedThroughput
List<E> globalSecondaryIndexUpdates
An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:
Create - add a new global secondary index to the table.
Update - modify the provisioned throughput settings of an existing global secondary index.
Delete - remove a global secondary index from the table.
For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
StreamSpecification streamSpecification
Represents the DynamoDB Streams configuration for the table.
You will receive a ResourceInUseException if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream.
TableDescription tableDescription
PutRequest putRequest
A request to perform a PutItem operation.
DeleteRequest deleteRequest
A request to perform a DeleteItem operation.
String vpcPeeringConnectionId
VpcPeeringConnection vpcPeeringConnection
String attributeName
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeValues
String attributeValue
String instanceId
String publicIp
String allocationId
String associationId
String domain
standard) or instances in a VPC
(vpc).
Constraints:
Allowed Values: vpc, standard
String networkInterfaceId
String networkInterfaceOwnerId
String privateIpAddress
String domain
vpc to allocate the address for use with instances
in a VPC. Default: The address is for use with instances in EC2-Classic.
Constraints:
Allowed Values: vpc, standard
String publicIp
String domain
standard) or instances in a VPC
(vpc).
Constraints:
Allowed Values: vpc, standard
String allocationId
String autoPlacement
Default: Enabled
Constraints:
Allowed Values: on, off
String clientToken
String instanceType
Integer quantity
String availabilityZone
com.amazonaws.internal.ListWithAutoConstructFlag<T> hostIds
String networkInterfaceId
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
Integer secondaryPrivateIpAddressCount
Boolean allowReassignment
String instanceId
String publicIp
String allocationId
String networkInterfaceId
String privateIpAddress
Boolean allowReassociation
String associationId
String associationId
String instanceId
String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
Boolean returnValue
true if the request succeeds; otherwise, it
returns an error.String attachmentId
VolumeAttachment attachment
VpcAttachment vpcAttachment
String groupId
String sourceSecurityGroupName
String sourceSecurityGroupOwnerId
String ipProtocol
Integer fromPort
Integer toPort
String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
String groupName
String groupId
String sourceSecurityGroupName
String sourceSecurityGroupOwnerId
String ipProtocol
tcp, udp,
icmp) or number (see Protocol
Numbers). (VPC only) Use -1 to specify all.Integer fromPort
-1 to specify all
ICMP types.Integer toPort
-1 to specify all
ICMP codes for the ICMP type.String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
String zoneName
String state
Constraints:
Allowed Values: available, information, impaired, unavailable
String regionName
com.amazonaws.internal.ListWithAutoConstructFlag<T> messages
String message
com.amazonaws.internal.ListWithAutoConstructFlag<T> availableInstanceCapacity
Integer availableVCpus
String virtualName
ephemeralN). Instance store
volumes are numbered starting from 0. An instance type with 2
available instance store volumes can specify mappings for
ephemeral0 and ephemeral1.The number of
available instance store volumes depends on the instance type. After
you connect to the instance, you must mount the volume.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
String deviceName
/dev/sdh or xvdh).EbsBlockDevice ebs
String noDevice
String instanceId
Type: String
Default: None
Required: Yes
Storage storage
BundleTask bundleTask
String instanceId
String bundleId
String state
Constraints:
Allowed Values: pending, waiting-for-shutdown, bundling, storing, cancelling, complete, failed
Date startTime
Date updateTime
Storage storage
String progress
BundleTaskError bundleTaskError
String bundleId
BundleTask bundleTask
String exportTaskId
CreateInstanceExportTask.String reservedInstancesListingId
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesListings
String spotFleetRequestId
CancelSpotFleetRequestsError error
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotFleetRequestIds
Boolean terminateInstances
com.amazonaws.internal.ListWithAutoConstructFlag<T> unsuccessfulFleetRequests
com.amazonaws.internal.ListWithAutoConstructFlag<T> successfulFleetRequests
String spotFleetRequestId
String currentSpotFleetRequestState
Constraints:
Allowed Values: submitted, active, cancelled, failed, cancelled_running, cancelled_terminating, modifying
String previousSpotFleetRequestState
Constraints:
Allowed Values: submitted, active, cancelled, failed, cancelled_running, cancelled_terminating, modifying
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotInstanceRequestIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> cancelledSpotInstanceRequests
String instanceId
String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String ownerId
Boolean returnValue
true if the
specified product code is owned by the requester and associated with
the specified instance.String conversionTaskId
String expirationTime
ImportInstanceTaskDetails importInstance
ImportVolumeTaskDetails importVolume
String state
Constraints:
Allowed Values: active, cancelling, cancelled, completed
String statusMessage
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String sourceRegion
String sourceImageId
String name
String description
String clientToken
Boolean encrypted
KmsKeyId. For more information, see Amazon
EBS Encryption in the Amazon Elastic Compute Cloud User
Guide.String kmsKeyId
arn:aws:kms namespace, followed by
the region of the CMK, the AWS account ID of the CMK owner, the
key namespace, and then the CMK ID. For example,
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
The specified CMK must exist in the region that the snapshot is being
copied to. If a KmsKeyId is specified, the
Encrypted flag must also be set.String imageId
String sourceRegion
String sourceSnapshotId
String description
String destinationRegion
PresignedUrl
parameter of a snapshot copy operation. This parameter is only valid
for specifying the destination region in a PresignedUrl
parameter, where it is required. CopySnapshot
sends the snapshot copy to the regional endpoint that you send the
HTTP request to, such as ec2.us-east-1.amazonaws.com (in
the AWS CLI, this is specified with the --region
parameter or the default region in your AWS configuration file).
String presignedUrl
PresignedUrl should use
the snapshot source endpoint, the CopySnapshot action,
and include the SourceRegion,
SourceSnapshotId, and DestinationRegion
parameters. The PresignedUrl must be signed using AWS
Signature Version 4. Because EBS snapshots are stored in Amazon S3,
the signing algorithm for this parameter uses the same logic that is
described in Authenticating
Requests by Using Query Parameters (AWS Signature Version 4) in
the Amazon Simple Storage Service API Reference. An invalid or
improperly signed PresignedUrl will cause the copy
operation to fail asynchronously, and the snapshot will move to an
error state.Boolean encrypted
KmsKeyId. For more information, see Amazon
EBS Encryption in the Amazon Elastic Compute Cloud User
Guide.String kmsKeyId
arn:aws:kms namespace, followed by the region of the CMK,
the AWS account ID of the CMK owner, the key namespace,
and then the CMK ID. For example,
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
The specified CMK must exist in the region that the snapshot is being
copied to. If a KmsKeyId is specified, the
Encrypted flag must also be set.String snapshotId
String type
ipsec.1).
Constraints:
Allowed Values: ipsec.1
String publicIp
Integer bgpAsn
Default: 65000
CustomerGateway customerGateway
com.amazonaws.internal.ListWithAutoConstructFlag<T> dhcpConfigurations
DhcpOptions dhcpOptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceIds
String resourceType
Constraints:
Allowed Values: VPC, Subnet, NetworkInterface
String trafficType
Constraints:
Allowed Values: ACCEPT, REJECT, ALL
String logGroupName
String deliverLogsPermissionArn
String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> flowLogIds
String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> unsuccessful
String instanceId
String name
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
String description
Boolean noReboot
false, which means
Amazon EC2 attempts to shut down the instance cleanly before image
creation and then reboots the instance. When the parameter is set to
true, Amazon EC2 doesn't shut down the instance before
creating the image. When this option is used, file system integrity on
the created image can't be guaranteed.com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
String imageId
String description
String instanceId
String targetEnvironment
Constraints:
Allowed Values: citrix, vmware, microsoft
ExportToS3TaskSpecification exportToS3Task
ExportTask exportTask
InternetGateway internetGateway
String keyName
Constraints: Up to 255 ASCII characters
KeyPair keyPair
String subnetId
String allocationId
String clientToken
Constraint: Maximum 64 ASCII characters.
NatGateway natGateway
String clientToken
String networkAclId
Integer ruleNumber
Constraints: Positive integer from 1 to 32766
String protocol
String ruleAction
Constraints:
Allowed Values: allow, deny
Boolean egress
String cidrBlock
172.16.0.0/24).IcmpTypeCode icmpTypeCode
PortRange portRange
String vpcId
NetworkAcl networkAcl
String subnetId
String description
String privateIpAddress
privateIpAddresses as primary
(only one IP address can be designated as primary).com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
Integer secondaryPrivateIpAddressCount
privateIpAddresses. The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide.
NetworkInterface networkInterface
String reservedInstancesId
Integer instanceCount
com.amazonaws.internal.ListWithAutoConstructFlag<T> priceSchedules
String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesListings
String routeTableId
String destinationCidrBlock
String gatewayId
String instanceId
String networkInterfaceId
String vpcPeeringConnectionId
String natGatewayId
Boolean returnValue
true if the request succeeds; otherwise, it
returns an error.String vpcId
RouteTable routeTable
String groupName
Constraints: Up to 255 characters in length
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
String description
Constraints: Up to 255 characters in length
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
String vpcId
String groupId
Snapshot snapshot
SpotDatafeedSubscription spotDatafeedSubscription
String vpcId
String cidrBlock
10.0.0.0/24.String availabilityZone
Default: AWS selects one for you. If you create more than one subnet in your VPC, we may not necessarily select a different zone for each subnet.
Subnet subnet
com.amazonaws.internal.ListWithAutoConstructFlag<T> resources
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
value parameter is required, but if
you don't want the tag to have a value, specify the parameter with no
value, and we set the value to an empty string.com.amazonaws.internal.ListWithAutoConstructFlag<T> add
com.amazonaws.internal.ListWithAutoConstructFlag<T> remove
Integer size
Constraints: 1-1024
for standard volumes, 1-16384 for
gp2 volumes, and 4-16384 for
io1 volumes. If you specify a snapshot, the volume size
must be equal to or larger than the snapshot size.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
String snapshotId
String availabilityZone
String volumeType
gp2 for General Purpose
(SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or
standard for Magnetic volumes. Default:
standard
Constraints:
Allowed Values: standard, io1, gp2
Integer iops
Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes
Boolean encrypted
String kmsKeyId
arn:aws:kms namespace, followed by the
region of the CMK, the AWS account ID of the CMK owner, the
key namespace, and then the CMK ID. For example,
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
If a KmsKeyId is specified, the Encrypted
flag must also be set.Volume volume
String vpcId
String serviceName
com.amazonaws.region.service. To get a list
of available services, use the DescribeVpcEndpointServices
request.String policyDocument
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeTableIds
String clientToken
VpcEndpoint vpcEndpoint
String clientToken
VpcPeeringConnection vpcPeeringConnection
String cidrBlock
10.0.0.0/16.String instanceTenancy
default means that instances can be launched
with any tenancy; a value of dedicated means all
instances launched into the VPC are launched as dedicated tenancy
instances regardless of the tenancy assigned to the instance at
launch. Dedicated tenancy instances run on single-tenant hardware.
Important: The host value cannot be used with
this parameter. Use the default or dedicated
values only.
Default: default
Constraints:
Allowed Values: default, dedicated, host
Vpc vpc
String type
ipsec.1).String customerGatewayId
String vpnGatewayId
VpnConnectionOptionsSpecification options
true. Default: false
VpnConnection vpnConnection
VpnGateway vpnGateway
String customerGatewayId
String state
pending | available |
deleting | deleted).String type
ipsec.1).String ipAddress
String bgpAsn
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String customerGatewayId
String dhcpOptionsId
com.amazonaws.internal.ListWithAutoConstructFlag<T> flowLogIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> unsuccessful
String internetGatewayId
String keyName
String natGatewayId
String natGatewayId
String networkAclId
String networkInterfaceId
String groupName
String routeTableId
String snapshotId
String subnetId
com.amazonaws.internal.ListWithAutoConstructFlag<T> resources
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
value
parameter, we delete the tag regardless of its value. If you specify
this parameter with an empty string as the value, we delete the key
only if its value is an empty string.String volumeId
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcEndpointIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> unsuccessful
String vpcPeeringConnectionId
Boolean returnValue
true if the request succeeds; otherwise, it
returns an error.String vpcId
String vpnConnectionId
String vpnGatewayId
String imageId
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> accountAttributes
com.amazonaws.internal.ListWithAutoConstructFlag<T> publicIps
Default: Describes all your Elastic IP addresses.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
allocation-id - [EC2-VPC] The allocation ID for
the address.
association-id - [EC2-VPC] The
association ID for the address.
domain -
Indicates whether the address is for use in EC2-Classic
(standard) or in a VPC (vpc).
instance-id - The ID of the instance the address is
associated with, if any.
network-interface-id - [EC2-VPC] The ID of the network
interface that the address is associated with, if any.
network-interface-owner-id - The AWS account ID of the
owner.
private-ip-address - [EC2-VPC] The
private IP address associated with the Elastic IP address.
public-ip - The Elastic IP address.
com.amazonaws.internal.ListWithAutoConstructFlag<T> allocationIds
Default: Describes all your Elastic IP addresses.
com.amazonaws.internal.ListWithAutoConstructFlag<T> addresses
com.amazonaws.internal.ListWithAutoConstructFlag<T> zoneNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
message - Information
about the Availability Zone.
region-name -
The name of the region for the Availability Zone (for example,
us-east-1).
state - The state
of the Availability Zone (available |
information | impaired |
unavailable).
zone-name - The
name of the Availability Zone (for example, us-east-1a).
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> bundleIds
Default: Describes all your bundle tasks.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
bundle-id - The ID of
the bundle task.
error-code - If the task
failed, the error code returned.
error-message - If the task failed, the error message
returned.
instance-id - The ID of the
instance.
progress - The level of task
completion, as a percentage (for example, 20%).
s3-bucket - The Amazon S3 bucket to store the AMI.
s3-prefix - The beginning of the AMI name.
start-time - The time the task started (for
example, 2013-09-15T17:15:20.000Z).
state -
The state of the task (pending |
waiting-for-shutdown | bundling |
storing | cancelling | complete
| failed).
update-time - The
time of the most recent update for the task.
com.amazonaws.internal.ListWithAutoConstructFlag<T> bundleTasks
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
group-id - The ID of a
VPC security group that's associated with the instance.
instance-id - The ID of the instance.
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id - The ID of the VPC that the
instance is linked to.
String nextToken
Integer maxResults
NextToken
value. This value can be between 5 and 1000; if
MaxResults is given a value larger than 1000, only 1000
results are returned. You cannot specify this parameter and the
instance IDs parameter in the same request. Constraint: If the value is greater than 1000, we return only 1000 items.
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
String nextToken
null when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> conversionTaskIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> conversionTasks
com.amazonaws.internal.ListWithAutoConstructFlag<T> customerGatewayIds
Default: Describes all your customer gateways.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
bgp-asn - The customer
gateway's Border Gateway Protocol (BGP) Autonomous System Number
(ASN).
customer-gateway-id - The ID of the
customer gateway.
ip-address - The IP
address of the customer gateway's Internet-routable external
interface.
state - The state of the
customer gateway (pending | available |
deleting | deleted).
type - The type of customer gateway. Currently, the
only supported type is ipsec.1.
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
com.amazonaws.internal.ListWithAutoConstructFlag<T> customerGateways
com.amazonaws.internal.ListWithAutoConstructFlag<T> dhcpOptionsIds
Default: Describes all your DHCP options sets.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
dhcp-options-id - The
ID of a set of DHCP options.
key - The key
for one of the options (for example, domain-name).
value - The value for one of the options.
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
com.amazonaws.internal.ListWithAutoConstructFlag<T> dhcpOptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> exportTaskIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> exportTasks
com.amazonaws.internal.ListWithAutoConstructFlag<T> flowLogIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filter
deliver-log-status - The
status of the logs delivery (SUCCESS |
FAILED).
flow-log-id - The ID of
the flow log.
log-group-name - The name of
the log group.
resource-id - The ID of the
VPC, subnet, or network interface.
traffic-type - The type of traffic
(ACCEPT | REJECT | ALL)
String nextToken
Integer maxResults
NextToken value. This value can be
between 5 and 1000; if MaxResults is given a value larger
than 1000, only 1000 results are returned. You cannot specify this
parameter and the flow log IDs parameter in the same request.com.amazonaws.internal.ListWithAutoConstructFlag<T> flowLogs
String nextToken
null when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> hostIds
String nextToken
Integer maxResults
nextToken value. This value can be
between 5 and 500; if maxResults is given a larger value
than 500, you will receive an error. You cannot specify this parameter
and the host IDs parameter in the same request.com.amazonaws.internal.ListWithAutoConstructFlag<T> filter
instance-type - The
instance type size that the Dedicated host is configured to
support.
auto-placement - Whether
auto-placement is enabled or disabled (on |
off).
host-reservation-id - The
ID of the reservation associated with this host.
client-token - The idempotency token you provided
when you launched the instance
state- The
allocation state of the Dedicated host (available |
under-assessment | permanent-failure |
released | released-permanent-failure).
availability-zone - The Availability Zone of the
host.
com.amazonaws.internal.ListWithAutoConstructFlag<T> hosts
String nextToken
null when there are no more results to return.String resource
com.amazonaws.internal.ListWithAutoConstructFlag<T> statuses
String imageId
String attribute
Note: Depending on your account
privileges, the blockDeviceMapping attribute may return a
Client.AuthFailure error. If this happens, use
DescribeImages to get information about the block device
mapping for the AMI.
Constraints:
Allowed Values: description, kernel, ramdisk, launchPermission, productCodes, blockDeviceMapping, sriovNetSupport
ImageAttribute imageAttribute
com.amazonaws.internal.ListWithAutoConstructFlag<T> imageIds
Default: Describes all images available to you.
com.amazonaws.internal.ListWithAutoConstructFlag<T> owners
amazon (owner is Amazon), aws-marketplace
(owner is AWS Marketplace), self (owner is the sender of
the request). Omitting this option returns all images for which you
have launch permissions, regardless of ownership.com.amazonaws.internal.ListWithAutoConstructFlag<T> executableUsers
self (the sender of the request), or
all (public AMIs).com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
architecture - The
image architecture (i386 | x86_64).
block-device-mapping.delete-on-termination - A
Boolean value that indicates whether the Amazon EBS volume is deleted
on instance termination.
block-device-mapping.device-name - The device name for
the EBS volume (for example, /dev/sdh).
block-device-mapping.snapshot-id - The ID of the
snapshot used for the EBS volume.
block-device-mapping.volume-size - The volume size of
the EBS volume, in GiB.
block-device-mapping.volume-type - The volume type of
the EBS volume (gp2 | standard |
io1).
description - The
description of the image (provided during image creation).
hypervisor - The hypervisor type (ovm |
xen).
image-id - The ID of the
image.
image-type - The image type
(machine | kernel | ramdisk).
is-public - A Boolean that indicates
whether the image is public.
kernel-id -
The kernel ID.
manifest-location - The
location of the image manifest.
name - The
name of the AMI (provided during image creation).
owner-alias - The AWS account alias (for example,
amazon).
owner-id - The AWS
account ID of the image owner.
platform -
The platform. To only list Windows-based AMIs, use
windows.
product-code - The
product code.
product-code.type - The type
of the product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
root-device-name - The name of the root device volume
(for example, /dev/sda1).
root-device-type - The type of the root device volume
(ebs | instance-store).
state - The state of the image (available
| pending | failed).
state-reason-code - The reason code for the state
change.
state-reason-message - The message
for the state change.
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For example, if
you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
virtualization-type - The
virtualization type (paravirtual | hvm).
com.amazonaws.internal.ListWithAutoConstructFlag<T> images
com.amazonaws.internal.ListWithAutoConstructFlag<T> importTaskIds
String nextToken
Integer maxResults
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> importImageTasks
String nextToken
null when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> importTaskIds
String nextToken
Integer maxResults
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> importSnapshotTasks
String nextToken
null when there are no more results to return.String instanceId
String attribute
Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport
InstanceAttribute instanceAttribute
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
Default: Describes all your instances.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
affinity - The affinity
setting for an instance running on a Dedicated host
(default | host).
architecture - The instance architecture
(i386 | x86_64).
availability-zone - The Availability Zone of the
instance.
block-device-mapping.attach-time
- The attach time for an EBS volume mapped to the instance, for
example, 2010-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean
that indicates whether the EBS volume is deleted on instance
termination.
block-device-mapping.device-name - The device name for
the EBS volume (for example, /dev/sdh or
xvdh).
block-device-mapping.status - The status for the EBS
volume (attaching | attached |
detaching | detached).
block-device-mapping.volume-id - The volume ID of the
EBS volume.
client-token - The idempotency
token you provided when you launched the instance.
dns-name - The public DNS name of the instance.
group-id - The ID of the security group for the
instance. EC2-Classic only.
group-name -
The name of the security group for the instance. EC2-Classic only.
host-Id - The ID of the Dedicated host on
which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance
(ovm | xen).
iam-instance-profile.arn - The instance profile
associated with the instance. Specified as an ARN.
image-id - The ID of the image used to launch the
instance.
instance-id - The ID of the
instance.
instance-lifecycle - Indicates
whether this is a Spot Instance (spot).
instance-state-code - The state of the instance, as a
16-bit unsigned integer. The high byte is an opaque internal value and
should be ignored. The low byte is set based on the state represented.
The valid values are: 0 (pending), 16 (running), 32 (shutting-down),
48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance
(pending | running |
shutting-down | terminated |
stopping | stopped).
instance-type - The type of instance (for example,
t2.micro).
instance.group-id -
The ID of the security group for the instance.
instance.group-name - The name of the security group
for the instance.
ip-address - The public
IP address of the instance.
kernel-id - The
kernel ID.
key-name - The name of the key
pair used when the instance was launched.
launch-index - When launching multiple instances, this
is the index for the instance in the launch group (for example, 0, 1,
2, and so on).
launch-time - The time when
the instance was launched.
monitoring-state
- Indicates whether monitoring is enabled for the instance
(disabled | enabled).
owner-id - The AWS account ID of the instance owner.
placement-group-name - The name of the
placement group for the instance.
platform
- The platform. Use windows if you have Windows
instances; otherwise, leave blank.
private-dns-name - The private DNS name of the
instance.
private-ip-address - The private
IP address of the instance.
product-code -
The product code associated with the AMI used to launch the instance.
product-code.type - The type of product
code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the
instance (for example, shows "User Initiated [date]" when you stop or
terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that
launched the instance on your behalf (for example, AWS Management
Console, Auto Scaling, and so on).
reservation-id - The ID of the instance's reservation.
A reservation ID is created any time you launch an instance. A
reservation ID has a one-to-one relationship with an instance launch
request, but can be associated with more than one instance if you
launch multiple instances using the same launch request. For example,
if you launch one instance, you'll get one reservation ID. If you
launch ten instances using the same launch request, you'll also get
one reservation ID.
root-device-name - The
name of the root device for the instance (for example,
/dev/sda1 or /dev/xvda).
root-device-type - The type of root device that the
instance uses (ebs | instance-store).
source-dest-check - Indicates whether the
instance performs source/destination checking. A value of
true means that checking is enabled, and
false means checking is disabled. The value must be
false for the instance to perform network address
translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot instance
request.
state-reason-code - The reason
code for the state change.
state-reason-message - A message that describes the
state change.
subnet-id - The ID of the
subnet for the instance.
tag:key=value - The key/value
combination of a tag assigned to the resource, where
tag:key is the tag's key.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
tenancy - The tenancy of an
instance (dedicated | default |
host).
virtualization-type -
The virtualization type of the instance (paravirtual |
hvm).
vpc-id - The ID of the
VPC that the instance is running in.
network-interface.description - The description of the
network interface.
network-interface.subnet-id - The ID of the subnet for
the network interface.
network-interface.vpc-id - The ID of the VPC for the
network interface.
network-interface.network-interface-id - The ID of the
network interface.
network-interface.owner-id - The ID of the owner of
the network interface.
network-interface.availability-zone - The Availability
Zone for the network interface.
network-interface.requester-id - The requester ID for
the network interface.
network-interface.requester-managed - Indicates
whether the network interface is being managed by AWS.
network-interface.status - The status of the network
interface (available) | in-use).
network-interface.mac-address - The MAC address of the
network interface.
network-interface.private-dns-name - The private DNS
name of the network interface.
network-interface.source-dest-check - Whether the
network interface performs source/destination checking. A value of
true means checking is enabled, and false
means checking is disabled. The value must be false for
the network interface to perform network address translation (NAT) in
your VPC.
network-interface.group-id - The
ID of a security group associated with the network interface.
network-interface.group-name - The name of a
security group associated with the network interface.
network-interface.attachment.attachment-id - The ID of
the interface attachment.
network-interface.attachment.instance-id - The ID of
the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The
owner ID of the instance to which the network interface is attached.
network-interface.addresses.private-ip-address - The
private IP address associated with the network interface.
network-interface.attachment.device-index - The device
index to which the network interface is attached.
network-interface.attachment.status - The status of
the attachment (attaching | attached |
detaching | detached).
network-interface.attachment.attach-time - The time
that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination -
Specifies whether the attachment is deleted when an instance is
terminated.
network-interface.addresses.primary - Specifies
whether the IP address of the network interface is the primary private
IP address.
network-interface.addresses.association.public-ip -
The ID of the association of an Elastic IP address with a network
interface.
network-interface.addresses.association.ip-owner-id -
The owner ID of the private IP address associated with the network
interface.
association.public-ip - The
address of the Elastic IP address bound to the network interface.
association.ip-owner-id - The owner of the
Elastic IP address associated with the network interface.
association.allocation-id - The allocation ID returned
when you allocated the Elastic IP address for your network interface.
association.association-id - The
association ID returned when the network interface was associated with
an IP address.
String nextToken
Integer maxResults
NextToken
value. This value can be between 5 and 1000; if
MaxResults is given a value larger than 1000, only 1000
results are returned. You cannot specify this parameter and the
instance IDs parameter in the same request.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservations
String nextToken
null when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone - The
Availability Zone of the instance.
event.code - The code for the scheduled event
(instance-reboot | system-reboot |
system-maintenance | instance-retirement |
instance-stop).
event.description - A description of the event.
event.not-after - The latest end time for the
scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before - The earliest start time
for the scheduled event (for example,
2014-09-15T17:15:20.000Z).
instance-state-code - The code for the instance state,
as a 16-bit unsigned integer. The high byte is an opaque internal
value and should be ignored. The low byte is set based on the state
represented. The valid values are 0 (pending), 16 (running), 32
(shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the
instance (pending | running |
shutting-down | terminated |
stopping | stopped).
instance-status.reachability - Filters on instance
status where the name is reachability
(passed | failed | initializing
| insufficient-data).
instance-status.status - The status of the instance
(ok | impaired | initializing |
insufficient-data | not-applicable).
system-status.reachability - Filters on system
status where the name is reachability
(passed | failed | initializing
| insufficient-data).
system-status.status - The system status of the
instance (ok | impaired |
initializing | insufficient-data |
not-applicable).
String nextToken
Integer maxResults
NextToken
value. This value can be between 5 and 1000; if
MaxResults is given a value larger than 1000, only 1000
results are returned. You cannot specify this parameter and the
instance IDs parameter in the same request.Boolean includeAllInstances
true, includes the health status for all instances.
When false, includes the health status for running
instances only. Default: false
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceStatuses
String nextToken
null when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> internetGatewayIds
Default: Describes all your Internet gateways.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
attachment.state - The
current state of the attachment between the gateway and the VPC
(available). Present only if a VPC is attached.
attachment.vpc-id - The ID of an attached VPC.
internet-gateway-id - The ID of the
Internet gateway.
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
com.amazonaws.internal.ListWithAutoConstructFlag<T> internetGateways
com.amazonaws.internal.ListWithAutoConstructFlag<T> keyNames
Default: Describes all your key pairs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
fingerprint - The
fingerprint of the key pair.
key-name - The
name of the key pair.
com.amazonaws.internal.ListWithAutoConstructFlag<T> keyPairs
com.amazonaws.internal.ListWithAutoConstructFlag<T> publicIps
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
moving-status - The
status of the Elastic IP address (MovingToVpc |
RestoringToClassic).
Integer maxResults
NextToken
value. This value can be between 5 and 1000; if
MaxResults is given a value outside of this range, an
error is returned. Default: If no value is provided, the default is 1000.
com.amazonaws.internal.ListWithAutoConstructFlag<T> movingAddressStatuses
String nextToken
null when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> natGatewayIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filter
nat-gateway-id - The ID
of the NAT gateway.
state - The state of
the NAT gateway (pending | failed |
available | deleting |
deleted).
subnet-id - The ID
of the subnet in which the NAT gateway resides.
vpc-id - The ID of the VPC in which the NAT gateway
resides.
Integer maxResults
Constraint: If the value specified is greater than 1000, we return only 1000 items.
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> natGateways
String nextToken
null when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> networkAclIds
Default: Describes all your network ACLs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
association.association-id - The ID of an association
ID for the ACL.
association.network-acl-id
- The ID of the network ACL involved in the association.
association.subnet-id - The ID of the subnet involved
in the association.
default - Indicates
whether the ACL is the default network ACL for the VPC.
entry.cidr - The CIDR range specified in the entry.
entry.egress - Indicates whether the entry
applies to egress traffic.
entry.icmp.code
- The ICMP code specified in the entry, if any.
entry.icmp.type - The ICMP type specified in the
entry, if any.
entry.port-range.from - The
start of the port range specified in the entry.
entry.port-range.to - The end of the port range
specified in the entry.
entry.protocol -
The protocol specified in the entry (tcp |
udp | icmp or a protocol number).
entry.rule-action - Allows or denies the matching
traffic (allow | deny).
entry.rule-number - The number of an entry (in other
words, rule) in the ACL's set of entries.
network-acl-id - The ID of the network ACL.
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id - The ID of the VPC for the
network ACL.
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkAcls
String networkInterfaceId
String description
Boolean sourceDestCheck
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
NetworkInterfaceAttachment attachment
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaceIds
Default: Describes all your network interfaces.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
addresses.private-ip-address - The private IP
addresses associated with the network interface.
addresses.primary - Whether the private IP address is
the primary IP address associated with the network interface.
addresses.association.public-ip - The association
ID returned when the network interface was associated with the Elastic
IP address.
addresses.association.owner-id
- The owner ID of the addresses associated with the network interface.
association.association-id - The
association ID returned when the network interface was associated with
an IP address.
association.allocation-id -
The allocation ID returned when you allocated the Elastic IP address
for your network interface.
association.ip-owner-id - The owner of the Elastic IP
address associated with the network interface.
association.public-ip - The address of the Elastic IP
address bound to the network interface.
association.public-dns-name - The public DNS name for
the network interface.
attachment.attachment-id - The ID of the interface
attachment.
attachment.attach.time - The
time that the network interface was attached to an instance.
attachment.delete-on-termination - Indicates
whether the attachment is deleted when an instance is terminated.
attachment.device-index - The device index
to which the network interface is attached.
attachment.instance-id - The ID of the instance to
which the network interface is attached.
attachment.instance-owner-id - The owner ID of the
instance to which the network interface is attached.
attachment.nat-gateway-id - The ID of the NAT gateway
to which the network interface is attached.
attachment.status - The status of the attachment
(attaching | attached |
detaching | detached).
availability-zone - The Availability Zone of the
network interface.
description - The
description of the network interface.
group-id - The ID of a security group associated with
the network interface.
group-name - The
name of a security group associated with the network interface.
mac-address - The MAC address of the network
interface.
network-interface-id - The ID of
the network interface.
owner-id - The AWS
account ID of the network interface owner.
private-ip-address - The private IP address or
addresses of the network interface.
private-dns-name - The private DNS name of the network
interface.
requester-id - The ID of the
entity that launched the instance on your behalf (for example, AWS
Management Console, Auto Scaling, and so on).
requester-managed - Indicates whether the network
interface is being managed by an AWS service (for example, AWS
Management Console, Auto Scaling, and so on).
source-desk-check - Indicates whether the network
interface performs source/destination checking. A value of
true means checking is enabled, and false
means checking is disabled. The value must be false for
the network interface to perform network address translation (NAT) in
your VPC.
status - The status of the
network interface. If the network interface is not attached to an
instance, the status is available; if a network interface
is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network
interface.
tag:key=value -
The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the
resource. This filter is independent of the tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and
the filter "tag-value=X", you get any resources assigned both the tag
key Purpose (regardless of what the tag's value is), and the tag value
X (regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id - The ID of the VPC for the
network interface.
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
Default: Describes all your placement groups, or only those otherwise specified.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
group-name - The name
of the placement group.
state - The state
of the placement group (pending | available
| deleting | deleted).
strategy - The strategy of the placement group
(cluster).
com.amazonaws.internal.ListWithAutoConstructFlag<T> placementGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> prefixListIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
prefix-list-id: The ID
of a prefix list.
prefix-list-name: The
name of a prefix list.
Integer maxResults
Constraint: If the value specified is greater than 1000, we return only 1000 items.
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> prefixLists
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> regionNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
endpoint - The endpoint
of the region (for example, ec2.us-east-1.amazonaws.com).
region-name - The name of the region (for
example, us-east-1).
com.amazonaws.internal.ListWithAutoConstructFlag<T> regions
String reservedInstancesId
String reservedInstancesListingId
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
reserved-instances-id -
The ID of the Reserved Instances.
reserved-instances-listing-id - The ID of the Reserved
Instances listing.
status - The status of
the Reserved Instance listing (pending |
active | cancelled | closed).
status-message - The reason for the status.
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesListings
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesModificationIds
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
client-token - The
idempotency token for the modification request.
create-date - The time when the modification request
was created.
effective-date - The time when
the modification becomes effective.
modification-result.reserved-instances-id - The ID for
the Reserved Instances created as part of the modification request.
This ID is only available when the status of the modification is
fulfilled.
modification-result.target-configuration.availability-zone
- The Availability Zone for the new Reserved Instances.
modification-result.target-configuration.instance-count
- The number of new Reserved Instances.
modification-result.target-configuration.instance-type
- The instance type of the new Reserved Instances.
modification-result.target-configuration.platform -
The network platform of the new Reserved Instances
(EC2-Classic | EC2-VPC).
reserved-instances-id - The ID of the Reserved
Instances modified.
reserved-instances-modification-id - The ID of the
modification request.
status - The status
of the Reserved Instances modification request
(processing | fulfilled |
failed).
status-message - The
reason for the status.
update-date - The
time when the modification request was last updated.
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesModifications
String nextToken
null when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesOfferingIds
String instanceType
m1.small). For more information, see Instance
Types in the Amazon Elastic Compute Cloud User Guide.
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge
String availabilityZone
String productDescription
(Amazon VPC) in the description are for use with
Amazon VPC.
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone - The
Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (for
example, one year or three years), in seconds (31536000 |
94608000).
fixed-price - The
purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered
by the reservation.
marketplace - Set to
true to show only Reserved Instance Marketplace
offerings. When this filter is not used, which is the default
behavior, all offerings from both AWS and the Reserved Instance
Marketplace are listed.
product-description
- The Reserved Instance product platform description. Instances that
include (Amazon VPC) in the product platform description
will only be displayed to EC2-Classic account holders and are for use
with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon
VPC) | SUSE Linux | SUSE Linux (Amazon
VPC) | Red Hat Enterprise Linux | Red Hat
Enterprise Linux (Amazon VPC) | Windows |
Windows (Amazon VPC) | Windows with SQL Server
Standard | Windows with SQL Server Standard (Amazon
VPC) | Windows with SQL Server Web |
Windows with SQL Server Web (Amazon VPC) | Windows with
SQL Server Enterprise | Windows with SQL Server
Enterprise (Amazon VPC))
reserved-instances-offering-id - The Reserved
Instances offering ID.
usage-price - The
usage price of the Reserved Instance, per hour (for example, 0.84).
String instanceTenancy
dedicated is applied to
instances that run in a VPC on single-tenant hardware (i.e., Dedicated
Instances). Default: default
Constraints:
Allowed Values: default, dedicated, host
String offeringType
Medium Utilization Reserved Instance offering type.
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront
String nextToken
Integer maxResults
NextToken
value. The maximum is 100. Default: 100
Boolean includeMarketplace
Long minDuration
Default: 2592000 (1 month)
Long maxDuration
Default: 94608000 (3 years)
Integer maxInstanceCount
Default: 20
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesOfferings
String nextToken
null when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesIds
Default: Describes all your Reserved Instances, or only those otherwise specified.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone - The
Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (one
year or three years), in seconds (31536000 |
94608000).
end - The time when
the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
fixed-price - The purchase price of the
Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by
the reservation.
product-description - The
Reserved Instance product platform description. Instances that include
(Amazon VPC) in the product platform description will
only be displayed to EC2-Classic account holders and are for use with
Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon
VPC) | SUSE Linux | SUSE Linux (Amazon
VPC) | Red Hat Enterprise Linux | Red Hat
Enterprise Linux (Amazon VPC) | Windows |
Windows (Amazon VPC) | Windows with SQL Server
Standard | Windows with SQL Server Standard (Amazon
VPC) | Windows with SQL Server Web | Windows
with SQL Server Web (Amazon VPC) | Windows with SQL
Server Enterprise | Windows with SQL Server Enterprise
(Amazon VPC)).
reserved-instances-id
- The ID of the Reserved Instance.
start -
The time at which the Reserved Instance purchase request was placed
(for example, 2014-08-07T11:54:42.000Z).
state - The state of the Reserved Instance
(payment-pending | active |
payment-failed | retired).
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
usage-price - The usage price of
the Reserved Instance, per hour (for example, 0.84).
String offeringType
Medium Utilization Reserved Instance offering type.
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstances
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeTableIds
Default: Describes all your route tables.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
association.route-table-association-id - The ID of an
association ID for the route table.
association.route-table-id - The ID of the route table
involved in the association.
association.subnet-id - The ID of the subnet involved
in the association.
association.main -
Indicates whether the route table is the main route table for the VPC
(true | false).
route-table-id - The ID of the route table.
route.destination-cidr-block - The CIDR range
specified in a route in the table.
route.destination-prefix-list-id - The ID (prefix) of
the AWS service specified in a route in the table.
route.gateway-id - The ID of a gateway specified in a
route in the table.
route.instance-id - The
ID of an instance specified in a route in the table.
route.nat-gateway-id - The ID of a NAT gateway.
route.origin - Describes how the route was
created. CreateRouteTable indicates that the route was
automatically created when the route table was created;
CreateRoute indicates that the route was manually added
to the route table; EnableVgwRoutePropagation indicates
that the route was propagated by route propagation.
route.state - The state of a route in the route table
(active | blackhole). The blackhole state
indicates that the route's target isn't available (for example, the
specified gateway isn't attached to the VPC, the specified NAT
instance has been terminated, and so on).
route.vpc-peering-connection-id - The ID of a VPC
peering connection specified in a route in the table.
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id - The ID of the VPC for the
route table.
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeTables
ScheduledInstanceRecurrenceRequest recurrence
SlotDateTimeRangeRequest firstSlotStartTimeRange
Integer minSlotDurationInHours
Integer maxSlotDurationInHours
MinSlotDurationInHours and less than 1,720.String nextToken
Integer maxResults
NextToken value.com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone - The
Availability Zone (for example, us-west-2a).
instance-type - The instance type (for example,
c4.large).
network-platform -
The network platform (EC2-Classic or
EC2-VPC).
platform - The
platform (Linux/UNIX or Windows).
String nextToken
null when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> scheduledInstanceAvailabilitySet
com.amazonaws.internal.ListWithAutoConstructFlag<T> scheduledInstanceIds
SlotStartTimeRangeRequest slotStartTimeRange
String nextToken
Integer maxResults
NextToken value.com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone - The
Availability Zone (for example, us-west-2a).
instance-type - The instance type (for example,
c4.large).
network-platform -
The network platform (EC2-Classic or
EC2-VPC).
platform - The
platform (Linux/UNIX or Windows).
String nextToken
null when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> scheduledInstanceSet
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
group-name filter to describe security groups by name.
Default: Describes all your security groups.
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupIds
Default: Describes all your security groups.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
description - The description of the security group.
egress.ip-permission.prefix-list-id - The
ID (prefix) of the AWS service to which the security group allows
access.
group-id - The ID of the security
group.
group-name - The name of the
security group.
ip-permission.cidr - A CIDR
range that has been granted permission.
ip-permission.from-port - The start of port range for
the TCP and UDP protocols, or an ICMP type number.
ip-permission.group-id - The ID of a security group
that has been granted permission.
ip-permission.group-name - The name of a security
group that has been granted permission.
ip-permission.protocol - The IP protocol for the
permission (tcp | udp | icmp or
a protocol number).
ip-permission.to-port -
The end of port range for the TCP and UDP protocols, or an ICMP code.
ip-permission.user-id - The ID of an AWS
account that has been granted permission.
owner-id - The AWS account ID of the owner of the
security group.
tag-key - The key of a tag
assigned to the security group.
tag-value -
The value of a tag assigned to the security group.
vpc-id - The ID of the VPC specified when the security
group was created.
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
String snapshotId
com.amazonaws.internal.ListWithAutoConstructFlag<T> createVolumePermissions
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotIds
Default: Describes snapshots for which you have launch permissions.
com.amazonaws.internal.ListWithAutoConstructFlag<T> ownerIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> restorableByUserIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
description - A
description of the snapshot.
owner-alias -
The AWS account alias (for example, amazon) that owns the
snapshot.
owner-id - The ID of the AWS
account that owns the snapshot.
progress -
The progress of the snapshot, as a percentage (for example, 80%).
snapshot-id - The snapshot ID.
start-time - The time stamp when the snapshot was
initiated.
status - The status of the
snapshot (pending | completed |
error).
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
volume-id - The ID of the volume
the snapshot is for.
volume-size - The size
of the volume, in GiB.
String nextToken
NextToken value returned from a previous paginated
DescribeSnapshots request where MaxResults
was used and the results exceeded the value of that parameter.
Pagination continues from the end of the previous results that
returned the NextToken value. This value is
null when there are no more results to return.Integer maxResults
DescribeSnapshots in paginated output. When this
parameter is used, DescribeSnapshots only returns
MaxResults results in a single page along with a
NextToken response element. The remaining results of the
initial request can be seen by sending another
DescribeSnapshots request with the returned
NextToken value. This value can be between 5 and 1000; if
MaxResults is given a value larger than 1000, only 1000
results are returned. If this parameter is not used, then
DescribeSnapshots returns all results. You cannot specify
this parameter and the snapshot IDs parameter in the same request.com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshots
String nextToken
NextToken value to include in a future
DescribeSnapshots request. When the results of a
DescribeSnapshots request exceed MaxResults,
this value can be used to retrieve the next page of results. This
value is null when there are no more results to return.SpotDatafeedSubscription spotDatafeedSubscription
String spotFleetRequestId
String nextToken
Integer maxResults
NextToken value.String spotFleetRequestId
com.amazonaws.internal.ListWithAutoConstructFlag<T> activeInstances
String nextToken
null when there are no more results to return.String spotFleetRequestId
String eventType
Constraints:
Allowed Values: instanceChange, fleetRequestChange, error
Date startTime
String nextToken
Integer maxResults
NextToken value.String spotFleetRequestId
Date startTime
Date lastEvaluatedTime
If nextToken
indicates that there are more results, this value is not present.
com.amazonaws.internal.ListWithAutoConstructFlag<T> historyRecords
String nextToken
null when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> spotFleetRequestIds
String nextToken
Integer maxResults
NextToken value.com.amazonaws.internal.ListWithAutoConstructFlag<T> spotFleetRequestConfigs
String nextToken
null when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> spotInstanceRequestIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone-group
- The Availability Zone group.
create-time
- The time stamp when the Spot instance request was created.
fault-code - The fault code related to the
request.
fault-message - The fault message
related to the request.
instance-id - The
ID of the instance that fulfilled the request.
launch-group - The Spot instance launch group.
launch.block-device-mapping.delete-on-termination
- Indicates whether the Amazon EBS volume is deleted on instance
termination.
launch.block-device-mapping.device-name - The device
name for the Amazon EBS volume (for example, /dev/sdh).
launch.block-device-mapping.snapshot-id -
The ID of the snapshot used for the Amazon EBS volume.
launch.block-device-mapping.volume-size - The size of
the Amazon EBS volume, in GiB.
launch.block-device-mapping.volume-type - The type of
the Amazon EBS volume (gp2 | standard |
io1).
launch.group-id - The
security group for the instance.
launch.image-id - The ID of the AMI.
launch.instance-type - The type of instance (for
example, m3.medium).
launch.kernel-id - The kernel ID.
launch.key-name - The name of the key pair the
instance launched with.
launch.monitoring-enabled - Whether monitoring is
enabled for the Spot instance.
launch.ramdisk-id - The RAM disk ID.
network-interface.network-interface-id - The ID of the
network interface.
network-interface.device-index - The index of the
device for the network interface attachment on the instance.
network-interface.subnet-id - The ID of the
subnet for the instance.
network-interface.description - A description of the
network interface.
network-interface.private-ip-address - The primary
private IP address of the network interface.
network-interface.delete-on-termination - Indicates
whether the network interface is deleted when the instance is
terminated.
network-interface.group-id -
The ID of the security group associated with the network interface.
network-interface.group-name - The name of
the security group associated with the network interface.
network-interface.addresses.primary - Indicates
whether the IP address is the primary private IP address.
product-description - The product description
associated with the instance (Linux/UNIX |
Windows).
spot-instance-request-id - The Spot instance request
ID.
spot-price - The maximum hourly price
for any Spot instance launched to fulfill the request.
state - The state of the Spot instance request
(open | active | closed |
cancelled | failed). Spot bid status
information can help you track your Amazon EC2 Spot instance requests.
For more information, see Spot
Bid Status in the Amazon Elastic Compute Cloud User Guide.
status-code - The short code describing the most
recent evaluation of your Spot instance request.
status-message - The message explaining the status of
the Spot instance request.
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
type - The type of Spot instance
request (one-time | persistent).
launched-availability-zone - The Availability Zone in
which the bid is launched.
valid-from - The
start date of the request.
valid-until -
The end date of the request.
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotInstanceRequests
Date startTime
Date endTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceTypes
com.amazonaws.internal.ListWithAutoConstructFlag<T> productDescriptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone - The
Availability Zone for which prices should be returned.
instance-type - The type of instance (for example,
m3.medium).
product-description - The product description for the
Spot price (Linux/UNIX | SUSE Linux |
Windows | Linux/UNIX (Amazon VPC) |
SUSE Linux (Amazon VPC) | Windows (Amazon
VPC)).
spot-price - The Spot price.
The value must match exactly (or use wildcards; greater than or less
than comparison is not supported).
timestamp - The timestamp of the Spot price history,
in UTC format (for example,
YYYY-MM-DDTHH:MM:SSZ). You
can use wildcards (* and ?). Greater than or less than comparison is
not supported.
String availabilityZone
Integer maxResults
NextToken value.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotPriceHistory
String nextToken
null when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
Default: Describes all your subnets.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availabilityZone - The
Availability Zone for the subnet. You can also use
availability-zone as the filter name.
available-ip-address-count - The number of IP
addresses in the subnet that are available.
cidrBlock - The CIDR block of the subnet. The CIDR
block you specify must exactly match the subnet's CIDR block for
information to be returned for the subnet. You can also use
cidr or cidr-block as the filter names.
defaultForAz - Indicates whether this is
the default subnet for the Availability Zone. You can also use
default-for-az as the filter name.
state - The state of the subnet (pending
| available).
subnet-id - The
ID of the subnet.
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id - The ID of the VPC for the
subnet.
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
key - The tag key.
resource-id - The resource ID.
resource-type - The resource type
(customer-gateway | dhcp-options |
image | instance |
internet-gateway | network-acl |
network-interface | reserved-instances |
route-table | security-group |
snapshot | spot-instances-request |
subnet | volume | vpc |
vpn-connection | vpn-gateway).
value - The tag value.
Integer maxResults
NextToken
value. This value can be between 5 and 1000; if
MaxResults is given a value larger than 1000, only 1000
results are returned.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String nextToken
null when there are no more results to return..String volumeId
Boolean autoEnableIO
autoEnableIO attribute.com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
attachment.attach-time
- The time stamp when the attachment initiated.
attachment.delete-on-termination - Whether the volume
is deleted on instance termination.
attachment.device - The device name that is exposed to
the instance (for example, /dev/sda1).
attachment.instance-id - The ID of the instance the
volume is attached to.
attachment.status -
The attachment state (attaching | attached |
detaching | detached).
availability-zone - The Availability Zone in which the
volume was created.
create-time - The time
stamp when the volume was created.
encrypted - The encryption status of the volume.
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was
created.
status - The status of the volume
(creating | available | in-use
| deleting | deleted | error).
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
volume-id - The volume ID.
volume-type - The Amazon EBS volume type. This
can be gp2 for General Purpose (SSD) volumes,
io1 for Provisioned IOPS (SSD) volumes, or
standard for Magnetic volumes.
String nextToken
NextToken value returned from a previous paginated
DescribeVolumes request where MaxResults was
used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the
NextToken value. This value is null when
there are no more results to return.Integer maxResults
DescribeVolumes in paginated output. When this parameter
is used, DescribeVolumes only returns
MaxResults results in a single page along with a
NextToken response element. The remaining results of the
initial request can be seen by sending another
DescribeVolumes request with the returned
NextToken value. This value can be between 5 and 1000; if
MaxResults is given a value larger than 1000, only 1000
results are returned. If this parameter is not used, then
DescribeVolumes returns all results. You cannot specify
this parameter and the volume IDs parameter in the same request.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumes
String nextToken
NextToken value to include in a future
DescribeVolumes request. When the results of a
DescribeVolumes request exceed MaxResults,
this value can be used to retrieve the next page of results. This
value is null when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeIds
Default: Describes all your volumes.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
action.code - The
action code for the event (for example,
enable-volume-io).
action.description - A description of the action.
action.event-id - The event ID associated
with the action.
availability-zone - The
Availability Zone of the instance.
event.description - A description of the event.
event.event-id - The event ID.
event.event-type - The event type (for
io-enabled: passed | failed;
for io-performance: io-performance:degraded
| io-performance:severely-degraded |
io-performance:stalled).
event.not-after - The latest end time for the event.
event.not-before - The earliest start time
for the event.
volume-status.details-name -
The cause for volume-status.status
(io-enabled | io-performance).
volume-status.details-status - The status of
volume-status.details-name (for io-enabled:
passed | failed; for
io-performance: normal |
degraded | severely-degraded |
stalled).
volume-status.status
- The status of the volume (ok | impaired |
warning | insufficient-data).
String nextToken
NextToken value to include in a future
DescribeVolumeStatus request. When the results of the
request exceed MaxResults, this value can be used to
retrieve the next page of results. This value is null
when there are no more results to return.Integer maxResults
DescribeVolumeStatus in paginated output. When this
parameter is used, the request only returns MaxResults
results in a single page along with a NextToken response
element. The remaining results of the initial request can be seen by
sending another request with the returned NextToken
value. This value can be between 5 and 1000; if
MaxResults is given a value larger than 1000, only 1000
results are returned. If this parameter is not used, then
DescribeVolumeStatus returns all results. You cannot
specify this parameter and the volume IDs parameter in the same
request.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeStatuses
String nextToken
null when there are no more results to return.String vpcId
Boolean enableDnsSupport
true, the Amazon DNS server resolves DNS
hostnames for your instances to their corresponding IP addresses;
otherwise, it does not.Boolean enableDnsHostnames
true, instances in the VPC get DNS
hostnames; otherwise, they do not.com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcIds
Integer maxResults
Constraints:
Range: 5 - 255
String nextToken
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcs
String nextToken
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
is-classic-link-enabled
- Whether the VPC is enabled for ClassicLink (true |
false).
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcs
Integer maxResults
Constraint: If the value is greater than 1000, we return only 1000 items.
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> serviceNames
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcEndpointIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
service-name: The name
of the AWS service.
vpc-id: The ID of the
VPC in which the endpoint resides.
vpc-endpoint-id: The ID of the endpoint.
vpc-endpoint-state: The state of the endpoint.
(pending | available | deleting
| deleted)
Integer maxResults
Constraint: If the value is greater than 1000, we return only 1000 items.
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcEndpoints
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcPeeringConnectionIds
Default: Describes all your VPC peering connections.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
accepter-vpc-info.cidr-block - The CIDR block of the
peer VPC.
accepter-vpc-info.owner-id - The
AWS account ID of the owner of the peer VPC.
accepter-vpc-info.vpc-id - The ID of the peer VPC.
expiration-time - The expiration date and
time for the VPC peering connection.
requester-vpc-info.cidr-block - The CIDR block of the
requester's VPC.
requester-vpc-info.owner-id - The AWS account ID of
the owner of the requester VPC.
requester-vpc-info.vpc-id - The ID of the requester
VPC.
status-code - The status of the VPC
peering connection (pending-acceptance |
failed | expired | provisioning
| active | deleted | rejected).
status-message - A message that provides
more information about the status of the VPC peering connection, if
applicable.
tag:key=value -
The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the
resource. This filter is independent of the tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and
the filter "tag-value=X", you get any resources assigned both the tag
key Purpose (regardless of what the tag's value is), and the tag value
X (regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-peering-connection-id - The ID
of the VPC peering connection.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcPeeringConnections
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcIds
Default: Describes all your VPCs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
cidr - The CIDR block
of the VPC. The CIDR block you specify must exactly match the VPC's
CIDR block for information to be returned for the VPC. Must contain
the slash followed by one or two digits (for example,
/28).
dhcp-options-id - The ID
of a set of DHCP options.
isDefault -
Indicates whether the VPC is the default VPC.
state - The state of the VPC (pending |
available).
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id - The ID of the VPC.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcs
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpnConnectionIds
Default: Describes your VPN connections.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
customer-gateway-configuration - The configuration
information for the customer gateway.
customer-gateway-id - The ID of a customer gateway
associated with the VPN connection.
state -
The state of the VPN connection (pending |
available | deleting |
deleted).
option.static-routes-only - Indicates whether the
connection has static routes only. Used for devices that do not
support Border Gateway Protocol (BGP).
route.destination-cidr-block - The destination CIDR
block. This corresponds to the subnet used in a customer data center.
bgp-asn - The BGP Autonomous System Number
(ASN) associated with a BGP device.
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
type - The type of VPN connection.
Currently the only supported type is ipsec.1.
vpn-connection-id - The ID of the VPN connection.
vpn-gateway-id - The ID of a virtual
private gateway associated with the VPN connection.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpnConnections
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpnGatewayIds
Default: Describes all your virtual private gateways.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
attachment.state - The
current state of the attachment between the gateway and the VPC
(attaching | attached |
detaching | detached).
attachment.vpc-id - The ID of an attached VPC.
availability-zone - The Availability Zone for the
virtual private gateway (if applicable).
state - The state of the virtual private gateway
(pending | available | deleting
| deleted).
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
type - The type of virtual private
gateway. Currently the only supported type is ipsec.1.
vpn-gateway-id - The ID of the virtual
private gateway.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpnGateways
Boolean returnValue
true if the request succeeds; otherwise, it
returns an error.String volumeId
String instanceId
String device
Boolean force
VolumeAttachment attachment
String key
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
String dhcpOptionsId
com.amazonaws.internal.ListWithAutoConstructFlag<T> dhcpConfigurations
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String vpcId
Boolean returnValue
true if the request succeeds; otherwise, it
returns an error.String vpcId
Boolean returnValue
true if the request succeeds; otherwise, it
returns an error.String associationId
DiskImageDetail image
String description
VolumeDetail volume
String format
Constraints:
Allowed Values: VMDK, RAW, VHD
Long size
String importManifestUrl
String checksum
String format
Constraints:
Allowed Values: VMDK, RAW, VHD
Long bytes
String importManifestUrl
String snapshotId
Integer volumeSize
Constraints: 1-1024
for standard volumes, 1-16384 for
gp2 volumes, and 4-16384 for
io1 volumes. If you specify a snapshot, the volume size
must be equal to or larger than the snapshot size.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
Boolean deleteOnTermination
String volumeType
gp2 for General Purpose (SSD) volumes,
io1 for Provisioned IOPS (SSD) volumes, and
standard for Magnetic volumes. Default:
standard
Constraints:
Allowed Values: standard, io1, gp2
Integer iops
Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.
Condition: This parameter is required for requests to create
io1 volumes; it is not used in requests to create
standard or gp2 volumes.
Boolean encrypted
String volumeId
String status
Constraints:
Allowed Values: attaching, attached, detaching, detached
Date attachTime
Boolean deleteOnTermination
String volumeId
String vpcId
Boolean returnValue
true if the request succeeds; otherwise, it
returns an error.String vpcId
Boolean returnValue
true if the request succeeds; otherwise, it
returns an error.String instanceId
instanceChange events.String eventSubType
The following are the error events.
iamFleetRoleInvalid - The Spot fleet did not have
the required permissions either to launch or terminate an instance.
launchSpecTemporarilyBlacklisted - The
configuration is not valid and several attempts to launch instances
have failed. For more information, see the description of the event.
spotFleetRequestConfigurationInvalid - The
configuration is not valid. For more information, see the description
of the event.
spotInstanceCountLimitExceeded - You've reached the
limit on the number of Spot instances that you can launch.
The following are the fleetRequestChange events.
active - The Spot fleet has been validated and
Amazon EC2 is attempting to maintain the target number of running Spot
instances.
cancelled - The Spot fleet is
canceled and has no running Spot instances. The Spot fleet will be
deleted two days after its instances were terminated.
cancelled_running - The Spot fleet is canceled and
will not launch additional Spot instances, but its existing Spot
instances continue to run until they are interrupted or terminated.
cancelled_terminating - The Spot fleet is
canceled and its Spot instances are terminating.
expired - The Spot fleet request has expired. A
subsequent event indicates that the instances were terminated, if the
request was created with TerminateInstancesWithExpiration
set.
modify_in_progress - A request to
modify the Spot fleet request was accepted and is in progress.
modify_successful - The Spot fleet request was
modified.
price_update - The bid price for
a launch configuration was adjusted because it was too high. This
change is permanent.
submitted - The Spot
fleet request is being evaluated and Amazon EC2 is preparing to launch
the target number of Spot instances.
The following are
the instanceChange events.
launched - A bid was fulfilled and a new instance was
launched.
terminated - An instance was
terminated by the user.
String eventDescription
String exportTaskId
String description
String state
Constraints:
Allowed Values: active, cancelling, cancelled, completed
String statusMessage
InstanceExportDetails instanceExportDetails
ExportToS3Task exportToS3Task
String diskImageFormat
Constraints:
Allowed Values: VMDK, RAW, VHD
String containerFormat
Constraints:
Allowed Values: ova
String s3Bucket
vm-import-export@amazon.com.String s3Key
String diskImageFormat
Constraints:
Allowed Values: VMDK, RAW, VHD
String containerFormat
Constraints:
Allowed Values: ova
String s3Bucket
vm-import-export@amazon.com.String s3Prefix
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
Date creationTime
String flowLogId
String flowLogStatus
ACTIVE).String resourceId
String trafficType
Constraints:
Allowed Values: ACCEPT, REJECT, ALL
String logGroupName
String deliverLogsStatus
SUCCESS |
FAILED).String deliverLogsErrorMessage
Rate limited
indicates that CloudWatch logs throttling has been applied for one or
more network interfaces, or that you've reached the limit on the
number of CloudWatch Logs log groups that you can create. Access
error indicates that the IAM role associated with the flow log
does not have sufficient permissions to publish to CloudWatch Logs.
Unknown error indicates an internal error.String deliverLogsPermissionArn
String instanceId
String instanceId
Date timestamp
String eventType
error - Indicates an error
with the Spot fleet request.
fleetRequestChange - Indicates a change in the status
or configuration of the Spot fleet request.
instanceChange - Indicates that an instance was
launched or terminated.
Constraints:
Allowed Values: instanceChange, fleetRequestChange, error
EventInformation eventInformation
String hostId
String autoPlacement
Constraints:
Allowed Values: on, off
String hostReservationId
null response if the Dedicated host doesn't have an
associated reservation.String clientToken
HostProperties hostProperties
String state
Constraints:
Allowed Values: available, under-assessment, permanent-failure, released, released-permanent-failure
String availabilityZone
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
AvailableCapacity availableCapacity
Integer sockets
Integer cores
Integer totalVCpus
String instanceType
String imageId
String imageLocation
String state
available,
the image is successfully registered and can be used to launch an
instance.
Constraints:
Allowed Values: pending, available, invalid, deregistered, transient, failed, error
String ownerId
String creationDate
Boolean publicValue
true if this image has public launch permissions or
false if it has only implicit and explicit launch
permissions.com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
String architecture
Constraints:
Allowed Values: i386, x86_64
String imageType
Constraints:
Allowed Values: machine, kernel, ramdisk
String kernelId
String ramdiskId
String platform
Windows for Windows AMIs; otherwise blank.
Constraints:
Allowed Values: Windows
String sriovNetSupport
StateReason stateReason
String imageOwnerAlias
amazon,
self) or the AWS account ID of the AMI owner.String name
String description
String rootDeviceType
Constraints:
Allowed Values: ebs, instance-store
String rootDeviceName
/dev/sda1 or /dev/xvda).com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
String virtualizationType
Constraints:
Allowed Values: hvm, paravirtual
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String hypervisor
Constraints:
Allowed Values: ovm, xen
String imageId
com.amazonaws.internal.ListWithAutoConstructFlag<T> launchPermissions
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
String kernelId
String ramdiskId
String description
String sriovNetSupport
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
String description
String format
Valid values:
RAW | VHD | VMDK |
OVA
String url
UserBucket userBucket
String deviceName
String snapshotId
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskContainers
String licenseType
Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see VM Import/Export Prerequisites in the Amazon Elastic Compute Cloud User Guide.
Valid values: AWS | BYOL
String hypervisor
Valid values: xen
String architecture
Valid values:
i386 | x86_64
String platform
Valid values:
Windows | Linux
ClientData clientData
String clientToken
String roleName
String importTaskId
String architecture
String licenseType
String platform
String hypervisor
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotDetails
String imageId
String progress
String statusMessage
String status
String importTaskId
String architecture
Valid values:
i386 | x86_64
String licenseType
String platform
String hypervisor
Valid values:
xen
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotDetails
String imageId
String progress
String statusMessage
String status
String architecture
Constraints:
Allowed Values: i386, x86_64
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupIds
String additionalInfo
UserData userData
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge
Placement placement
Boolean monitoring
String subnetId
String instanceInitiatedShutdownBehavior
Constraints:
Allowed Values: stop, terminate
String privateIpAddress
String description
ImportInstanceLaunchSpecification launchSpecification
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskImages
String platform
Constraints:
Allowed Values: Windows
ConversionTask conversionTask
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumes
String instanceId
String platform
Constraints:
Allowed Values: Windows
String description
Long bytesConverted
String availabilityZone
DiskImageDescription image
DiskImageVolumeDescription volume
String status
String statusMessage
String description
String description
SnapshotDiskContainer diskContainer
ClientData clientData
String clientToken
String roleName
String importTaskId
SnapshotTaskDetail snapshotTaskDetail
String description
String importTaskId
SnapshotTaskDetail snapshotTaskDetail
String description
String availabilityZone
DiskImageDetail image
String description
VolumeDetail volume
ConversionTask conversionTask
Long bytesConverted
String availabilityZone
String description
DiskImageDescription image
DiskImageVolumeDescription volume
String instanceId
String imageId
InstanceState state
String privateDnsName
running state. For EC2-VPC,
this name is only available if you've enabled DNS hostnames for your
VPC.String publicDnsName
running state.
For EC2-VPC, this name is only available if you've enabled DNS
hostnames for your VPC.String stateTransitionReason
String keyName
Integer amiLaunchIndex
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge
Date launchTime
Placement placement
String kernelId
String ramdiskId
String platform
Windows for Windows instances; otherwise
blank.
Constraints:
Allowed Values: Windows
Monitoring monitoring
String subnetId
String vpcId
String privateIpAddress
String publicIpAddress
StateReason stateReason
String architecture
Constraints:
Allowed Values: i386, x86_64
String rootDeviceType
Constraints:
Allowed Values: ebs, instance-store
String rootDeviceName
/dev/sda1 or
/dev/xvda).com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
String virtualizationType
Constraints:
Allowed Values: hvm, paravirtual
String instanceLifecycle
Constraints:
Allowed Values: spot
String spotInstanceRequestId
String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
Boolean sourceDestCheck
true means checking is enabled,
and false means checking is disabled. The value must be
false for the instance to perform NAT. For more
information, see NAT
Instances in the Amazon Virtual Private Cloud User Guide.String hypervisor
Constraints:
Allowed Values: ovm, xen
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfile iamInstanceProfile
Boolean ebsOptimized
String sriovNetSupport
String instanceId
String instanceType
String kernelId
String ramdiskId
String userData
Boolean disableApiTermination
true, you can't terminate the instance
through the Amazon EC2 console, CLI, or API; otherwise, you can.String instanceInitiatedShutdownBehavior
String rootDeviceName
/dev/sda1 or
/dev/xvda).com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
Boolean ebsOptimized
String sriovNetSupport
Boolean sourceDestCheck
true means checking is enabled, and false
means checking is disabled. This value must be false for
a NAT instance to perform NAT.com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
String deviceName
/dev/sdh or xvdh).EbsInstanceBlockDevice ebs
String deviceName
/dev/sdh or xvdh).EbsInstanceBlockDeviceSpecification ebs
String virtualName
String noDevice
String instanceType
Integer availableCapacity
Integer totalCapacity
String instanceId
Monitoring monitoring
String networkInterfaceId
String subnetId
String vpcId
String description
String ownerId
String status
Constraints:
Allowed Values: available, attaching, in-use, detaching
String macAddress
String privateIpAddress
String privateDnsName
Boolean sourceDestCheck
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
InstanceNetworkInterfaceAttachment attachment
InstanceNetworkInterfaceAssociation association
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
String attachmentId
Integer deviceIndex
String status
Constraints:
Allowed Values: attaching, attached, detaching, detached
Date attachTime
Boolean deleteOnTermination
String networkInterfaceId
Integer deviceIndex
String subnetId
String description
String privateIpAddress
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
Boolean deleteOnTermination
true, the interface is deleted when the
instance is terminated. You can specify true only if
creating a new network interface when launching an instance.com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
Integer secondaryPrivateIpAddressCount
Boolean associatePublicIpAddress
true.String privateIpAddress
String privateDnsName
Boolean primary
InstanceNetworkInterfaceAssociation association
Integer code
0 :
pending
16 :
running
32 :
shutting-down
48 :
terminated
64 :
stopping
80 :
stopped
String name
Constraints:
Allowed Values: pending, running, shutting-down, terminated, stopping, stopped
String instanceId
InstanceState currentState
InstanceState previousState
String instanceId
String availabilityZone
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
InstanceState instanceState
running state.InstanceStatusSummary systemStatus
InstanceStatusSummary instanceStatus
String name
Constraints:
Allowed Values: reachability
String status
Constraints:
Allowed Values: passed, failed, insufficient-data, initializing
Date impairedSince
String code
Constraints:
Allowed Values: instance-reboot, system-reboot, system-maintenance, instance-retirement, instance-stop
String description
After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].
Date notBefore
Date notAfter
String status
Constraints:
Allowed Values: ok, impaired, insufficient-data, not-applicable, initializing
com.amazonaws.internal.ListWithAutoConstructFlag<T> details
String internetGatewayId
com.amazonaws.internal.ListWithAutoConstructFlag<T> attachments
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String ipProtocol
tcp, udp, and
icmp) or number (see Protocol
Numbers). [EC2-VPC only] When you authorize or revoke security
group rules, you can use -1 to specify all.
Integer fromPort
-1 indicates all ICMP types.Integer toPort
-1 indicates all ICMP codes for the specified
ICMP type.com.amazonaws.internal.ListWithAutoConstructFlag<T> userIdGroupPairs
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipRanges
com.amazonaws.internal.ListWithAutoConstructFlag<T> prefixListIds
String keyName
String keyFingerprint
com.amazonaws.internal.ListWithAutoConstructFlag<T> add
com.amazonaws.internal.ListWithAutoConstructFlag<T> remove
String imageId
String keyName
com.amazonaws.internal.ListWithAutoConstructFlag<T> allSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
String userData
String addressingType
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge
SpotPlacement placement
String kernelId
String ramdiskId
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
Boolean monitoringEnabled
Default: Disabled
String subnetId
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfileSpecification iamInstanceProfile
Boolean ebsOptimized
Default:
false
com.amazonaws.internal.ListWithAutoConstructFlag<T> hostIds
String autoPlacement
Constraints:
Allowed Values: on, off
com.amazonaws.internal.ListWithAutoConstructFlag<T> successful
com.amazonaws.internal.ListWithAutoConstructFlag<T> unsuccessful
String imageId
String attribute
String operationType
Constraints:
Allowed Values: add, remove
com.amazonaws.internal.ListWithAutoConstructFlag<T> userIds
launchPermission attribute.com.amazonaws.internal.ListWithAutoConstructFlag<T> userGroups
launchPermission attribute.com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
productCodes attribute.String value
description attribute.LaunchPermissionModifications launchPermission
String description
String instanceId
String attribute
Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport
String value
kernel,
ramdisk, userData,
disableApiTermination, or
instanceInitiatedShutdownBehavior attribute.com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
DeleteOnTermination attribute for volumes
that are currently attached. The volume must be owned by the caller.
If no value is specified for DeleteOnTermination, the
default is true and the volume is deleted when the
instance is terminated. To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.
Boolean sourceDestCheck
true means that checking is enabled, and
false means checking is disabled. This value must be
false for a NAT instance to perform NAT.Boolean disableApiTermination
true, you can't terminate the instance
using the Amazon EC2 console, CLI, or API; otherwise, you can. You
cannot use this paramater for Spot Instances.String instanceType
InvalidInstanceAttributeValue.String kernel
String ramdisk
String userData
String instanceInitiatedShutdownBehavior
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
Boolean ebsOptimized
String sriovNetSupport
simple to enable enhanced networking for the
instance. There is no way to disable enhanced networking at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
String instanceId
String tenancy
Constraints:
Allowed Values: dedicated, host
String affinity
Constraints:
Allowed Values: default, host
String hostId
Boolean returnValue
true if the request succeeds, and an error otherwise.String networkInterfaceId
String description
Boolean sourceDestCheck
true means checking is enabled, and false
means checking is disabled. This value must be false for
a NAT instance to perform NAT. For more information, see NAT
Instances in the Amazon Virtual Private Cloud User Guide.com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
NetworkInterfaceAttachmentChanges attachment
String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> targetConfigurations
String reservedInstancesModificationId
String snapshotId
String attribute
Only volume creation permissions may be modified at the customer level.
Constraints:
Allowed Values: productCodes, createVolumePermission
String operationType
Constraints:
Allowed Values: add, remove
com.amazonaws.internal.ListWithAutoConstructFlag<T> userIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
CreateVolumePermissionModifications createVolumePermission
String spotFleetRequestId
Integer targetCapacity
String excessCapacityTerminationPolicy
Constraints:
Allowed Values: noTermination, default
Boolean returnValue
true if the request succeeds, and an error otherwise.String vpcId
Boolean enableDnsSupport
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.
Boolean enableDnsHostnames
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.
String vpcEndpointId
Boolean resetPolicy
true to reset the policy document to the default
policy. The default policy allows access to the service.String policyDocument
com.amazonaws.internal.ListWithAutoConstructFlag<T> addRouteTableIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> removeRouteTableIds
Boolean returnValue
true if the request succeeds; otherwise, it
returns an error.String state
Constraints:
Allowed Values: disabled, disabling, enabled, pending
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceMonitorings
String publicIp
String vpcId
String subnetId
String natGatewayId
Date createTime
Date deleteTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> natGatewayAddresses
String state
Constraints:
Allowed Values: pending, failed, available, deleting, deleted
String failureCode
InsufficientFreeAddressesInSubnet |
Gateway.NotAttached |
InvalidAllocationID.NotFound |
Resource.AlreadyAssociated | InternalError)String failureMessage
Subnet has insufficient free
addresses to create this NAT gatewayNetwork vpc-xxxxxxxx has no Internet
gateway attachedElastic IP address eipalloc-xxxxxxxx could not be associated
with this NAT gatewayElastic IP address eipalloc-xxxxxxxx is already
associatedNetwork interface
eni-xxxxxxxx, created and used internally by this NAT gateway is in an
invalid state. Please try again.String publicIp
String allocationId
String privateIp
String networkInterfaceId
String networkAclId
String vpcId
Boolean isDefault
com.amazonaws.internal.ListWithAutoConstructFlag<T> entries
com.amazonaws.internal.ListWithAutoConstructFlag<T> associations
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Integer ruleNumber
String protocol
-1 means all protocols.String ruleAction
Constraints:
Allowed Values: allow, deny
Boolean egress
String cidrBlock
IcmpTypeCode icmpTypeCode
PortRange portRange
String networkInterfaceId
String subnetId
String vpcId
String availabilityZone
String description
String ownerId
String requesterId
Boolean requesterManaged
String status
Constraints:
Allowed Values: available, attaching, in-use, detaching
String macAddress
String privateIpAddress
String privateDnsName
Boolean sourceDestCheck
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
NetworkInterfaceAttachment attachment
NetworkInterfaceAssociation association
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagSet
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
String interfaceType
Constraints:
Allowed Values: interface, natGateway
String publicIp
String publicDnsName
String ipOwnerId
String allocationId
String associationId
String attachmentId
String instanceId
String instanceOwnerId
Integer deviceIndex
String status
Constraints:
Allowed Values: attaching, attached, detaching, detached
Date attachTime
Boolean deleteOnTermination
String privateIpAddress
String privateDnsName
Boolean primary
NetworkInterfaceAssociation association
String availabilityZone
String groupName
String tenancy
dedicated runs on
single-tenant hardware. The host tenancy is not supported
for the ImportInstance command.
Constraints:
Allowed Values: default, dedicated, host
String hostId
String affinity
String prefixListId
String prefixListName
com.amazonaws.internal.ListWithAutoConstructFlag<T> cidrs
String prefixListId
Long term
Double price
String currencyCode
USD.
Constraints:
Allowed Values: USD
Boolean active
A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.
Long term
Double price
String currencyCode
USD.
Constraints:
Allowed Values: USD
String gatewayId
String reservedInstancesOfferingId
Integer instanceCount
ReservedInstanceLimitPrice limitPrice
String reservedInstancesId
String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> purchaseRequests
com.amazonaws.internal.ListWithAutoConstructFlag<T> scheduledInstanceSet
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
String imageLocation
String name
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
String description
String architecture
Default: For Amazon EBS-backed AMIs,
i386. For instance store-backed AMIs, the architecture
specified in the manifest file.
Constraints:
Allowed Values: i386, x86_64
String kernelId
String ramdiskId
String rootDeviceName
/dev/sda1, or
/dev/xvda).com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
String virtualizationType
Default: paravirtual
String sriovNetSupport
simple to enable enhanced networking for the AMI
and any instances that you launch from the AMI. There is no way to disable enhanced networking at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
String imageId
String vpcPeeringConnectionId
Boolean returnValue
true if the request succeeds; otherwise, it
returns an error.com.amazonaws.internal.ListWithAutoConstructFlag<T> hostIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> successful
com.amazonaws.internal.ListWithAutoConstructFlag<T> unsuccessful
String newAssociationId
String networkAclId
Integer ruleNumber
String protocol
all or -1
to mean all protocols.String ruleAction
Constraints:
Allowed Values: allow, deny
Boolean egress
Default: If no value is specified, we replace the ingress rule.
String cidrBlock
IcmpTypeCode icmpTypeCode
PortRange portRange
String routeTableId
String destinationCidrBlock
String gatewayId
String instanceId
String networkInterfaceId
String vpcPeeringConnectionId
String natGatewayId
String newAssociationId
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
String status
Constraints:
Allowed Values: ok, impaired
Date startTime
Date endTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> reasonCodes
instance-stuck-in-state: My
instance is stuck in a state.
unresponsive:
My instance is unresponsive.
not-accepting-credentials: My instance is not
accepting my credentials.
password-not-available: A password is not
available for my instance.
performance-network: My instance is experiencing
performance problems which I believe are network related.
performance-instance-store: My instance is
experiencing performance problems which I believe are related to the
instance stores.
performance-ebs-volume: My
instance is experiencing performance problems which I believe are
related to an EBS volume.
performance-other:
My instance is experiencing performance problems.
other: [explain using the description
parameter]
String description
SpotFleetRequestConfigData spotFleetRequestConfig
String spotFleetRequestId
String spotPrice
String clientToken
Integer instanceCount
Default: 1
String type
Default: one-time
Constraints:
Allowed Values: one-time, persistent
Date validFrom
Default: The request is effective indefinitely.
Date validUntil
Default: The request is effective indefinitely.
String launchGroup
Default: Instances are launched and terminated individually
String availabilityZoneGroup
When you specify an Availability Zone group in a Spot Instance request, all Spot instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
If there is no active instance running in the Availability Zone group that you specify for a new Spot instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
Default: Instances are launched in any available Availability Zone.
Integer blockDurationMinutes
The duration period starts as soon as your Spot instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.
Note that you can't specify an Availability Zone group or a launch group if you specify a duration.
LaunchSpecification launchSpecification
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotInstanceRequests
String reservationId
String ownerId
String requesterId
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
Double amount
String currencyCode
limitPrice amount is specified.
At this time, the only supported currency is USD.
Constraints:
Allowed Values: USD
String reservedInstancesId
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge
String availabilityZone
Date start
Date end
Long duration
Float usagePrice
Float fixedPrice
Integer instanceCount
String productDescription
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
String state
Constraints:
Allowed Values: payment-pending, active, payment-failed, retired
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String instanceTenancy
Constraints:
Allowed Values: default, dedicated, host
String currencyCode
USD.
Constraints:
Allowed Values: USD
String offeringType
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String availabilityZone
String platform
Integer instanceCount
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge
String reservedInstancesId
String reservedInstancesListingId
String reservedInstancesId
Date createDate
Date updateDate
String status
Constraints:
Allowed Values: active, pending, cancelled, closed
String statusMessage
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceCounts
com.amazonaws.internal.ListWithAutoConstructFlag<T> priceSchedules
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String clientToken
String reservedInstancesModificationId
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> modificationResults
Date createDate
Date updateDate
Date effectiveDate
String status
String statusMessage
String clientToken
String reservedInstancesId
ReservedInstancesConfiguration targetConfiguration
String reservedInstancesOfferingId
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge
String availabilityZone
Long duration
Float usagePrice
Float fixedPrice
String productDescription
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
String instanceTenancy
Constraints:
Allowed Values: default, dedicated, host
String currencyCode
USD.
Constraints:
Allowed Values: USD
String offeringType
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
Boolean marketplace
true.com.amazonaws.internal.ListWithAutoConstructFlag<T> pricingDetails
String instanceId
String attribute
Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport
String publicIp
String groupId
String sourceSecurityGroupName
String sourceSecurityGroupOwnerId
String ipProtocol
Integer fromPort
Integer toPort
String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
String groupName
String groupId
String sourceSecurityGroupName
String sourceSecurityGroupOwnerId
String ipProtocol
Integer fromPort
-1 to specify all
ICMP types.Integer toPort
-1 to specify all
ICMP codes for the ICMP type.String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
String destinationCidrBlock
String destinationPrefixListId
String gatewayId
String instanceId
String instanceOwnerId
String networkInterfaceId
String vpcPeeringConnectionId
String natGatewayId
String state
blackhole state indicates
that the route's target isn't available (for example, the specified
gateway isn't attached to the VPC, or the specified NAT instance has
been terminated).
Constraints:
Allowed Values: active, blackhole
String origin
CreateRouteTable indicates that route was
automatically created when the route table was created.CreateRoute indicates that the route was manually
added to the route table.EnableVgwRoutePropagation indicates that the route
was propagated by route propagation.
Constraints:
Allowed Values: CreateRouteTable, CreateRoute, EnableVgwRoutePropagation
String routeTableId
String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> routes
com.amazonaws.internal.ListWithAutoConstructFlag<T> associations
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> propagatingVgws
String routeTableAssociationId
String routeTableId
String subnetId
Boolean main
String imageId
Integer minCount
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
Integer maxCount
MinCount. Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
String keyName
If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
Default: Amazon EC2 uses the default security group.
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
Default: Amazon EC2 uses the default security group.
String userData
String instanceType
Default: m1.small
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge
Placement placement
String kernelId
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.
String ramdiskId
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
Boolean monitoring
String subnetId
Boolean disableApiTermination
true, you can't terminate
the instance using the Amazon EC2 console, CLI, or API; otherwise, you
can. If you set this parameter to true and then later
want to be able to terminate the instance, you must first change the
value of the disableApiTermination attribute to
false using ModifyInstanceAttribute.
Alternatively, if you set
InstanceInitiatedShutdownBehavior to
terminate, you can terminate the instance by running the
shutdown command from the instance. Default: false
String instanceInitiatedShutdownBehavior
Default: stop
Constraints:
Allowed Values: stop, terminate
String privateIpAddress
Only one private IP address can be
designated as primary. Therefore, you can't specify this parameter if
PrivateIpAddresses.n.Primary is set to true
and PrivateIpAddresses.n.PrivateIpAddress is set to an IP
address.
Default: We select an IP address from the IP address range of the subnet.
String clientToken
Constraints: Maximum 64 ASCII characters
String additionalInfo
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfileSpecification iamInstanceProfile
Boolean ebsOptimized
Default:
false
Reservation reservation
String clientToken
Integer instanceCount
Default: 1
String scheduledInstanceId
ScheduledInstancesLaunchSpecification launchSpecification
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIdSet
String bucket
String prefix
String aWSAccessKeyId
String uploadPolicy
String uploadPolicySignature
String scheduledInstanceId
String instanceType
String platform
Linux/UNIX or Windows).String networkPlatform
EC2-Classic or
EC2-VPC).String availabilityZone
Integer slotDurationInHours
ScheduledInstanceRecurrence recurrence
Date previousSlotEndTime
Date nextSlotStartTime
String hourlyPrice
Integer totalScheduledInstanceHours
Integer instanceCount
Date termStartDate
Date termEndDate
Date createDate
String instanceType
String platform
Linux/UNIX or Windows).String networkPlatform
EC2-Classic or
EC2-VPC).String availabilityZone
String purchaseToken
Integer slotDurationInHours
ScheduledInstanceRecurrence recurrence
Date firstSlotStartTime
String hourlyPrice
Integer totalScheduledInstanceHours
Integer availableInstanceCount
Integer minTermDurationInDays
Integer maxTermDurationInDays
String frequency
Daily, Weekly, or
Monthly).Integer interval
frequency. For example, every 2 weeks or every 2 months.com.amazonaws.internal.ListWithAutoConstructFlag<T> occurrenceDaySet
Boolean occurrenceRelativeToEnd
String occurrenceUnit
occurrenceDaySet (DayOfWeek or
DayOfMonth).String frequency
Daily, Weekly, or
Monthly).Integer interval
Frequency. For example, every 2 weeks or every 2 months.com.amazonaws.internal.ListWithAutoConstructFlag<T> occurrenceDays
Boolean occurrenceRelativeToEnd
String occurrenceUnit
OccurrenceDays (DayOfWeek or
DayOfMonth). This value is required for a monthly
schedule. You can't specify DayOfWeek with a weekly
schedule. You can't specify this value with a daily schedule.String deviceName
/dev/sdh or xvdh).String noDevice
String virtualName
ephemeralN). Instance store
volumes are numbered starting from 0. An instance type with two
available instance store volumes can specify mappings for
ephemeral0 and ephemeral1.The number of
available instance store volumes depends on the instance type. After
you connect to the instance, you must mount the volume.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
ScheduledInstancesEbs ebs
String snapshotId
Integer volumeSize
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
Boolean deleteOnTermination
String volumeType
gp2 for General Purpose (SSD) volumes,
io1 for Provisioned IOPS (SSD) volumes, and
standard for Magnetic volumes. Default:
standard
Integer iops
Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.
Condition: This parameter is required for requests to create
io1 volumes; it is not used in requests to create
standard or gp2 volumes.
Boolean encrypted
String imageId
String keyName
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
String userData
ScheduledInstancesPlacement placement
String kernelId
String instanceType
String ramdiskId
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
ScheduledInstancesMonitoring monitoring
String subnetId
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
ScheduledInstancesIamInstanceProfile iamInstanceProfile
Boolean ebsOptimized
Default:
false
Boolean enabled
String networkInterfaceId
Integer deviceIndex
String subnetId
String description
String privateIpAddress
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddressConfigs
Integer secondaryPrivateIpAddressCount
Boolean associatePublicIpAddress
true.com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
Boolean deleteOnTermination
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
Date earliestTime
Date latestTime
String snapshotId
String volumeId
String state
Constraints:
Allowed Values: pending, completed, error
String stateMessage
Date startTime
String progress
String ownerId
String description
Integer volumeSize
String ownerAlias
amazon,
self) or AWS account ID that owns the snapshot.com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Boolean encrypted
String kmsKeyId
String dataEncryptionKeyId
Double diskImageSize
String description
String format
String url
UserBucketDetails userBucket
String deviceName
String snapshotId
String progress
String statusMessage
String status
String description
String format
Valid values:
RAW | VHD | VMDK |
OVA
String url
UserBucket userBucket
Double diskImageSize
String description
String format
String url
UserBucketDetails userBucket
String snapshotId
String progress
String statusMessage
String status
String ownerId
String bucket
String prefix
String state
Constraints:
Allowed Values: Active, Inactive
SpotInstanceStateFault fault
String imageId
String keyName
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
String userData
String addressingType
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge
SpotPlacement placement
String kernelId
String ramdiskId
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
SpotFleetMonitoring monitoring
String subnetId
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfileSpecification iamInstanceProfile
Boolean ebsOptimized
Default:
false
Double weightedCapacity
If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1.
String spotPrice
WeightedCapacity.Boolean enabled
Default: false
String spotFleetRequestId
String spotFleetRequestState
Constraints:
Allowed Values: submitted, active, cancelled, failed, cancelled_running, cancelled_terminating, modifying
SpotFleetRequestConfigData spotFleetRequestConfig
Date createTime
String clientToken
String spotPrice
Integer targetCapacity
Date validFrom
Date validUntil
Boolean terminateInstancesWithExpiration
String iamFleetRole
terminateInstancesWithExpiration.com.amazonaws.internal.ListWithAutoConstructFlag<T> launchSpecifications
Constraints:
Length: 1 -
String excessCapacityTerminationPolicy
Constraints:
Allowed Values: noTermination, default
String allocationStrategy
lowestPrice.
Constraints:
Allowed Values: lowestPrice, diversified
String spotInstanceRequestId
String spotPrice
String type
Constraints:
Allowed Values: one-time, persistent
String state
Constraints:
Allowed Values: open, active, closed, cancelled, failed
SpotInstanceStateFault fault
SpotInstanceStatus status
Date validFrom
Date validUntil
String launchGroup
String availabilityZoneGroup
LaunchSpecification launchSpecification
String instanceId
Date createTime
String productDescription
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
Integer blockDurationMinutes
String actualBlockHourlyPrice
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String launchedAvailabilityZone
String code
Date updateTime
String message
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge
String productDescription
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
String spotPrice
Date timestamp
String availabilityZone
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
String additionalInfo
com.amazonaws.internal.ListWithAutoConstructFlag<T> startingInstances
String code
String message
Server.SpotInstanceTermination: A Spot instance
was terminated due to an increase in the market price.
Server.InternalError: An internal error occurred
during instance launch, resulting in termination.
Server.InsufficientInstanceCapacity: There was
insufficient instance capacity to satisfy the launch request.
Client.InternalError: A client error caused the
instance to terminate on launch.
Client.InstanceInitiatedShutdown: The instance was
shut down using the shutdown -h command from the
instance.
Client.UserInitiatedShutdown: The
instance was shut down using the Amazon EC2 API.
Client.VolumeLimitExceeded: The limit on the
number of EBS volumes or total storage was exceeded. Decrease usage or
request an increase in your limits.
Client.InvalidSnapshot.NotFound: The specified
snapshot was not found.
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
Boolean force
Default:
false
com.amazonaws.internal.ListWithAutoConstructFlag<T> stoppingInstances
S3Storage s3
String subnetId
String state
Constraints:
Allowed Values: pending, available
String vpcId
String cidrBlock
Integer availableIpAddressCount
String availabilityZone
Boolean defaultForAz
Boolean mapPublicIpOnLaunch
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String resourceId
ami-1a2b3c4d.String resourceType
Constraints:
Allowed Values: customer-gateway, dhcp-options, image, instance, internet-gateway, network-acl, network-interface, reserved-instances, route-table, snapshot, spot-instances-request, subnet, security-group, volume, vpc, vpn-connection, vpn-gateway
String key
String value
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> terminatingInstances
String networkInterfaceId
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceMonitorings
String resourceId
UnsuccessfulItemError error
String data
String userId
String groupName
GroupId.String groupId
String outsideIpAddress
String status
Constraints:
Allowed Values: UP, DOWN
Date lastStatusChange
String statusMessage
Integer acceptedRouteCount
String volumeId
Integer size
String snapshotId
String availabilityZone
String state
Constraints:
Allowed Values: creating, available, in-use, deleting, deleted, error
Date createTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> attachments
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String volumeType
gp2 for General Purpose
(SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or
standard for Magnetic volumes.
Constraints:
Allowed Values: standard, io1, gp2
Integer iops
Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.
Condition: This parameter is required for requests to create
io1 volumes; it is not used in requests to create
standard or gp2 volumes.
Boolean encrypted
String kmsKeyId
String volumeId
String instanceId
String device
String state
Constraints:
Allowed Values: attaching, attached, detaching, detached
Date attachTime
Boolean deleteOnTermination
Long size
String status
Constraints:
Allowed Values: ok, impaired, insufficient-data
com.amazonaws.internal.ListWithAutoConstructFlag<T> details
String volumeId
String availabilityZone
VolumeStatusInfo volumeStatus
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
com.amazonaws.internal.ListWithAutoConstructFlag<T> actions
String vpcId
String state
Constraints:
Allowed Values: pending, available
String cidrBlock
String dhcpOptionsId
default if the default options are associated with the
VPC).com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String instanceTenancy
Constraints:
Allowed Values: default, dedicated, host
Boolean isDefault
String vpcId
Boolean classicLinkEnabled
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String vpcEndpointId
String vpcId
String serviceName
String state
Constraints:
Allowed Values: Pending, Available, Deleting, Deleted
String policyDocument
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeTableIds
Date creationTimestamp
VpcPeeringConnectionVpcInfo accepterVpcInfo
Date expirationTime
VpcPeeringConnectionVpcInfo requesterVpcInfo
VpcPeeringConnectionStateReason status
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String vpcPeeringConnectionId
String vpnConnectionId
String state
Constraints:
Allowed Values: pending, available, deleting, deleted
String customerGatewayConfiguration
pending or available state.String type
Constraints:
Allowed Values: ipsec.1
String customerGatewayId
String vpnGatewayId
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> vgwTelemetry
VpnConnectionOptions options
com.amazonaws.internal.ListWithAutoConstructFlag<T> routes
Boolean staticRoutesOnly
Boolean staticRoutesOnly
String vpnGatewayId
String state
Constraints:
Allowed Values: pending, available, deleting, deleted
String type
Constraints:
Allowed Values: ipsec.1
String availabilityZone
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcAttachments
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String destinationCidrBlock
String source
Constraints:
Allowed Values: Static
String state
Constraints:
Allowed Values: pending, available, deleting, deleted
String authorizationToken
A base64-encoded string that contains authorization data for the
specified Amazon ECR registry. When the string is decoded, it is
presented in the format user:password for private registry
authentication using docker login.
Date expiresAt
The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours.
String proxyEndpoint
The registry URL to use for this authorization token in a
docker login command. The Amazon ECR registry URL format is
https://aws_account_id.dkr.ecr.region.amazonaws.com. For
example,
https://012345678910.dkr.ecr.us-east-1.amazonaws.com.
String registryId
The AWS account ID associated with the registry that contains the image layers to check. If you do not specify a registry, the default registry is assumed.
String repositoryName
The name of the repository that is associated with the image layers to check.
List<E> layerDigests
The digests of the image layers to check.
String registryId
The AWS account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default registry is assumed.
String repositoryName
The repository that contains the image to delete.
List<E> imageIds
A list of image ID references that correspond to images to delete. The
format of the imageIds reference is
imageTag=tag or imageDigest=digest.
String registryId
The AWS account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed.
String repositoryName
The repository that contains the images to describe.
List<E> imageIds
A list of image ID references that correspond to images to describe. The
format of the imageIds reference is
imageTag=tag or imageDigest=digest.
String registryId
The AWS account ID associated with the registry to which to upload layers. If you do not specify a registry, the default registry is assumed.
String repositoryName
The name of the repository to associate with the image layer.
String uploadId
The upload ID from a previous InitiateLayerUpload operation to associate with the image layer.
List<E> layerDigests
The sha256 digest of the image layer.
String repositoryName
The name to use for the repository. The repository name may be specified
on its own (such as nginx-web-app) or it can be prepended
with a namespace to group the repository into a category (such as
project-a/nginx-web-app).
Repository repository
String registryId
The AWS account ID associated with the registry that contains the repository policy to delete. If you do not specify a registry, the default registry is assumed.
String repositoryName
The name of the repository that is associated with the repository policy to delete.
String registryId
The AWS account ID associated with the registry that contains the repository to delete. If you do not specify a registry, the default registry is assumed.
String repositoryName
The name of the repository to delete.
Boolean force
Force the deletion of the repository if it contains images.
Repository repository
String registryId
The AWS account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed.
List<E> repositoryNames
A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.
String nextToken
The nextToken value returned from a previous paginated
DescribeRepositories request where maxResults
was used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the
nextToken value. This value is null when there
are no more results to return.
Integer maxResults
The maximum number of repository results returned by
DescribeRepositories in paginated output. When this
parameter is used, DescribeRepositories only returns
maxResults results in a single page along with a
nextToken response element. The remaining results of the
initial request can be seen by sending another
DescribeRepositories request with the returned
nextToken value. This value can be between 1 and 100. If
this parameter is not used, then DescribeRepositories
returns up to 100 results and a nextToken value, if
applicable.
List<E> repositories
A list of repository objects corresponding to valid repositories.
String nextToken
The nextToken value to include in a future
DescribeRepositories request. When the results of a
DescribeRepositories request exceed maxResults,
this value can be used to retrieve the next page of results. This value
is null when there are no more results to return.
String registryId
The AWS account ID associated with the registry that contains the image layer to download. If you do not specify a registry, the default registry is assumed.
String repositoryName
The name of the repository that is associated with the image layer to download.
String layerDigest
The digest of the image layer to download.
String registryId
The AWS account ID associated with the registry containing the image.
String repositoryName
The name of the repository associated with the image.
ImageIdentifier imageId
An object containing the image tag and image digest associated with an image.
String imageManifest
The image manifest associated with the image.
ImageIdentifier imageId
The image ID associated with the failure.
String failureCode
The code associated with the failure.
String failureReason
The reason for the failure.
String uploadId
The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload operations.
Long partSize
The size, in bytes, that Amazon ECR expects future layer part uploads to be.
String registryId
The registry ID associated with the exception.
String repositoryName
The repository name associated with the exception.
String uploadId
The upload ID associated with the exception.
Long lastValidByteReceived
The last valid byte received from the layer part upload that is associated with the exception.
String registryId
The AWS account ID associated with the registry that contains the repository to list images in. If you do not specify a registry, the default registry is assumed.
String repositoryName
The repository whose image IDs are to be listed.
String nextToken
The nextToken value returned from a previous paginated
ListImages request where maxResults was used
and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the
nextToken value. This value is null when there
are no more results to return.
Integer maxResults
The maximum number of image results returned by ListImages
in paginated output. When this parameter is used, ListImages
only returns maxResults results in a single page along with
a nextToken response element. The remaining results of the
initial request can be seen by sending another ListImages
request with the returned nextToken value. This value can be
between 1 and 100. If this parameter is not used, then
ListImages returns up to 100 results and a
nextToken value, if applicable.
List<E> imageIds
The list of image IDs for the requested repository.
String nextToken
The nextToken value to include in a future
ListImages request. When the results of a
ListImages request exceed maxResults, this
value can be used to retrieve the next page of results. This value is
null when there are no more results to return.
String registryId
The AWS account ID associated with the registry that contains the repository in which to put the image. If you do not specify a registry, the default registry is assumed.
String repositoryName
The name of the repository in which to put the image.
String imageManifest
The image manifest corresponding to the image to be uploaded.
Image image
Details of the image uploaded.
String repositoryArn
The Amazon Resource Name (ARN) that identifies the repository. The ARN
contains the arn:aws:ecr namespace, followed by the region
of the repository, the AWS account ID of the repository owner, the
repository namespace, and then the repository name. For example,
arn:aws:ecr:region:012345678910:repository/test.
String registryId
The AWS account ID associated with the registry that contains the repository.
String repositoryName
The name of the repository.
String registryId
The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
String repositoryName
The name of the repository to receive the policy.
String policyText
The JSON repository policy text to apply to the repository.
Boolean force
If the policy you are attempting to set on a repository policy would prevent you from setting another policy in the future, you must force the SetRepositoryPolicy operation. This is intended to prevent accidental repository lock outs.
String registryId
The AWS account ID associated with the registry that you are uploading layer parts to. If you do not specify a registry, the default registry is assumed.
String repositoryName
The name of the repository that you are uploading layer parts to.
String uploadId
The upload ID from a previous InitiateLayerUpload operation to associate with the layer part upload.
Long partFirstByte
The integer value of the first byte of the layer part.
Long partLastByte
The integer value of the last byte of the layer part.
ByteBuffer layerPartBlob
The base64-encoded layer part payload.
String registryId
The registry ID associated with the request.
String repositoryName
The repository name associated with the request.
String uploadId
The upload ID associated with the request.
Long lastByteReceived
The integer value of the last byte received in the request.
String clusterArn
The Amazon Resource Name (ARN) that identifies the cluster. The ARN
contains the arn:aws:ecs namespace, followed by the region
of the cluster, the AWS account ID of the cluster owner, the
cluster namespace, and then the cluster name. For example,
arn:aws:ecs:region:012345678910:cluster/test.
String clusterName
A user-generated string that you use to identify your cluster.
String status
The status of the cluster. The valid values are ACTIVE or
INACTIVE. ACTIVE indicates that you can
register container instances with the cluster and the associated
instances can accept tasks.
Integer registeredContainerInstancesCount
The number of container instances registered into the cluster.
Integer runningTasksCount
The number of tasks in the cluster that are in the RUNNING
state.
Integer pendingTasksCount
The number of tasks in the cluster that are in the PENDING
state.
Integer activeServicesCount
The number of services that are running on the cluster in an
ACTIVE state. You can view these services with
ListServices.
String containerArn
The Amazon Resource Name (ARN) of the container.
String taskArn
The Amazon Resource Name (ARN) of the task.
String name
The name of the container.
String lastStatus
The last known status of the container.
Integer exitCode
The exit code returned from the container.
String reason
A short (255 max characters) human-readable string to provide additional detail about a running or stopped container.
com.amazonaws.internal.SdkInternalList<T> networkBindings
The network bindings associated with the container.
String name
The name of a container. If you are linking multiple containers together
in a task definition, the name of one container can be
entered in the links of another container to connect the
containers. Up to 255 letters (uppercase and lowercase), numbers,
hyphens, and underscores are allowed. This parameter maps to
name in the Create a container section of the Docker Remote API and the --name option to docker run.
String image
The image used to start a container. This string is passed directly to
the Docker daemon. Images in the Docker Hub registry are available by
default. Other repositories are specified with
repository-url/image:tag. Up to 255
letters (uppercase and lowercase), numbers, hyphens, underscores, colons,
periods, forward slashes, and number signs are allowed. This parameter
maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
ubuntu or mongo).amazon/amazon-ecs-agent).quay.io/assemblyline/ubuntu).Integer cpu
The number of cpu units reserved for the container. A
container instance has 1,024 cpu units for every CPU core.
This parameter specifies the minimum amount of CPU to reserve for a
container, and containers share unallocated CPU units with other
containers on the instance with the same ratio as their allocated amount.
This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
Integer memory
The number of MiB of memory to reserve for the container. You must
specify a non-zero integer for this parameter; the Docker daemon reserves
a minimum of 4 MiB of memory for a container, so you should not specify
fewer than 4 MiB of memory for your containers. If your container
attempts to exceed the memory allocated here, the container is killed.
This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
com.amazonaws.internal.SdkInternalList<T> links
The link parameter allows containers to communicate with
each other without the need for port mappings, using the
name parameter and optionally, an alias for the
link. This construct is analogous to name:alias in Docker
links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and
underscores are allowed for each name and alias
. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This parameter maps
to Links in the Create a container section of the Docker Remote API and the --link option to
docker run.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
com.amazonaws.internal.SdkInternalList<T> portMappings
The list of port mappings for the container. Port mappings allow
containers to access ports on the host container instance to send or
receive traffic. This parameter maps to PortBindings in the
Create a container section of the Docker Remote API and the --publish option to docker run.
After a task reaches the RUNNING status, manual and
automatic host and container port assignments are visible in the
Network Bindings section of a container description of a selected
task in the Amazon ECS console, or the networkBindings
section DescribeTasks responses.
Boolean essential
If the essential parameter of a container is marked as
true, the failure of that container stops the task. If the
essential parameter of a container is marked as
false, then its failure does not affect the rest of the
containers in a task. If this parameter is omitted, a container is
assumed to be essential.
All tasks must have at least one essential container.
com.amazonaws.internal.SdkInternalList<T> entryPoint
Early versions of the Amazon ECS container agent do not properly handle
entryPoint parameters. If you have problems using
entryPoint, update your container agent or enter your
commands and arguments as command array items instead.
The entry point that is passed to the container. This parameter maps to
Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run.
For more information, see https://docs.docker.com/reference/builder/#entrypoint.
com.amazonaws.internal.SdkInternalList<T> command
The command that is passed to the container. This parameter maps to
Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run.
For more information, see https://docs.docker.com/reference/builder/#cmd.
com.amazonaws.internal.SdkInternalList<T> environment
The environment variables to pass to a container. This parameter maps to
Env in the Create a container section of the Docker Remote API and the --env option to docker run.
We do not recommend using plain text environment variables for sensitive information, such as credential data.
com.amazonaws.internal.SdkInternalList<T> mountPoints
The mount points for data volumes in your container. This parameter maps
to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
com.amazonaws.internal.SdkInternalList<T> volumesFrom
Data volumes to mount from another container. This parameter maps to
VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run.
String hostname
The hostname to use for your container. This parameter maps to
Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.
String user
The user name to use inside the container. This parameter maps to
User in the Create a container section of the Docker Remote API and the --user option to docker run.
String workingDirectory
The working directory in which to run commands inside the container. This
parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.
Boolean disableNetworking
When this parameter is true, networking is disabled within the container.
This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.
Boolean privileged
When this parameter is true, the container is given elevated privileges
on the host container instance (similar to the root user).
This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.
Boolean readonlyRootFilesystem
When this parameter is true, the container is given read-only access to
its root file system. This parameter maps to ReadonlyRootfs
in the Create a container section of the Docker Remote API and the --read-only option to
docker run.
com.amazonaws.internal.SdkInternalList<T> dnsServers
A list of DNS servers that are presented to the container. This parameter
maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run.
com.amazonaws.internal.SdkInternalList<T> dnsSearchDomains
A list of DNS search domains that are presented to the container. This
parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run.
com.amazonaws.internal.SdkInternalList<T> extraHosts
A list of hostnames and IP address mappings to append to the
/etc/hosts file on the container. This parameter maps to
ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.
com.amazonaws.internal.SdkInternalList<T> dockerSecurityOptions
A list of strings to provide custom labels for SELinux and AppArmor
multi-level security systems. This parameter maps to
SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run.
The Amazon ECS container agent running on a container instance must
register with the ECS_SELINUX_CAPABLE=true or
ECS_APPARMOR_CAPABLE=true environment variables before
containers placed on that instance can use these security options. For
more information, see Amazon ECS Container Agent Configuration in the Amazon EC2
Container Service Developer Guide.
Map<K,V> dockerLabels
A key/value map of labels to add to the container. This parameter maps to
Labels in the Create a container section of the Docker Remote API and the --label option to docker run.
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log into your container instance and run the
following command:
sudo docker version | grep "Server API version"
com.amazonaws.internal.SdkInternalList<T> ulimits
A list of ulimits to set in the container. This parameter
maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
Valid naming values are displayed in the Ulimit data type. This
parameter requires version 1.18 of the Docker Remote API or greater on
your container instance. To check the Docker Remote API version on your
container instance, log into your container instance and run the
following command:
sudo docker version | grep "Server API version"
LogConfiguration logConfiguration
The log configuration specification for the container. This parameter
maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run.
Valid log drivers are displayed in the LogConfiguration data type.
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log into your container instance and run the
following command:
sudo docker version | grep "Server API version"
The Amazon ECS container agent running on a container instance must
register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS environment variable before
containers placed on that instance can use these log configuration
options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2
Container Service Developer Guide.
String containerInstanceArn
The Amazon Resource Name (ARN) of the container instance. The ARN
contains the arn:aws:ecs namespace, followed by the region
of the container instance, the AWS account ID of the container instance
owner, the container-instance namespace, and then the
container instance ID. For example,
arn:aws:ecs:region:aws_account_id
:container-instance/container_instance_ID.
String ec2InstanceId
The EC2 instance ID of the container instance.
VersionInfo versionInfo
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
com.amazonaws.internal.SdkInternalList<T> remainingResources
The remaining resources of the container instance that are available for new tasks.
com.amazonaws.internal.SdkInternalList<T> registeredResources
The registered resources on the container instance that are in use by current tasks.
String status
The status of the container instance. The valid values are
ACTIVE or INACTIVE. ACTIVE
indicates that the container instance can accept tasks.
Boolean agentConnected
This parameter returns true if the agent is actually
connected to Amazon ECS. Registered instances with an agent that may be
unhealthy or stopped return false, and instances without a
connected agent cannot accept placement requests.
Integer runningTasksCount
The number of tasks on the container instance that are in the
RUNNING status.
Integer pendingTasksCount
The number of tasks on the container instance that are in the
PENDING status.
String agentUpdateStatus
The status of the most recent agent update. If an update has never been
requested, this value is NULL.
com.amazonaws.internal.SdkInternalList<T> attributes
The attributes set for the container instance by the Amazon ECS container agent at instance registration.
String name
The name of the container that receives the override.
com.amazonaws.internal.SdkInternalList<T> command
The command to send to the container that overrides the default command from the Docker image or the task definition.
com.amazonaws.internal.SdkInternalList<T> environment
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.
String clusterName
The name of your cluster. If you do not specify a name for your cluster,
you create a cluster named default. Up to 255 letters
(uppercase and lowercase), numbers, hyphens, and underscores are allowed.
Cluster cluster
The full description of your new cluster.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.
String serviceName
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.
String taskDefinition
The family and revision (
family:revision) or full Amazon Resource Name (ARN) of the
task definition to run in your service. If a revision is not
specified, the latest ACTIVE revision is used.
com.amazonaws.internal.SdkInternalList<T> loadBalancers
A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
Integer desiredCount
The number of instantiations of the specified task definition to place and keep running on your cluster.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
String role
The name or full Amazon Resource Name (ARN) of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf. This parameter is only required if you are using a load balancer with your service.
DeploymentConfiguration deploymentConfiguration
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
Service service
The full description of your service following the create call.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster to delete.
Cluster cluster
The full description of the deleted cluster.
Service service
The full description of the deleted service.
String id
The ID of the deployment.
String status
The status of the deployment. Valid values are PRIMARY (for
the most recent deployment), ACTIVE (for previous
deployments that still have tasks running, but are being replaced with
the PRIMARY deployment), and INACTIVE (for
deployments that have been completely replaced).
String taskDefinition
The most recent task definition that was specified for the service to use.
Integer desiredCount
The most recent desired count of tasks that was specified for the service to deploy or maintain.
Integer pendingCount
The number of tasks in the deployment that are in the
PENDING status.
Integer runningCount
The number of tasks in the deployment that are in the
RUNNING status.
Date createdAt
The Unix time in seconds and milliseconds when the service was created.
Date updatedAt
The Unix time in seconds and milliseconds when the service was last updated.
Integer maximumPercent
The upper limit (as a percentage of the service's
desiredCount) of the number of running tasks that can be
running in a service during a deployment. The maximum number of tasks
during a deployment is the desiredCount multiplied by the
maximumPercent/100, rounded down to the nearest integer
value.
Integer minimumHealthyPercent
The lower limit (as a percentage of the service's
desiredCount) of the number of running tasks that must
remain running and healthy in a service during a deployment. The minimum
healthy tasks during a deployment is the desiredCount
multiplied by the minimumHealthyPercent/100, rounded up to
the nearest integer value.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.
String containerInstance
The container instance ID or full Amazon Resource Name (ARN) of the
container instance to deregister. The ARN contains the
arn:aws:ecs namespace, followed by the region of the
container instance, the AWS account ID of the container instance owner,
the container-instance namespace, and then the container
instance ID. For example,
arn:aws:ecs:region:aws_account_id:
container-instance/container_instance_ID.
Boolean force
Forces the deregistration of the container instance. If you have tasks
running on the container instance when you deregister it with the
force option, these tasks remain running and they continue
to pass Elastic Load Balancing load balancer health checks until you
terminate the instance or the tasks stop through some other means, but
they are orphaned (no longer monitored or accounted for by Amazon ECS).
If an orphaned task on your container instance is part of an Amazon ECS
service, then the service scheduler starts another copy of that task, on
a different container instance if possible.
ContainerInstance containerInstance
String taskDefinition
The family and revision (
family:revision) or full Amazon Resource Name (ARN) of the
task definition to deregister. You must specify a revision.
TaskDefinition taskDefinition
The full description of the deregistered task.
com.amazonaws.internal.SdkInternalList<T> clusters
A space-separated list of cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.
com.amazonaws.internal.SdkInternalList<T> clusters
The list of clusters.
com.amazonaws.internal.SdkInternalList<T> failures
Any failures associated with the call.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed.
com.amazonaws.internal.SdkInternalList<T> containerInstances
A space-separated list of container instance IDs or full Amazon Resource Name (ARN) entries.
com.amazonaws.internal.SdkInternalList<T> containerInstances
The list of container instances.
com.amazonaws.internal.SdkInternalList<T> failures
Any failures associated with the call.
String cluster
The name of the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed.
com.amazonaws.internal.SdkInternalList<T> services
A list of services to describe.
com.amazonaws.internal.SdkInternalList<T> services
The list of services described.
com.amazonaws.internal.SdkInternalList<T> failures
Any failures associated with the call.
String taskDefinition
The family for the latest ACTIVE revision,
family and revision (
family:revision) for a specific revision in the family, or
full Amazon Resource Name (ARN) of the task definition to describe.
TaskDefinition taskDefinition
The full task definition description.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to describe. If you do not specify a cluster, the default cluster is assumed.
com.amazonaws.internal.SdkInternalList<T> tasks
A space-separated list of task IDs or full Amazon Resource Name (ARN) entries.
com.amazonaws.internal.SdkInternalList<T> tasks
The list of tasks.
com.amazonaws.internal.SdkInternalList<T> failures
Any failures associated with the call.
String containerInstance
The container instance ID or full Amazon Resource Name (ARN) of the
container instance. The ARN contains the arn:aws:ecs
namespace, followed by the region of the container instance, the AWS
account ID of the container instance owner, the
container-instance namespace, and then the container
instance ID. For example,
arn:aws:ecs:region:aws_account_id:
container-instance/container_instance_ID.
String cluster
The cluster that the container instance belongs to.
String sourcePath
The path on the host container instance that is presented to the
container. If this parameter is empty, then the Docker daemon has
assigned a host path for you. If the host parameter contains
a sourcePath file location, then the data volume persists at
the specified location on the host container instance until you delete it
manually. If the sourcePath value does not exist on the host
container instance, the Docker daemon creates it. If the location does
exist, the contents of the source path folder are exported.
String nextToken
The nextToken value returned from a previous paginated
ListClusters request where maxResults was used
and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the
nextToken value. This value is null when there
are no more results to return.
Integer maxResults
The maximum number of cluster results returned by
ListClusters in paginated output. When this parameter is
used, ListClusters only returns maxResults
results in a single page along with a nextToken response
element. The remaining results of the initial request can be seen by
sending another ListClusters request with the returned
nextToken value. This value can be between 1 and 100. If
this parameter is not used, then ListClusters returns up to
100 results and a nextToken value if applicable.
com.amazonaws.internal.SdkInternalList<T> clusterArns
The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.
String nextToken
The nextToken value to include in a future
ListClusters request. When the results of a
ListClusters request exceed maxResults, this
value can be used to retrieve the next page of results. This value is
null when there are no more results to return.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed..
String nextToken
The nextToken value returned from a previous paginated
ListContainerInstances request where maxResults
was used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the
nextToken value. This value is null when there
are no more results to return.
Integer maxResults
The maximum number of container instance results returned by
ListContainerInstances in paginated output. When this
parameter is used, ListContainerInstances only returns
maxResults results in a single page along with a
nextToken response element. The remaining results of the
initial request can be seen by sending another
ListContainerInstances request with the returned
nextToken value. This value can be between 1 and 100. If
this parameter is not used, then ListContainerInstances
returns up to 100 results and a nextToken value if
applicable.
com.amazonaws.internal.SdkInternalList<T> containerInstanceArns
The list of container instances with full Amazon Resource Name (ARN) entries for each container instance associated with the specified cluster.
String nextToken
The nextToken value to include in a future
ListContainerInstances request. When the results of a
ListContainerInstances request exceed
maxResults, this value can be used to retrieve the next page
of results. This value is null when there are no more
results to return.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list. If you do not specify a cluster, the default cluster is assumed..
String nextToken
The nextToken value returned from a previous paginated
ListServices request where maxResults was used
and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the
nextToken value. This value is null when there
are no more results to return.
Integer maxResults
The maximum number of container instance results returned by
ListServices in paginated output. When this parameter is
used, ListServices only returns maxResults
results in a single page along with a nextToken response
element. The remaining results of the initial request can be seen by
sending another ListServices request with the returned
nextToken value. This value can be between 1 and 10. If this
parameter is not used, then ListServices returns up to 10
results and a nextToken value if applicable.
com.amazonaws.internal.SdkInternalList<T> serviceArns
The list of full Amazon Resource Name (ARN) entries for each service associated with the specified cluster.
String nextToken
The nextToken value to include in a future
ListServices request. When the results of a
ListServices request exceed maxResults, this
value can be used to retrieve the next page of results. This value is
null when there are no more results to return.
String familyPrefix
The familyPrefix is a string that is used to filter the
results of ListTaskDefinitionFamilies. If you specify a
familyPrefix, only task definition family names that begin
with the familyPrefix string are returned.
String nextToken
The nextToken value returned from a previous paginated
ListTaskDefinitionFamilies request where
maxResults was used and the results exceeded the value of
that parameter. Pagination continues from the end of the previous results
that returned the nextToken value. This value is
null when there are no more results to return.
Integer maxResults
The maximum number of task definition family results returned by
ListTaskDefinitionFamilies in paginated output. When this
parameter is used, ListTaskDefinitions only returns
maxResults results in a single page along with a
nextToken response element. The remaining results of the
initial request can be seen by sending another
ListTaskDefinitionFamilies request with the returned
nextToken value. This value can be between 1 and 100. If
this parameter is not used, then ListTaskDefinitionFamilies
returns up to 100 results and a nextToken value if
applicable.
com.amazonaws.internal.SdkInternalList<T> families
The list of task definition family names that match the
ListTaskDefinitionFamilies request.
String nextToken
The nextToken value to include in a future
ListTaskDefinitionFamilies request. When the results of a
ListTaskDefinitionFamilies request exceed
maxResults, this value can be used to retrieve the next page
of results. This value is null when there are no more
results to return.
String familyPrefix
The full family name with which to filter the
ListTaskDefinitions results. Specifying a
familyPrefix limits the listed task definitions to task
definition revisions that belong to that family.
String status
The task definition status with which to filter the
ListTaskDefinitions results. By default, only
ACTIVE task definitions are listed. By setting this
parameter to INACTIVE, you can view task definitions that
are INACTIVE as long as an active task or service still
references them. If you paginate the resulting output, be sure to keep
the status value constant in each subsequent request.
String sort
The order in which to sort the results. Valid values are ASC
and DESC. By default (ASC), task definitions
are listed lexicographically by family name and in ascending numerical
order by revision so that the newest task definitions in a family are
listed last. Setting this parameter to DESC reverses the
sort order on family name and revision so that the newest task
definitions in a family are listed first.
String nextToken
The nextToken value returned from a previous paginated
ListTaskDefinitions request where maxResults
was used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the
nextToken value. This value is null when there
are no more results to return.
Integer maxResults
The maximum number of task definition results returned by
ListTaskDefinitions in paginated output. When this parameter
is used, ListTaskDefinitions only returns
maxResults results in a single page along with a
nextToken response element. The remaining results of the
initial request can be seen by sending another
ListTaskDefinitions request with the returned
nextToken value. This value can be between 1 and 100. If
this parameter is not used, then ListTaskDefinitions returns
up to 100 results and a nextToken value if applicable.
com.amazonaws.internal.SdkInternalList<T> taskDefinitionArns
The list of task definition Amazon Resource Name (ARN) entries for the
ListTaskDefinitions request.
String nextToken
The nextToken value to include in a future
ListTaskDefinitions request. When the results of a
ListTaskDefinitions request exceed maxResults,
this value can be used to retrieve the next page of results. This value
is null when there are no more results to return.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not specify a cluster, the default cluster is assumed..
String containerInstance
The container instance ID or full Amazon Resource Name (ARN) of the
container instance with which to filter the ListTasks
results. Specifying a containerInstance limits the results
to tasks that belong to that container instance.
String family
The name of the family with which to filter the ListTasks
results. Specifying a family limits the results to tasks
that belong to that family.
String nextToken
The nextToken value returned from a previous paginated
ListTasks request where maxResults was used and
the results exceeded the value of that parameter. Pagination continues
from the end of the previous results that returned the
nextToken value. This value is null when there
are no more results to return.
Integer maxResults
The maximum number of task results returned by ListTasks in
paginated output. When this parameter is used, ListTasks
only returns maxResults results in a single page along with
a nextToken response element. The remaining results of the
initial request can be seen by sending another ListTasks
request with the returned nextToken value. This value can be
between 1 and 100. If this parameter is not used, then
ListTasks returns up to 100 results and a
nextToken value if applicable.
String startedBy
The startedBy value with which to filter the task results.
Specifying a startedBy value limits the results to tasks
that were started with that value.
String serviceName
The name of the service with which to filter the ListTasks
results. Specifying a serviceName limits the results to
tasks that belong to that service.
String desiredStatus
The task status with which to filter the ListTasks results.
Specifying a desiredStatus of STOPPED limits
the results to tasks that are in the STOPPED status, which
can be useful for debugging tasks that are not starting properly or have
died or finished. The default status filter is RUNNING.
com.amazonaws.internal.SdkInternalList<T> taskArns
The list of task Amazon Resource Name (ARN) entries for the
ListTasks request.
String nextToken
The nextToken value to include in a future
ListTasks request. When the results of a
ListTasks request exceed maxResults, this value
can be used to retrieve the next page of results. This value is
null when there are no more results to return.
String loadBalancerName
The name of the load balancer.
String containerName
The name of the container (as it appears in a container definition) to associate with the load balancer.
Integer containerPort
The port on the container to associate with the load balancer. This port
must correspond to a containerPort in the service's task
definition. Your container instances must allow ingress traffic on the
hostPort of the port mapping.
String logDriver
The log driver to use for the container. This parameter requires version
1.18 of the Docker Remote API or greater on your container instance. To
check the Docker Remote API version on your container instance, log into
your container instance and run the following command:
sudo docker version | grep "Server API version"
Map<K,V> options
The configuration options to send to the log driver. This parameter
requires version 1.19 of the Docker Remote API or greater on your
container instance. To check the Docker Remote API version on your
container instance, log into your container instance and run the
following command:
sudo docker version | grep "Server API version"
String sourceVolume
The name of the volume to mount.
String containerPath
The path on the container to mount the host volume at.
Boolean readOnly
If this value is true, the container has read-only access to
the volume. If this value is false, then the container can
write to the volume. The default value is false.
String bindIP
The IP address that the container is bound to on the container instance.
Integer containerPort
The port number on the container that is be used with the network binding.
Integer hostPort
The port number on the host that is used with the network binding.
String protocol
The protocol used for the network binding.
Integer containerPort
The port number on the container that is bound to the user-specified or
automatically assigned host port. If you specify a container port and not
a host port, your container automatically receives a host port in the
ephemeral port range (for more information, see hostPort).
Integer hostPort
The port number on the container instance to reserve for your container.
You can specify a non-reserved host port for your container port mapping,
or you can omit the hostPort (or set it to 0)
while specifying a containerPort and your container
automatically receives a port in the ephemeral port range for your
container instance operating system and Docker version.
The default ephemeral port range is 49153 to 65535, and this range is
used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and
later, the Docker daemon tries to read the ephemeral port range from
/proc/sys/net/ipv4/ip_local_port_range; if this kernel
parameter is unavailable, the default ephemeral port range is used. You
should not attempt to specify a host port in the ephemeral port range,
because these are reserved for automatic assignment. In general, ports
below 32768 are outside of the ephemeral port range.
The default reserved ports are 22 for SSH, the Docker ports 2375 and
2376, and the Amazon ECS container agent port 51678. Any host port that
was previously specified in a running task is also reserved while the
task is running (after a task stops, the host port is released).The
current reserved ports are displayed in the
remainingResources of DescribeContainerInstances
output, and a container instance may have up to 50 reserved ports at a
time, including the default reserved ports (automatically assigned ports
do not count toward this limit).
String protocol
The protocol used for the port mapping. Valid values are tcp
and udp. The default is tcp.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container instance. If you do not specify a cluster, the default cluster is assumed..
String instanceIdentityDocument
The instance identity document for the EC2 instance to register. This
document can be found by running the following command from the instance:
curl http://169.254.169.254/latest/dynamic/instance-identity/document/
String instanceIdentityDocumentSignature
The instance identity document signature for the EC2 instance to
register. This signature can be found by running the following command
from the instance:
curl http://169.254.169.254/latest/dynamic/instance-identity/signature/
com.amazonaws.internal.SdkInternalList<T> totalResources
The resources available on the instance.
VersionInfo versionInfo
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
String containerInstanceArn
The Amazon Resource Name (ARN) of the container instance (if it was previously registered).
com.amazonaws.internal.SdkInternalList<T> attributes
The container instance attributes that this container instance supports.
ContainerInstance containerInstance
String family
You must specify a family for a task definition, which
allows you to track multiple versions of the same task definition. The
family is used as a name for your task definition. Up to 255
letters (uppercase and lowercase), numbers, hyphens, and underscores are
allowed.
com.amazonaws.internal.SdkInternalList<T> containerDefinitions
A list of container definitions in JSON format that describe the different containers that make up your task.
com.amazonaws.internal.SdkInternalList<T> volumes
A list of volume definitions in JSON format that containers in your task may use.
TaskDefinition taskDefinition
The full description of the registered task definition.
String name
The name of the resource, such as CPU, MEMORY,
PORTS, or a user-defined resource.
String type
The type of the resource, such as INTEGER,
DOUBLE, LONG, or STRINGSET.
Double doubleValue
When the doubleValue type is set, the value of the resource
must be a double precision floating-point type.
Long longValue
When the longValue type is set, the value of the resource
must be an extended precision floating-point type.
Integer integerValue
When the integerValue type is set, the value of the resource
must be an integer.
com.amazonaws.internal.SdkInternalList<T> stringSetValue
When the stringSetValue type is set, the value of the
resource must be a string type.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed..
String taskDefinition
The family and revision (
family:revision) or full Amazon Resource Name (ARN) of the
task definition to run. If a revision is not specified, the
latest ACTIVE revision is used.
TaskOverride overrides
A list of container overrides in JSON format that specify the name of a
container in the specified task definition and the overrides it should
receive. You can override the default command for a container (that is
specified in the task definition or Docker image) with a
command override. You can also override existing environment
variables (that are specified in the task definition or Docker image) on
a container or add new environment variables to it with an
environment override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
Integer count
The number of instantiations of the specified task to place on your cluster.
The count parameter is limited to 10 tasks per call.
String startedBy
An optional tag specified when a task is started. For example if you
automatically trigger a task to run a batch process job, you could apply
a unique identifier for that job to your task with the
startedBy parameter. You can then identify which tasks
belong to that job by filtering the results of a ListTasks call
with the startedBy value.
If a task is started by an Amazon ECS service, then the
startedBy parameter contains the deployment ID of the
service that starts it.
com.amazonaws.internal.SdkInternalList<T> tasks
A full description of the tasks that were run. Each task that was successfully placed on your cluster are described here.
com.amazonaws.internal.SdkInternalList<T> failures
Any failures associated with the call.
String serviceArn
The Amazon Resource Name (ARN) that identifies the service. The ARN
contains the arn:aws:ecs namespace, followed by the region
of the service, the AWS account ID of the service owner, the
service namespace, and then the service name. For example,
arn:aws:ecs:region:012345678910:service/my-service.
String serviceName
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.
String clusterArn
The Amazon Resource Name (ARN) of the of the cluster that hosts the service.
com.amazonaws.internal.SdkInternalList<T> loadBalancers
A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
String status
The status of the service. The valid values are ACTIVE,
DRAINING, or INACTIVE.
Integer desiredCount
The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
Integer runningCount
The number of tasks in the cluster that are in the RUNNING
state.
Integer pendingCount
The number of tasks in the cluster that are in the PENDING
state.
String taskDefinition
The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
DeploymentConfiguration deploymentConfiguration
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
com.amazonaws.internal.SdkInternalList<T> deployments
The current state of deployments for the service.
String roleArn
The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer.
com.amazonaws.internal.SdkInternalList<T> events
The event stream for your service. A maximum of 100 of the latest events are displayed.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed..
String taskDefinition
The family and revision (
family:revision) or full Amazon Resource Name (ARN) of the
task definition to start. If a revision is not specified,
the latest ACTIVE revision is used.
TaskOverride overrides
A list of container overrides in JSON format that specify the name of a
container in the specified task definition and the overrides it should
receive. You can override the default command for a container (that is
specified in the task definition or Docker image) with a
command override. You can also override existing environment
variables (that are specified in the task definition or Docker image) on
a container or add new environment variables to it with an
environment override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
com.amazonaws.internal.SdkInternalList<T> containerInstances
The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.
The list of container instances to start tasks on is limited to 10.
String startedBy
An optional tag specified when a task is started. For example if you
automatically trigger a task to run a batch process job, you could apply
a unique identifier for that job to your task with the
startedBy parameter. You can then identify which tasks
belong to that job by filtering the results of a ListTasks call
with the startedBy value.
If a task is started by an Amazon ECS service, then the
startedBy parameter contains the deployment ID of the
service that starts it.
com.amazonaws.internal.SdkInternalList<T> tasks
A full description of the tasks that were started. Each task that was successfully placed on your container instances are described here.
com.amazonaws.internal.SdkInternalList<T> failures
Any failures associated with the call.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed..
String task
The task ID or full Amazon Resource Name (ARN) entry of the task to stop.
String reason
An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message will appear in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.
Task task
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container.
String task
The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.
String containerName
The name of the container.
String status
The status of the state change request.
Integer exitCode
The exit code returned for the state change request.
String reason
The reason for the state change request.
com.amazonaws.internal.SdkInternalList<T> networkBindings
The network bindings of the container.
String acknowledgment
Acknowledgement of the state change.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.
String task
The task ID or full Amazon Resource Name (ARN) of the task in the state change request.
String status
The status of the state change request.
String reason
The reason for the state change request.
String acknowledgment
Acknowledgement of the state change.
String taskArn
The Amazon Resource Name (ARN) of the task.
String clusterArn
The Amazon Resource Name (ARN) of the of the cluster that hosts the task.
String taskDefinitionArn
The Amazon Resource Name (ARN) of the of the task definition that creates the task.
String containerInstanceArn
The Amazon Resource Name (ARN) of the container instances that host the task.
TaskOverride overrides
One or more container overrides.
String lastStatus
The last known status of the task.
String desiredStatus
The desired status of the task.
com.amazonaws.internal.SdkInternalList<T> containers
The containers associated with the task.
String startedBy
The tag specified when a task is started. If the task is started by an
Amazon ECS service, then the startedBy parameter contains
the deployment ID of the service that starts it.
String stoppedReason
The reason the task was stopped.
Date createdAt
The Unix time in seconds and milliseconds when the task was created (the
task entered the PENDING state).
Date startedAt
The Unix time in seconds and milliseconds when the task was started (the
task transitioned from the PENDING state to the
RUNNING state).
Date stoppedAt
The Unix time in seconds and milliseconds when the task was stopped (the
task transitioned from the RUNNING state to the
STOPPED state).
String taskDefinitionArn
The full Amazon Resource Name (ARN) of the of the task definition.
com.amazonaws.internal.SdkInternalList<T> containerDefinitions
A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
String family
The family of your task definition, used as the definition name.
Integer revision
The revision of the task in a particular family. The revision is a
version number of a task definition in a family. When you register a task
definition for the first time, the revision is 1; each time
you register a new revision of a task definition in the same family, the
revision value always increases by one (even if you have deregistered
previous revisions in this family).
com.amazonaws.internal.SdkInternalList<T> volumes
The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
String status
The status of the task definition.
com.amazonaws.internal.SdkInternalList<T> requiresAttributes
The container instance attributes required by your task.
com.amazonaws.internal.SdkInternalList<T> containerOverrides
One or more container overrides sent to a task.
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.
String containerInstance
The container instance ID or full Amazon Resource Name (ARN) entries for the container instance on which you would like to update the Amazon ECS container agent.
ContainerInstance containerInstance
String cluster
The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.
String service
The name of the service to update.
Integer desiredCount
The number of instantiations of the task to place and keep running in your service.
String taskDefinition
The family and revision (
family:revision) or full Amazon Resource Name (ARN) of the
task definition to run in your service. If a revision is not
specified, the latest ACTIVE revision is used. If you modify
the task definition with UpdateService, Amazon ECS spawns a
task with the new version of the task definition and then stops an old
task after the new version is running.
DeploymentConfiguration deploymentConfiguration
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
Service service
The full description of your service following the update call.
String agentVersion
The version number of the Amazon ECS container agent.
String agentHash
The Git commit hash for the Amazon ECS container agent build on the amazon-ecs- agent GitHub repository.
String dockerVersion
The Docker version running on the container instance.
String name
The name of the volume. Up to 255 letters (uppercase and lowercase),
numbers, hyphens, and underscores are allowed. This name is referenced in
the sourceVolume parameter of container definition
mountPoints.
HostVolumeProperties host
The contents of the host parameter determine whether your
data volume persists on the host container instance and where it is
stored. If the host parameter is empty, then the Docker daemon assigns a
host path for your data volume, but the data is not guaranteed to persist
after the containers associated with it stop running.
String resourceName
arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster.com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
String cacheSecurityGroupName
String eC2SecurityGroupName
String eC2SecurityGroupOwnerId
String name
String cacheClusterId
Endpoint configurationEndpoint
String clientDownloadLandingPage
String cacheNodeType
Valid node types are as follows:
cache.t2.micro,
cache.t2.small, cache.t2.medium,
cache.m3.medium, cache.m3.large,
cache.m3.xlarge, cache.m3.2xlargecache.t1.micro,
cache.m1.small, cache.m1.medium,
cache.m1.large, cache.m1.xlargecache.c1.xlargecache.r3.large, cache.r3.xlarge,
cache.r3.2xlarge, cache.r3.4xlarge,
cache.r3.8xlargecache.m2.xlarge, cache.m2.2xlarge,
cache.m2.4xlargeNotes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
String engine
String engineVersion
String cacheClusterStatus
Integer numCacheNodes
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
String preferredAvailabilityZone
Date cacheClusterCreateTime
String preferredMaintenanceWindow
ddd are:
sunmontuewedthufrisatExample:
sun:05:00-sun:09:00
PendingModifiedValues pendingModifiedValues
NotificationConfiguration notificationConfiguration
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroups
CacheParameterGroupStatus cacheParameterGroup
String cacheSubnetGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodes
Boolean autoMinorVersionUpgrade
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
String replicationGroupId
Integer snapshotRetentionLimit
Important
If the value of SnapshotRetentionLimit is set
to zero (0), backups are turned off.
String snapshotWindow
Example:
05:00-09:00
String engine
String engineVersion
String cacheParameterGroupFamily
String cacheEngineDescription
String cacheEngineVersionDescription
String cacheNodeId
String cacheNodeStatus
Date cacheNodeCreateTime
Endpoint endpoint
String parameterGroupStatus
String sourceCacheNodeId
String customerAvailabilityZone
String parameterName
String description
String source
String dataType
String allowedValues
Boolean isModifiable
true) or not (false) the
parameter can be modified. Some parameters have security or
operational implications that prevent them from being changed.String minimumEngineVersion
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeTypeSpecificValues
String cacheParameterGroupName
String cacheParameterGroupFamily
String description
String cacheParameterGroupName
String parameterApplyStatus
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeIdsToReboot
String ownerId
String cacheSecurityGroupName
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> eC2SecurityGroups
String cacheSubnetGroupName
String cacheSubnetGroupDescription
String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
String cacheClusterId
Constraints:
String replicationGroupId
If the specified replication group is Multi-AZ enabled and the availability zone is not specified, the cache cluster will be created in availability zones that provide the best spread of read replicas across availability zones.
Note: This
parameter is only valid if the Engine parameter is
redis.
String aZMode
This parameter is only supported for Memcached cache clusters.
If the AZMode and
PreferredAvailabilityZones are not specified, ElastiCache
assumes single-az mode.
Constraints:
Allowed Values: single-az, cross-az
String preferredAvailabilityZone
All nodes belonging to this Memcached cache cluster are placed in
the preferred Availability Zone. If you want to create your nodes
across multiple Availability Zones, use
PreferredAvailabilityZones.
Default: System chosen Availability Zone.
com.amazonaws.internal.ListWithAutoConstructFlag<T> preferredAvailabilityZones
This option is
only supported on Memcached. If you are creating your cache
cluster in an Amazon VPC (recommended) you can only locate nodes in
Availability Zones that are associated with the subnets in the
selected subnet group. The number of Availability Zones listed must
equal the value of NumCacheNodes.
If you want
all the nodes in the same Availability Zone, use
PreferredAvailabilityZone instead, or repeat the
Availability Zone multiple times in the list.
Default: System chosen Availability Zones.
Example: One Memcached node in each of
three different Availability Zones:
PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2b&PreferredAvailabilityZones.member.3=us-west-2c
Example: All three Memcached nodes in one Availability Zone:
PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a
Integer numCacheNodes
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
String cacheNodeType
Valid node types are as follows:
cache.t2.micro,
cache.t2.small, cache.t2.medium,
cache.m3.medium, cache.m3.large,
cache.m3.xlarge, cache.m3.2xlargecache.t1.micro,
cache.m1.small, cache.m1.medium,
cache.m1.large, cache.m1.xlargecache.c1.xlargecache.r3.large, cache.r3.xlarge,
cache.r3.2xlarge, cache.r3.4xlarge,
cache.r3.8xlargecache.m2.xlarge, cache.m2.2xlarge,
cache.m2.4xlargeNotes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
String engine
Valid values for this parameter are:
memcached |
redis
String engineVersion
String cacheParameterGroupName
String cacheSubnetGroupName
Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroupNames
Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC).
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotArns
Note: This parameter is only valid if the
Engine parameter is redis.
Example of an
Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
String snapshotName
restoring while the
new node group is being created. Note: This parameter is
only valid if the Engine parameter is redis.
String preferredMaintenanceWindow
ddd are:
sunmontuewedthufrisatExample:
sun:05:00-sun:09:00
Integer port
String notificationTopicArn
Boolean autoMinorVersionUpgrade
Integer snapshotRetentionLimit
SnapshotRetentionLimit to 5, then a snapshot that was
taken today will be retained for 5 days before being deleted.
Note: This parameter is only valid if the
Engine parameter is redis.
Default: 0 (i.e., automatic backups are disabled for this cache cluster).
String snapshotWindow
Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
Note: This parameter is only valid if the
Engine parameter is redis.
String cacheParameterGroupName
String cacheParameterGroupFamily
Valid values are: memcached1.4 |
redis2.6 | redis2.8
String description
String cacheSecurityGroupName
Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word "Default".
Example:
mysecuritygroup
String description
String cacheSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example: mysubnetgroup
String cacheSubnetGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
String replicationGroupId
Constraints:
String replicationGroupDescription
String primaryClusterId
This parameter is not required if NumCacheClusters is specified.
Boolean automaticFailoverEnabled
If
true, Multi-AZ is enabled for this replication group. If
false, Multi-AZ is disabled for this replication group.
Default: false ElastiCache Multi-AZ replication groups is
not supported on:
Integer numCacheClusters
If Multi-AZ is enabled, the value of this
parameter must be at least 2.
The maximum permitted value for NumCacheClusters is 6 (primary plus 5 replicas). If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request.
com.amazonaws.internal.ListWithAutoConstructFlag<T> preferredCacheClusterAZs
The number of availability zones listed must equal the value of NumCacheClusters.
Default: system chosen availability zones.
Example: One Redis cache cluster in each of three availability zones. PreferredAvailabilityZones.member.1=us-west-2a PreferredAvailabilityZones.member.2=us-west-2c PreferredAvailabilityZones.member.3=us-west-2c
String cacheNodeType
Valid node types are as follows:
cache.t2.micro,
cache.t2.small, cache.t2.medium,
cache.m3.medium, cache.m3.large,
cache.m3.xlarge, cache.m3.2xlargecache.t1.micro,
cache.m1.small, cache.m1.medium,
cache.m1.large, cache.m1.xlargecache.c1.xlargecache.r3.large, cache.r3.xlarge,
cache.r3.2xlarge, cache.r3.4xlarge,
cache.r3.8xlargecache.m2.xlarge, cache.m2.2xlarge,
cache.m2.4xlargeNotes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
String engine
Default: redis
String engineVersion
String cacheParameterGroupName
String cacheSubnetGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroupNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (VPC).
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotArns
Note: This parameter is only valid if the
Engine parameter is redis.
Example of an
Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
String snapshotName
restoring while the
new node group is being created. Note: This parameter is
only valid if the Engine parameter is redis.
String preferredMaintenanceWindow
ddd are:
sunmontuewedthufrisatExample:
sun:05:00-sun:09:00
Integer port
String notificationTopicArn
Boolean autoMinorVersionUpgrade
Integer snapshotRetentionLimit
SnapshotRetentionLimit to 5, then a snapshot that was
taken today will be retained for 5 days before being deleted.
Note: This parameter is only valid if the
Engine parameter is redis.
Default: 0 (i.e., automatic backups are disabled for this cache cluster).
String snapshotWindow
Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
Note: This parameter is only valid if the
Engine parameter is redis.
String cacheClusterId
String finalSnapshotIdentifier
String cacheParameterGroupName
String cacheSecurityGroupName
String cacheSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
String replicationGroupId
Boolean retainPrimaryCluster
String finalSnapshotIdentifier
String snapshotName
String cacheClusterId
Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
Boolean showCacheNodeInfo
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheClusters
String engine
memcached |
redisString engineVersion
Example: 1.4.14
String cacheParameterGroupFamily
Constraints:
Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
Boolean defaultOnly
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheEngineVersions
String cacheParameterGroupName
Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheParameterGroups
String cacheParameterGroupName
String source
Valid values: user |
system | engine-default
Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeTypeSpecificParameters
String cacheSecurityGroupName
Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroups
String cacheSubnetGroupName
Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSubnetGroups
String cacheParameterGroupFamily
memcached1.4 | redis2.6 |
redis2.8Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String sourceIdentifier
String sourceType
Valid values are: cache-cluster |
cache-parameter-group | cache-security-group
| cache-subnet-group
Constraints:
Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
Date startTime
Date endTime
Integer duration
Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String replicationGroupId
If you do not specify this parameter, information about all replication groups is returned.
Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> replicationGroups
String reservedCacheNodesOfferingId
Example:
438012d3-4052-4cc7-b2e3-8d3372e0e706
String cacheNodeType
Valid node types are as follows:
cache.t2.micro, cache.t2.small,
cache.t2.medium, cache.m3.medium,
cache.m3.large, cache.m3.xlarge,
cache.m3.2xlargecache.t1.micro, cache.m1.small,
cache.m1.medium, cache.m1.large,
cache.m1.xlargecache.c1.xlargecache.r3.large,
cache.r3.xlarge, cache.r3.2xlarge,
cache.r3.4xlarge, cache.r3.8xlargecache.m2.xlarge,
cache.m2.2xlarge, cache.m2.4xlargeNotes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
String productDescription
String offeringType
Valid
Values: "Light Utilization"|"Medium Utilization"|"Heavy
Utilization"
Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedCacheNodesOfferings
String reservedCacheNodeId
String reservedCacheNodesOfferingId
String cacheNodeType
Valid node types are as follows:
cache.t2.micro, cache.t2.small,
cache.t2.medium, cache.m3.medium,
cache.m3.large, cache.m3.xlarge,
cache.m3.2xlargecache.t1.micro, cache.m1.small,
cache.m1.medium, cache.m1.large,
cache.m1.xlargecache.c1.xlargecache.r3.large,
cache.r3.xlarge, cache.r3.2xlarge,
cache.r3.4xlarge, cache.r3.8xlargecache.m2.xlarge,
cache.m2.2xlarge, cache.m2.4xlargeNotes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
String productDescription
String offeringType
Valid
values: "Light Utilization"|"Medium Utilization"|"Heavy
Utilization"
Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
String marker
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedCacheNodes
String cacheClusterId
String snapshotName
String snapshotSource
system, the output shows snapshots that were
automatically created by ElastiCache. If set to user the
output shows snapshots that were manually created. If omitted, the
output shows both automatically and manually created snapshots.String marker
Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 50
Constraints: minimum 20; maximum 50.
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshots
String cacheParameterGroupFamily
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeTypeSpecificParameters
String sourceIdentifier
String sourceType
Constraints:
Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
String message
Date date
String resourceName
arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
String cacheClusterId
Integer numCacheNodes
NumCacheNodes is greater than the sum of the
number of current cache nodes and the number of cache nodes pending
creation (which may be zero), then more nodes will be added. If the
value is less than the number of existing cache nodes, then nodes will
be removed. If the value is equal to the number of current cache
nodes, then any pending add or remove requests are canceled. If you
are removing cache nodes, you must use the
CacheNodeIdsToRemove parameter to provide the IDs of the
specific cache nodes to remove.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
Note:
Adding or removing Memcached
cache nodes can be applied immediately or as a pending action. See
ApplyImmediately.
A pending action to modify the
number of cache nodes in a cluster during its maintenance window,
whether by adding or removing nodes in accordance with the scale out
architecture, is not queued. The customer's latest request to add or
remove nodes to the cluster overrides any previous pending actions to
modify the number of cache nodes in the cluster. For example, a
request to remove 2 nodes would override a previous pending action to
remove 3 nodes. Similarly, a request to add 2 nodes would override a
previous pending action to remove 3 nodes and vice versa. As Memcached
cache nodes may now be provisioned in different Availability Zones
with flexible cache node placement, a request to add nodes does not
automatically override a previous pending action to add nodes. The
customer can modify the previous pending action to add more nodes or
explicitly cancel the pending request and retry the new request. To
cancel pending actions to modify the number of cache nodes in a
cluster, use the ModifyCacheCluster request and set
NumCacheNodes equal to the number of cache nodes currently in
the cache cluster.
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeIdsToRemove
For example: If you have 3
active cache nodes, 7 pending cache nodes, and the number of cache
nodes in this ModifyCacheCluser call is 5, you must list
2 (7 - 5) cache node IDs to remove.
String aZMode
Valid values: single-az |
cross-az.
This option is only supported for Memcached
cache clusters. You cannot specify Only
newly created nodes will be located in different Availability Zones.
For instructions on how to move existing Memcached nodes to different
Availability Zones, see the Availability Zone Considerations
section of Cache
Node Considerations for Memcached. single-az if
the Memcached cache cluster already has cache nodes in different
Availability Zones. If cross-az is specified, existing
Memcached nodes remain in their current Availability Zone.
Constraints:
Allowed Values: single-az, cross-az
com.amazonaws.internal.ListWithAutoConstructFlag<T> newAvailabilityZones
This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.
This option is only supported on Memcached clusters.
Scenarios:
NumCacheNodes=5 (3 + 2)
and optionally specify two Availability Zones for the two new
nodes.NumCacheNodes=6 ((3 + 2) + 1)NumCacheNodes=3 to cancel all pending
actions.The Availability Zone placement of nodes
pending creation cannot be modified. If you wish to cancel any nodes
pending creation, add 0 nodes by setting NumCacheNodes to
the number of current nodes.
If cross-az is specified,
existing Memcached nodes remain in their current Availability Zone.
Only newly created nodes can be located in different Availability
Zones. For guidance on how to move existing Memcached nodes to
different Availability Zones, see the Availability Zone
Considerations section of Cache
Node Considerations for Memcached.
Impact of new add/remove requests upon pending requests
| Scenarios | Pending action | New Request | Results |
|---|---|---|---|
| Scenario-1 | Delete | Delete | The new delete, pending or immediate, replaces the pending delete. |
| Scenario-2 | Delete | Create | The new create, pending or immediate, replaces the pending delete. |
| Scenario-3 | Create | Delete | The new delete, pending or immediate, replaces the pending create. |
| Scenario-4 | Create | Create | The new
create is added to the pending create. Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending. |
Example:
NewAvailabilityZones.member.1=us-west-2a&NewAvailabilityZones.member.2=us-west-2b&NewAvailabilityZones.member.3=us-west-2c
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroupNames
This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).
String preferredMaintenanceWindow
ddd are:
sunmontuewedthufrisatExample:
sun:05:00-sun:09:00
String notificationTopicArn
String cacheParameterGroupName
String notificationTopicStatus
Valid values:
active | inactive
Boolean applyImmediately
true, this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the cache cluster. If
false, then changes to the cache cluster are applied on
the next maintenance reboot, or the next failure reboot, whichever
occurs first. ModifyCacheCluster before a pending modification is
applied, the pending modification is replaced by the newer
modification.
Valid values: true |
false
Default: false
String engineVersion
Boolean autoMinorVersionUpgrade
Integer snapshotRetentionLimit
Important
If the value of SnapshotRetentionLimit is set
to zero (0), backups are turned off.
String snapshotWindow
String cacheParameterGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterNameValues
String cacheParameterGroupName
String cacheSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example:
mysubnetgroup
String cacheSubnetGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
String replicationGroupId
String replicationGroupDescription
String primaryClusterId
String snapshottingClusterId
Boolean automaticFailoverEnabled
Valid values:
ElastiCache Multi-AZ
replication groups are not supported on: true | false
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroupNames
This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
String preferredMaintenanceWindow
ddd are:
sunmontuewedthufrisatExample:
sun:05:00-sun:09:00
String notificationTopicArn
String cacheParameterGroupName
String notificationTopicStatus
Valid values: active | inactive
Boolean applyImmediately
true, this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the replication group.
If false, then changes to the nodes in the replication
group are applied on the next maintenance reboot, or the next failure
reboot, whichever occurs first.
Valid values: true |
false
Default: false
String engineVersion
Boolean autoMinorVersionUpgrade
Integer snapshotRetentionLimit
Important
If the value of SnapshotRetentionLimit is set
to zero (0), backups are turned off.
String snapshotWindow
Example: 05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
String nodeGroupId
String status
Endpoint primaryEndpoint
com.amazonaws.internal.ListWithAutoConstructFlag<T> nodeGroupMembers
String cacheClusterId
String cacheNodeId
Endpoint readEndpoint
String preferredAvailabilityZone
String currentRole
String cacheNodeId
String cacheSize
Date cacheNodeCreateTime
Date snapshotCreateTime
String parameterName
String parameterValue
String description
String source
String dataType
String allowedValues
Boolean isModifiable
true) or not (false) the
parameter can be modified. Some parameters have security or
operational implications that prevent them from being changed.String minimumEngineVersion
Integer numCacheNodes
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeIdsToRemove
String engineVersion
String reservedCacheNodesOfferingId
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
String reservedCacheNodeId
Example: myreservationID
Integer cacheNodeCount
Default:
1
String cacheClusterId
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeIdsToReboot
String resourceName
arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
TagKeys identifying the tags you want removed
from the named resource. For example,
TagKeys.member.1=Region removes the cost allocation tag
with the key name Region from the resource named by the
ResourceName parameter.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
String replicationGroupId
String description
String status
ReplicationGroupPendingModifiedValues pendingModifiedValues
com.amazonaws.internal.ListWithAutoConstructFlag<T> memberClusters
com.amazonaws.internal.ListWithAutoConstructFlag<T> nodeGroups
String snapshottingClusterId
String automaticFailover
ElastiCache Multi-AZ replication groups are not supported on:
Constraints:
Allowed Values: enabled, disabled, enabling, disabling
String primaryClusterId
--apply-immediately was specified), or during the next
maintenance window.String automaticFailoverStatus
ElastiCache Multi-AZ replication groups are not supported on:
Constraints:
Allowed Values: enabled, disabled
String reservedCacheNodeId
String reservedCacheNodesOfferingId
String cacheNodeType
Valid node types are as follows:
cache.t2.micro, cache.t2.small,
cache.t2.medium, cache.m3.medium,
cache.m3.large, cache.m3.xlarge,
cache.m3.2xlargecache.t1.micro, cache.m1.small,
cache.m1.medium, cache.m1.large,
cache.m1.xlargecache.c1.xlargecache.r3.large,
cache.r3.xlarge, cache.r3.2xlarge,
cache.r3.4xlarge, cache.r3.8xlargecache.m2.xlarge,
cache.m2.2xlarge, cache.m2.4xlargeNotes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
Date startTime
Integer duration
Double fixedPrice
Double usagePrice
Integer cacheNodeCount
String productDescription
String offeringType
String state
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String reservedCacheNodesOfferingId
String cacheNodeType
Valid node types are as follows:
cache.t2.micro, cache.t2.small,
cache.t2.medium, cache.m3.medium,
cache.m3.large, cache.m3.xlarge,
cache.m3.2xlargecache.t1.micro, cache.m1.small,
cache.m1.medium, cache.m1.large,
cache.m1.xlargecache.c1.xlargecache.r3.large,
cache.r3.xlarge, cache.r3.2xlarge,
cache.r3.4xlarge, cache.r3.8xlargecache.m2.xlarge,
cache.m2.2xlarge, cache.m2.4xlargeNotes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
Integer duration
Double fixedPrice
Double usagePrice
String productDescription
String offeringType
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String cacheParameterGroupName
Boolean resetAllParameters
Valid values: true | false
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterNameValues
String cacheParameterGroupName
String cacheSecurityGroupName
String eC2SecurityGroupName
String eC2SecurityGroupOwnerId
String snapshotName
String cacheClusterId
String snapshotStatus
creating |
available | restoring | copying
| deleting.String snapshotSource
automated) or was created manually
(manual).String cacheNodeType
Valid node types are as follows:
cache.t2.micro,
cache.t2.small, cache.t2.medium,
cache.m3.medium, cache.m3.large,
cache.m3.xlarge, cache.m3.2xlargecache.t1.micro,
cache.m1.small, cache.m1.medium,
cache.m1.large, cache.m1.xlargecache.c1.xlargecache.r3.large, cache.r3.xlarge,
cache.r3.2xlarge, cache.r3.4xlarge,
cache.r3.8xlargecache.m2.xlarge, cache.m2.2xlarge,
cache.m2.4xlargeNotes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
String engine
String engineVersion
Integer numCacheNodes
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
String preferredAvailabilityZone
Date cacheClusterCreateTime
String preferredMaintenanceWindow
ddd are:
sunmontuewedthufrisatExample:
sun:05:00-sun:09:00
String topicArn
Integer port
String cacheParameterGroupName
String cacheSubnetGroupName
String vpcId
Boolean autoMinorVersionUpgrade
Integer snapshotRetentionLimit
For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot action.
Important
If the value
of SnapshotRetentionLimit is set to zero (0), backups are turned off.
String snapshotWindow
com.amazonaws.internal.ListWithAutoConstructFlag<T> nodeSnapshots
String subnetIdentifier
AvailabilityZone subnetAvailabilityZone
String applicationName
The name of the application.
String description
User-defined description of the application.
Date dateCreated
The date when the application was created.
Date dateUpdated
The date when the application was last modified.
com.amazonaws.internal.SdkInternalList<T> versions
The names of the versions for this application.
com.amazonaws.internal.SdkInternalList<T> configurationTemplates
The names of the configuration templates associated with this application.
Integer duration
The amount of time that the metrics cover (usually 10 seconds). For
example, you might have 5 requests (request_count) within
the most recent time slice of 10 seconds (duration).
Integer requestCount
Average number of requests handled by the web server per second over the last 10 seconds.
StatusCodes statusCodes
Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response.
Latency latency
Represents the average latency for the slowest X percent of requests over the last 10 seconds. Latencies are in seconds with one milisecond resolution.
String applicationName
The name of the application associated with this release.
String description
The description of this application version.
String versionLabel
A label uniquely identifying the version for the associated application.
S3Location sourceBundle
The location where the source bundle is located for this version.
Date dateCreated
The creation date of the application version.
Date dateUpdated
The last modified date of the application version.
String status
The processing status of the application version.
String name
The name of the AutoScalingGroup .
String cNAMEPrefix
The prefix used when this CNAME is reserved.
Boolean available
Indicates if the specified CNAME is available:
true : The CNAME is available.false : The CNAME is not available.String fullyQualifiedCNAME
The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix.
String applicationName
The name of the application to which the specified source bundles belong.
String groupName
The name of the group to which the target environments belong. Specify a group name only if the environment name defined in each target environment's manifest ends with a + (plus) character. See Environment Manifest (env.yaml) for details.
com.amazonaws.internal.SdkInternalList<T> versionLabels
A list of version labels, specifying one or more application source bundles that belong to the target application. Each source bundle must include an environment manifest that specifies the name of the environment and the name of the solution stack to use, and optionally can specify environment links to create.
com.amazonaws.internal.SdkInternalList<T> environments
Returns an EnvironmentDescription list.
String namespace
A unique namespace identifying the option's associated AWS resource.
String name
The name of the configuration option.
String defaultValue
The default value for this configuration option.
String changeSeverity
An indication of which action is required if the value for this configuration option changes:
NoInterruption : There is no interruption to the
environment or application availability.RestartEnvironment : The environment is entirely
restarted, all AWS resources are deleted and recreated, and the
environment is unavailable during the process.RestartApplicationServer : The environment is available
the entire time. However, a short application outage occurs when the
application servers on the running Amazon EC2 instances are restarted.Boolean userDefined
An indication of whether the user defined this configuration option:
true : This configuration option was defined by the user. It
is a valid choice for specifying if this as an
Option to Remove when updating configuration settings.
false : This configuration was not defined by the user.
Constraint: You can remove only UserDefined options from a
configuration.
Valid Values: true | false
String valueType
An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:
Scalar : Values for this option are a single selection
from the possible values, or an unformatted string, or numeric value
governed by the MIN/MAX/Regex constraints.List : Values for this option are multiple selections
from the possible values.Boolean : Values for this option are either
true or false .Json : Values for this option are a JSON representation
of a ConfigDocument.com.amazonaws.internal.SdkInternalList<T> valueOptions
If specified, values for the configuration option are selected from this list.
Integer minValue
If specified, the configuration option must be a numeric value greater than this value.
Integer maxValue
If specified, the configuration option must be a numeric value less than this value.
Integer maxLength
If specified, the configuration option must be a string value no longer than this value.
OptionRestrictionRegex regex
If specified, the configuration option must be a string value that satisfies this regular expression.
String resourceName
A unique resource name for a time-based scaling configuration option.
String namespace
A unique namespace identifying the option's associated AWS resource.
String optionName
The name of the configuration option.
String value
The current value for the configuration option.
String solutionStackName
The name of the solution stack this configuration set uses.
String applicationName
The name of the application associated with this configuration set.
String templateName
If not null, the name of the configuration template for this
configuration set.
String description
Describes this configuration set.
String environmentName
If not null, the name of the environment for this
configuration set.
String deploymentStatus
If this configuration set is associated with an environment, the
DeploymentStatus parameter indicates the deployment status
of this configuration set:
null: This configuration is not associated with a
running environment.pending: This is a draft configuration that is not
deployed to the associated environment but is in the process of
deploying.deployed: This is the configuration that is currently
deployed to the associated running environment.failed: This is a draft configuration that failed to
successfully deploy.Date dateCreated
The date (in UTC time) when this configuration set was created.
Date dateUpdated
The date (in UTC time) when this configuration set was last modified.
com.amazonaws.internal.SdkInternalList<T> optionSettings
A list of the configuration options and their values in this configuration set.
Double user
Percentage of time that the CPU has spent in the User state
over the last 10 seconds.
Double nice
Percentage of time that the CPU has spent in the Nice state
over the last 10 seconds.
Double system
Percentage of time that the CPU has spent in the System
state over the last 10 seconds.
Double idle
Percentage of time that the CPU has spent in the Idle state
over the last 10 seconds.
Double iOWait
Percentage of time that the CPU has spent in the I/O Wait
state over the last 10 seconds.
Double iRQ
Percentage of time that the CPU has spent in the IRQ state
over the last 10 seconds.
Double softIRQ
Percentage of time that the CPU has spent in the SoftIRQ
state over the last 10 seconds.
ApplicationDescription application
The ApplicationDescription of the application.
String applicationName
The name of the application. If no application is found with this name,
and AutoCreateApplication is false, returns an
InvalidParameterValue error.
String versionLabel
A label identifying this version.
Constraint: Must be unique per application. If an application version
already exists with this label for the specified application, AWS Elastic
Beanstalk returns an InvalidParameterValue error.
String description
Describes this version.
S3Location sourceBundle
The Amazon S3 bucket and key that identify the location of the source bundle for this version.
If data found at the Amazon S3 location exceeds the maximum allowed
source bundle size, AWS Elastic Beanstalk returns an
InvalidParameterValue error. The maximum size allowed is 512
MB.
Default: If not specified, AWS Elastic Beanstalk uses a sample
application. If only partially specified (for example, a bucket is
provided but not the key) or if no data is found at the Amazon S3
location, AWS Elastic Beanstalk returns an
InvalidParameterCombination error.
Boolean autoCreateApplication
Determines how the system behaves if the specified application for this version does not already exist:
true : Automatically creates the specified application
for this 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
Boolean process
Preprocesses and validates the environment manifest and configuration files in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment.
ApplicationVersionDescription applicationVersion
The ApplicationVersionDescription of the application version.
String applicationName
The name of the application to associate with this configuration
template. If no application is found with this name, AWS Elastic
Beanstalk returns an InvalidParameterValue error.
String templateName
The name of the configuration template.
Constraint: This name must be unique per application.
Default: If a configuration template already exists with this name, AWS
Elastic Beanstalk returns an InvalidParameterValue error.
String solutionStackName
The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values.
Use ListAvailableSolutionStacks to obtain a list of available solution stacks.
A solution stack name or a source configuration parameter must be
specified, otherwise AWS Elastic Beanstalk returns an
InvalidParameterValue error.
If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.
SourceConfiguration sourceConfiguration
If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
Values specified in the OptionSettings parameter of this
call overrides any values obtained from the
SourceConfiguration.
If no configuration template is found, returns an
InvalidParameterValue error.
Constraint: If both the solution stack name parameter and the source
configuration parameters are specified, the solution stack of the source
configuration template must match the specified solution stack name or
else AWS Elastic Beanstalk returns an
InvalidParameterCombination error.
String environmentId
The ID of the environment used with this configuration template.
String description
Describes this configuration.
com.amazonaws.internal.SdkInternalList<T> optionSettings
If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template.
String solutionStackName
The name of the solution stack this configuration set uses.
String applicationName
The name of the application associated with this configuration set.
String templateName
If not null, the name of the configuration template for this
configuration set.
String description
Describes this configuration set.
String environmentName
If not null, the name of the environment for this
configuration set.
String deploymentStatus
If this configuration set is associated with an environment, the
DeploymentStatus parameter indicates the deployment status
of this configuration set:
null: This configuration is not associated with a
running environment.pending: This is a draft configuration that is not
deployed to the associated environment but is in the process of
deploying.deployed: This is the configuration that is currently
deployed to the associated running environment.failed: This is a draft configuration that failed to
successfully deploy.Date dateCreated
The date (in UTC time) when this configuration set was created.
Date dateUpdated
The date (in UTC time) when this configuration set was last modified.
com.amazonaws.internal.SdkInternalList<T> optionSettings
A list of the configuration options and their values in this configuration set.
String applicationName
The name of the application that contains the version to be deployed.
If no application is found with this name, CreateEnvironment
returns an InvalidParameterValue error.
String environmentName
A unique name for the deployment environment. Used in the application URL.
Constraint: Must be from 4 to 23 characters in length. The name can
contain only letters, numbers, and hyphens. It cannot start or end with a
hyphen. This name must be unique in your account. If the specified name
already exists, AWS Elastic Beanstalk returns an
InvalidParameterValue error.
Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
String groupName
The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest (env.yaml) for details.
String description
Describes this environment.
String cNAMEPrefix
If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
EnvironmentTier tier
This specifies the tier to use for creating this environment.
com.amazonaws.internal.SdkInternalList<T> tags
This specifies the tags applied to resources in the environment.
String versionLabel
The name of the application version to deploy.
If the specified application has no associated application versions, AWS
Elastic Beanstalk UpdateEnvironment returns an
InvalidParameterValue error.
Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.
String templateName
The name of the configuration template to use in deployment. If no
configuration template is found with this name, AWS Elastic Beanstalk
returns an InvalidParameterValue error.
Condition: You must specify either this parameter or a
SolutionStackName, but not both. If you specify both, AWS
Elastic Beanstalk returns an InvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns a
MissingRequiredParameter error.
String solutionStackName
This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.
Condition: You must specify either this or a TemplateName,
but not both. If you specify both, AWS Elastic Beanstalk returns an
InvalidParameterCombination error. If you do not specify
either, AWS Elastic Beanstalk returns a
MissingRequiredParameter error.
com.amazonaws.internal.SdkInternalList<T> optionSettings
If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.
com.amazonaws.internal.SdkInternalList<T> optionsToRemove
A list of custom user-defined configuration options to remove from the configuration set for this new environment.
String environmentName
The name of this environment.
String environmentId
The ID of this environment.
String applicationName
The name of the application associated with this environment.
String versionLabel
The application version deployed in this environment.
String solutionStackName
The name of the SolutionStack deployed with this
environment.
String templateName
The name of the configuration template used to originally launch this environment.
String description
Describes this environment.
String endpointURL
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
String cNAME
The URL to the CNAME for this environment.
Date dateCreated
The creation date for this environment.
Date dateUpdated
The last modified date for this environment.
String status
The current operational status of the environment:
Launching: Environment is in the process of initial
deployment.Updating: Environment is in the process of updating its
configuration settings or application version.Ready: Environment is available to have an action
performed on it, such as update or terminate.Terminating: Environment is in the shut-down process.Terminated: Environment is not running.Boolean abortableOperationInProgress
Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
true: There is an update in progress.
false: There are no updates currently in progress.
String health
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red: Indicates the environment is not responsive. Occurs
when three or more consecutive failures occur for an environment.Yellow: Indicates that something is wrong. Occurs when
two consecutive failures occur for an environment.Green: Indicates the environment is healthy and fully
functional.Grey: Default health for a new environment. The
environment is not fully launched and health checks have not started or
health checks are suspended during an UpdateEnvironment or
RestartEnvironement request.
Default: Grey
String healthStatus
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
EnvironmentResourcesDescription resources
The description of the AWS resources used by this environment.
EnvironmentTier tier
Describes the current tier of this environment.
com.amazonaws.internal.SdkInternalList<T> environmentLinks
A list of links to other environments in the same group.
String s3Bucket
The name of the Amazon S3 bucket created.
String applicationName
The name of the application to delete releases from.
String versionLabel
The label of the version to delete.
Boolean deleteSourceBundle
Indicates whether to delete the associated source bundle from Amazon S3:
true: An attempt is made to delete the associated Amazon
S3 source bundle specified at time of creation.false: No action is taken on the Amazon S3 source bundle
specified at time of creation.
Valid Values: true | false
com.amazonaws.internal.SdkInternalList<T> applicationNames
If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.
com.amazonaws.internal.SdkInternalList<T> applications
This parameter contains a list of ApplicationDescription.
String applicationName
If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include ones that are associated with the specified application.
com.amazonaws.internal.SdkInternalList<T> versionLabels
If specified, restricts the returned descriptions to only include ones that have the specified version labels.
com.amazonaws.internal.SdkInternalList<T> applicationVersions
List of ApplicationVersionDescription objects sorted by
order of creation.
String applicationName
The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.
String templateName
The name of the configuration template whose configuration options you want to describe.
String environmentName
The name of the environment whose configuration options you want to describe.
String solutionStackName
The name of the solution stack whose configuration options you want to describe.
com.amazonaws.internal.SdkInternalList<T> options
If specified, restricts the descriptions to only the specified options.
String solutionStackName
The name of the solution stack these configuration options belong to.
com.amazonaws.internal.SdkInternalList<T> options
A list of ConfigurationOptionDescription.
String applicationName
The application for the environment or configuration template.
String templateName
The name of the configuration template to describe.
Conditional: You must specify either this parameter or an
EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk
returns an InvalidParameterCombination error. If you do not
specify either, AWS Elastic Beanstalk returns a
MissingRequiredParameter error.
String environmentName
The name of the environment to describe.
Condition: You must specify either this or a TemplateName, but not both.
If you specify both, AWS Elastic Beanstalk returns an
InvalidParameterCombination error. If you do not specify
either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
com.amazonaws.internal.SdkInternalList<T> configurationSettings
A list of ConfigurationSettingsDescription.
String environmentName
Specifies the AWS Elastic Beanstalk environment name.
Condition: You must specify either this or an EnvironmentId, or both. If
you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
String environmentId
Specifies the AWS Elastic Beanstalk environment ID.
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
com.amazonaws.internal.SdkInternalList<T> attributeNames
Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk only returns the name of the environment.
String environmentName
The AWS Elastic Beanstalk environment name.
String healthStatus
Contains the response body with information about the health of the environment.
String status
Returns the health status value of the environment. For more information, see Health Colors and Statuses.
String color
Returns the color indicator that tells you information about the health of the environment. For more information, see Health Colors and Statuses.
com.amazonaws.internal.SdkInternalList<T> causes
Returns potential causes for the reported status.
ApplicationMetrics applicationMetrics
InstanceHealthSummary instancesHealth
Date refreshedAt
The date and time the information was last refreshed.
String environmentId
The ID of the environment to retrieve AWS resource usage data.
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
String environmentName
The name of the environment to retrieve AWS resource usage data.
Condition: You must specify either this or an EnvironmentId, or both. If
you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
EnvironmentResourceDescription environmentResources
A list of EnvironmentResourceDescription.
String applicationName
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
String versionLabel
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
com.amazonaws.internal.SdkInternalList<T> environmentIds
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
com.amazonaws.internal.SdkInternalList<T> environmentNames
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
Boolean includeDeleted
Indicates whether to include deleted environments:
true: Environments that have been deleted after
IncludedDeletedBackTo are displayed.
false: Do not include deleted environments.
Date includedDeletedBackTo
If specified when IncludeDeleted is set to true
, then environments deleted after this date are displayed.
com.amazonaws.internal.SdkInternalList<T> environments
Returns an EnvironmentDescription list.
String applicationName
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.
String versionLabel
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.
String templateName
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.
String environmentId
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
String environmentName
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
String requestId
If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.
String severity
If specified, limits the events returned from this call to include only those with the specified severity or higher.
Date startTime
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.
Date endTime
If specified, AWS Elastic Beanstalk restricts the returned descriptions
to those that occur up to, but not including, the EndTime.
Integer maxRecords
Specifies the maximum number of events that can be returned, beginning with the most recent event.
String nextToken
Pagination token. If specified, the events return the next batch of results.
com.amazonaws.internal.SdkInternalList<T> events
A list of EventDescription.
String nextToken
If returned, this indicates that there are more results to obtain. Use this token in the next DescribeEvents call to get the next batch of events.
String environmentName
Specifies the AWS Elastic Beanstalk environment name.
String environmentId
Specifies the AWS Elastic Beanstalk environment ID.
com.amazonaws.internal.SdkInternalList<T> attributeNames
Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk only returns a list of instances.
String nextToken
Specifies the next token of the request.
com.amazonaws.internal.SdkInternalList<T> instanceHealthList
Contains the response body with information about the health of the instance.
Date refreshedAt
The date and time the information was last refreshed.
String nextToken
The next token.
String environmentName
The name of this environment.
String environmentId
The ID of this environment.
String applicationName
The name of the application associated with this environment.
String versionLabel
The application version deployed in this environment.
String solutionStackName
The name of the SolutionStack deployed with this
environment.
String templateName
The name of the configuration template used to originally launch this environment.
String description
Describes this environment.
String endpointURL
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
String cNAME
The URL to the CNAME for this environment.
Date dateCreated
The creation date for this environment.
Date dateUpdated
The last modified date for this environment.
String status
The current operational status of the environment:
Launching: Environment is in the process of initial
deployment.Updating: Environment is in the process of updating its
configuration settings or application version.Ready: Environment is available to have an action
performed on it, such as update or terminate.Terminating: Environment is in the shut-down process.Terminated: Environment is not running.Boolean abortableOperationInProgress
Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
true: There is an update in progress.
false: There are no updates currently in progress.
String health
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red: Indicates the environment is not responsive. Occurs
when three or more consecutive failures occur for an environment.Yellow: Indicates that something is wrong. Occurs when
two consecutive failures occur for an environment.Green: Indicates the environment is healthy and fully
functional.Grey: Default health for a new environment. The
environment is not fully launched and health checks have not started or
health checks are suspended during an UpdateEnvironment or
RestartEnvironement request.
Default: Grey
String healthStatus
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
EnvironmentResourcesDescription resources
The description of the AWS resources used by this environment.
EnvironmentTier tier
Describes the current tier of this environment.
com.amazonaws.internal.SdkInternalList<T> environmentLinks
A list of links to other environments in the same group.
String environmentName
The name of the environment.
com.amazonaws.internal.SdkInternalList<T> autoScalingGroups
The AutoScalingGroups used by this environment.
com.amazonaws.internal.SdkInternalList<T> instances
The Amazon EC2 instances used by this environment.
com.amazonaws.internal.SdkInternalList<T> launchConfigurations
The Auto Scaling launch configurations in use by this environment.
com.amazonaws.internal.SdkInternalList<T> loadBalancers
The LoadBalancers in use by this environment.
com.amazonaws.internal.SdkInternalList<T> triggers
The AutoScaling triggers in use by this environment.
com.amazonaws.internal.SdkInternalList<T> queues
The queues used by this environment.
LoadBalancerDescription loadBalancer
Describes the LoadBalancer.
Date eventDate
The date when the event occurred.
String message
The event message.
String applicationName
The application associated with the event.
String versionLabel
The release label for the application version associated with this event.
String templateName
The name of the configuration associated with this event.
String environmentName
The name of the environment associated with this event.
String requestId
The web service request ID for the activity of this event.
String severity
The severity level of this event.
String id
The ID of the Amazon EC2 instance.
Integer noData
Grey. AWS Elastic Beanstalk and the health agent are reporting no data on an instance.
Integer unknown
Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient amount of data on an instance.
Integer pending
Grey. An operation is in progress on an instance within the command timeout.
Integer ok
Green. An instance is passing health checks and the health agent is not reporting any problems.
Integer info
Green. An operation is in progress on an instance.
Integer warning
Yellow. The health agent is reporting a moderate number of request failures or other issues for an instance or environment.
Integer degraded
Red. The health agent is reporting a high number of request failures or other issues for an instance or environment.
Integer severe
Red. The health agent is reporting a very high number of request failures or other issues for an instance or environment.
Double p999
The average latency for the slowest 0.1 percent of requests over the last 10 seconds.
Double p99
The average latency for the slowest 1 percent of requests over the last 10 seconds.
Double p95
The average latency for the slowest 5 percent of requests over the last 10 seconds.
Double p90
The average latency for the slowest 10 percent of requests over the last 10 seconds.
Double p85
The average latency for the slowest 15 percent of requests over the last 10 seconds.
Double p75
The average latency for the slowest 25 percent of requests over the last 10 seconds.
Double p50
The average latency for the slowest 50 percent of requests over the last 10 seconds.
Double p10
The average latency for the slowest 90 percent of requests over the last 10 seconds.
String name
The name of the launch configuration.
com.amazonaws.internal.SdkInternalList<T> solutionStacks
A list of available solution stacks.
com.amazonaws.internal.SdkInternalList<T> solutionStackDetails
A list of available solution stacks and their SolutionStackDescription.
String name
The name of the LoadBalancer.
String loadBalancerName
The name of the LoadBalancer.
String domain
The domain name of the LoadBalancer.
com.amazonaws.internal.SdkInternalList<T> listeners
A list of Listeners used by the LoadBalancer.
String environmentId
The ID of the environment to rebuild.
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
String environmentName
The name of the environment to rebuild.
Condition: You must specify either this or an EnvironmentId, or both. If
you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
String environmentId
The ID of the environment of the requested data.
If no such environment is found, RequestEnvironmentInfo
returns an InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
String environmentName
The name of the environment of the requested data.
If no such environment is found, RequestEnvironmentInfo
returns an InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentId, or both. If
you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
String infoType
The type of information to request.
String environmentId
The ID of the environment to restart the server for.
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
String environmentName
The name of the environment to restart the server for.
Condition: You must specify either this or an EnvironmentId, or both. If
you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
String environmentId
The ID of the data's environment.
If no such environment is found, returns an
InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
String environmentName
The name of the data's environment.
If no such environment is found, returns an
InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentId, or both. If
you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
String infoType
The type of information to retrieve.
com.amazonaws.internal.SdkInternalList<T> environmentInfo
The EnvironmentInfoDescription of the environment.
String instanceId
The ID of the Amazon EC2 instance.
String healthStatus
Returns the health status of the specified instance. For more information, see Health Colors and Statuses.
String color
Represents the color indicator that gives you information about the health of the EC2 instance. For more information, see Health Colors and Statuses.
com.amazonaws.internal.SdkInternalList<T> causes
Represents the causes, which provide more information about the current health status.
Date launchedAt
The time at which the EC2 instance was launched.
ApplicationMetrics applicationMetrics
SystemStatus system
String solutionStackName
The name of the solution stack.
com.amazonaws.internal.SdkInternalList<T> permittedFileTypes
The permitted file types allowed for a solution stack.
Integer status2xx
The percentage of requests over the last 10 seconds that resulted in a 2xx (200, 201, etc.) status code.
Integer status3xx
The percentage of requests over the last 10 seconds that resulted in a 3xx (300, 301, etc.) status code.
Integer status4xx
The percentage of requests over the last 10 seconds that resulted in a 4xx (400, 401, etc.) status code.
Integer status5xx
The percentage of requests over the last 10 seconds that resulted in a 5xx (500, 501, etc.) status code.
String sourceEnvironmentId
The ID of the source environment.
Condition: You must specify at least the SourceEnvironmentID
or the SourceEnvironmentName. You may also specify both. If
you specify the SourceEnvironmentId, you must specify the
DestinationEnvironmentId.
String sourceEnvironmentName
The name of the source environment.
Condition: You must specify at least the SourceEnvironmentID
or the SourceEnvironmentName. You may also specify both. If
you specify the SourceEnvironmentName, you must specify the
DestinationEnvironmentName.
String destinationEnvironmentId
The ID of the destination environment.
Condition: You must specify at least the
DestinationEnvironmentID or the
DestinationEnvironmentName. You may also specify both. You
must specify the SourceEnvironmentId with the
DestinationEnvironmentId.
String destinationEnvironmentName
The name of the destination environment.
Condition: You must specify at least the
DestinationEnvironmentID or the
DestinationEnvironmentName. You may also specify both. You
must specify the SourceEnvironmentName with the
DestinationEnvironmentName.
CPUUtilization cPUUtilization
com.amazonaws.internal.SdkInternalList<T> loadAverage
Load average in the last 1-minute and 5-minute periods. For more information, see Operating System Metrics.
String environmentId
The ID of the environment to terminate.
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
String environmentName
The name of the environment to terminate.
Condition: You must specify either this or an EnvironmentId, or both. If
you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
Boolean terminateResources
Indicates whether the associated AWS resources should shut down when the environment is terminated:
true: 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
Boolean forceTerminate
Terminates the target environment even if another environment in the same group is dependent on it.
String environmentName
The name of this environment.
String environmentId
The ID of this environment.
String applicationName
The name of the application associated with this environment.
String versionLabel
The application version deployed in this environment.
String solutionStackName
The name of the SolutionStack deployed with this
environment.
String templateName
The name of the configuration template used to originally launch this environment.
String description
Describes this environment.
String endpointURL
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
String cNAME
The URL to the CNAME for this environment.
Date dateCreated
The creation date for this environment.
Date dateUpdated
The last modified date for this environment.
String status
The current operational status of the environment:
Launching: Environment is in the process of initial
deployment.Updating: Environment is in the process of updating its
configuration settings or application version.Ready: Environment is available to have an action
performed on it, such as update or terminate.Terminating: Environment is in the shut-down process.Terminated: Environment is not running.Boolean abortableOperationInProgress
Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
true: There is an update in progress.
false: There are no updates currently in progress.
String health
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red: Indicates the environment is not responsive. Occurs
when three or more consecutive failures occur for an environment.Yellow: Indicates that something is wrong. Occurs when
two consecutive failures occur for an environment.Green: Indicates the environment is healthy and fully
functional.Grey: Default health for a new environment. The
environment is not fully launched and health checks have not started or
health checks are suspended during an UpdateEnvironment or
RestartEnvironement request.
Default: Grey
String healthStatus
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
EnvironmentResourcesDescription resources
The description of the AWS resources used by this environment.
EnvironmentTier tier
Describes the current tier of this environment.
com.amazonaws.internal.SdkInternalList<T> environmentLinks
A list of links to other environments in the same group.
String name
The name of the trigger.
String applicationName
The name of the application to update. If no such application is found,
UpdateApplication returns an
InvalidParameterValue error.
String description
A new description for the application.
Default: If not specified, AWS Elastic Beanstalk does not update the description.
ApplicationDescription application
The ApplicationDescription of the application.
String applicationName
The name of the application associated with this version.
If no application is found with this name, UpdateApplication
returns an InvalidParameterValue error.
String versionLabel
The name of the version to update.
If no application version is found with this label,
UpdateApplication returns an
InvalidParameterValue error.
String description
A new description for this release.
ApplicationVersionDescription applicationVersion
The ApplicationVersionDescription of the application version.
String applicationName
The name of the application associated with the configuration template to update.
If no application is found with this name,
UpdateConfigurationTemplate returns an
InvalidParameterValue error.
String templateName
The name of the configuration template to update.
If no configuration template is found with this name,
UpdateConfigurationTemplate returns an
InvalidParameterValue error.
String description
A new description for the configuration.
com.amazonaws.internal.SdkInternalList<T> optionSettings
A list of configuration option settings to update with the new specified option value.
com.amazonaws.internal.SdkInternalList<T> optionsToRemove
A list of configuration options to remove from the configuration set.
Constraint: You can remove only UserDefined configuration
options.
String solutionStackName
The name of the solution stack this configuration set uses.
String applicationName
The name of the application associated with this configuration set.
String templateName
If not null, the name of the configuration template for this
configuration set.
String description
Describes this configuration set.
String environmentName
If not null, the name of the environment for this
configuration set.
String deploymentStatus
If this configuration set is associated with an environment, the
DeploymentStatus parameter indicates the deployment status
of this configuration set:
null: This configuration is not associated with a
running environment.pending: This is a draft configuration that is not
deployed to the associated environment but is in the process of
deploying.deployed: This is the configuration that is currently
deployed to the associated running environment.failed: This is a draft configuration that failed to
successfully deploy.Date dateCreated
The date (in UTC time) when this configuration set was created.
Date dateUpdated
The date (in UTC time) when this configuration set was last modified.
com.amazonaws.internal.SdkInternalList<T> optionSettings
A list of the configuration options and their values in this configuration set.
String applicationName
The name of the application with which the environment is associated.
String environmentId
The ID of the environment to update.
If no environment with this ID exists, AWS Elastic Beanstalk returns an
InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
String environmentName
The name of the environment to update. If no environment with this name
exists, AWS Elastic Beanstalk returns an
InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentId, or both. If
you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
String groupName
The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.
String description
If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
EnvironmentTier tier
This specifies the tier to use to update the environment.
Condition: At this time, if you change the tier version, name, or type,
AWS Elastic Beanstalk returns InvalidParameterValue error.
String versionLabel
If this parameter is specified, AWS Elastic Beanstalk deploys the named
application version to the environment. If no such application version is
found, returns an InvalidParameterValue error.
String templateName
If this parameter is specified, AWS Elastic Beanstalk deploys this
configuration template to the environment. If no such configuration
template is found, AWS Elastic Beanstalk returns an
InvalidParameterValue error.
String solutionStackName
This specifies the platform version that the environment will run after the environment is updated.
com.amazonaws.internal.SdkInternalList<T> optionSettings
If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
com.amazonaws.internal.SdkInternalList<T> optionsToRemove
A list of custom user-defined configuration options to remove from the configuration set for this environment.
String environmentName
The name of this environment.
String environmentId
The ID of this environment.
String applicationName
The name of the application associated with this environment.
String versionLabel
The application version deployed in this environment.
String solutionStackName
The name of the SolutionStack deployed with this
environment.
String templateName
The name of the configuration template used to originally launch this environment.
String description
Describes this environment.
String endpointURL
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
String cNAME
The URL to the CNAME for this environment.
Date dateCreated
The creation date for this environment.
Date dateUpdated
The last modified date for this environment.
String status
The current operational status of the environment:
Launching: Environment is in the process of initial
deployment.Updating: Environment is in the process of updating its
configuration settings or application version.Ready: Environment is available to have an action
performed on it, such as update or terminate.Terminating: Environment is in the shut-down process.Terminated: Environment is not running.Boolean abortableOperationInProgress
Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
true: There is an update in progress.
false: There are no updates currently in progress.
String health
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red: Indicates the environment is not responsive. Occurs
when three or more consecutive failures occur for an environment.Yellow: Indicates that something is wrong. Occurs when
two consecutive failures occur for an environment.Green: Indicates the environment is healthy and fully
functional.Grey: Default health for a new environment. The
environment is not fully launched and health checks have not started or
health checks are suspended during an UpdateEnvironment or
RestartEnvironement request.
Default: Grey
String healthStatus
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
EnvironmentResourcesDescription resources
The description of the AWS resources used by this environment.
EnvironmentTier tier
Describes the current tier of this environment.
com.amazonaws.internal.SdkInternalList<T> environmentLinks
A list of links to other environments in the same group.
String applicationName
The name of the application that the configuration template or environment belongs to.
String templateName
The name of the configuration template to validate the settings against.
Condition: You cannot specify both this and an environment name.
String environmentName
The name of the environment to validate the settings against.
Condition: You cannot specify both this and a configuration template name.
com.amazonaws.internal.SdkInternalList<T> optionSettings
A list of the options and desired values to evaluate.
com.amazonaws.internal.SdkInternalList<T> messages
A list of ValidationMessage.
String message
A message describing the error or warning.
String severity
An indication of the severity of this message:
error: This message indicates that this is not a valid
setting for an option.warning: This message is providing information you
should take into account.String namespace
String optionName
String errorCode
String creationToken
String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
String ownerId
The AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
String creationToken
Opaque string specified in the request.
String fileSystemId
The file system ID assigned by Amazon EFS.
Date creationTime
The time at which the file system was created, in seconds, since 1970-01-01T00:00:00Z.
String lifeCycleState
A predefined string value that indicates the lifecycle phase of the file system.
String name
You can add tags to a file system (see CreateTags) including a "Name" tag. If the file system has a "Name" tag, Amazon EFS returns the value in this field.
Integer numberOfMountTargets
The current number of mount targets (see CreateMountTarget) the file system has.
FileSystemSize sizeInBytes
This object provides the latest known metered size of data stored in the
file system, in bytes, in its Value field, and the time at
which that size was determined in its Timestamp field. The
Timestamp value is the integer number of seconds since
1970-01-01T00:00:00Z. Note that the value does not represent the size of
a consistent snapshot of the file system, but it is eventually consistent
when there are no writes to the file system. That is, the value will
represent actual size only if the file system is not modified for a
period longer than a couple of hours. Otherwise, the value is not the
exact size the file system was at any instant in time.
String fileSystemId
The ID of the file system for which to create the mount target.
String subnetId
The ID of the subnet to add the mount target in.
String ipAddress
A valid IPv4 address within the address range of the specified subnet.
com.amazonaws.internal.SdkInternalList<T> securityGroups
Up to 5 VPC security group IDs, of the form "sg-xxxxxxxx". These must be for the same VPC as subnet specified.
String ownerId
The AWS account ID that owns the resource.
String mountTargetId
The system-assigned mount target ID.
String fileSystemId
The ID of the file system for which the mount target is intended.
String subnetId
The ID of the subnet that the mount target is in.
String lifeCycleState
The lifecycle state the mount target is in.
String ipAddress
The address at which the file system may be mounted via the mount target.
String networkInterfaceId
The ID of the network interface that Amazon EFS created when it created the mount target.
String fileSystemId
String. The ID of the file system whose tags you want to modify. This operation modifies only the tags and not the file system.
com.amazonaws.internal.SdkInternalList<T> tags
An array of Tag objects to add. Each Tag object
is a key-value pair.
String fileSystemId
The ID of the file system you want to delete.
String mountTargetId
String. The ID of the mount target to delete.
String fileSystemId
String. The ID of the file system whose tags you want to delete.
com.amazonaws.internal.SdkInternalList<T> tagKeys
A list of tag keys to delete.
String errorCode
Integer maxItems
Optional integer. Specifies the maximum number of file systems to return
in the response. This parameter value must be greater than 0. The number
of items Amazon EFS returns will be the minimum of the
MaxItems parameter specified in the request and the
service's internal maximum number of items per page.
String marker
Optional string. Opaque pagination token returned from a previous
DescribeFileSystems operation. If present, specifies to
continue the list from where the returning call had left off.
String creationToken
Optional string. Restricts the list to the file system with this creation token (you specify a creation token at the time of creating an Amazon EFS file system).
String fileSystemId
Optional string. File system ID whose description you want to retrieve.
String marker
A string, present if provided by caller in the request.
com.amazonaws.internal.SdkInternalList<T> fileSystems
An array of file system descriptions.
String nextMarker
A string, present if there are more file systems than returned in the
response. You can use the NextMarker in the subsequent
request to fetch the descriptions.
String mountTargetId
The ID of the mount target whose security groups you want to retrieve.
com.amazonaws.internal.SdkInternalList<T> securityGroups
An array of security groups.
Integer maxItems
Optional. Maximum number of mount targets to return in the response. It must be an integer with a value greater than zero.
String marker
Optional. String. Opaque pagination token returned from a previous
DescribeMountTargets operation. If present, it specifies to
continue the list from where the previous returning call left off.
String fileSystemId
Optional. String. The ID of the file system whose mount targets you want
to list. It must be included in your request if
MountTargetId is not included.
String mountTargetId
Optional. String. The ID of the mount target that you want to have
described. It must be included in your request if
FileSystemId is not included.
String marker
If the request included the Marker, the response returns
that value in this field.
com.amazonaws.internal.SdkInternalList<T> mountTargets
Returns the file system's mount targets as an array of
MountTargetDescription objects.
String nextMarker
If a value is present, there are more mount targets to return. In a
subsequent request, you can provide Marker in your request
with this value to retrieve the next set of mount targets.
Integer maxItems
Optional. Maximum number of file system tags to return in the response. It must be an integer with a value greater than zero.
String marker
Optional. String. Opaque pagination token returned from a previous
DescribeTags operation. If present, it specifies to continue
the list from where the previous call left off.
String fileSystemId
The ID of the file system whose tag set you want to retrieve.
String marker
If the request included a Marker, the response returns that
value in this field.
com.amazonaws.internal.SdkInternalList<T> tags
Returns tags associated with the file system as an array of
Tag objects.
String nextMarker
If a value is present, there are more tags to return. In a subsequent
request, you can provide the value of NextMarker as the
value of the Marker parameter in your next request to
retrieve the next set of tags.
String ownerId
The AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
String creationToken
Opaque string specified in the request.
String fileSystemId
The file system ID assigned by Amazon EFS.
Date creationTime
The time at which the file system was created, in seconds, since 1970-01-01T00:00:00Z.
String lifeCycleState
A predefined string value that indicates the lifecycle phase of the file system.
String name
You can add tags to a file system (see CreateTags) including a "Name" tag. If the file system has a "Name" tag, Amazon EFS returns the value in this field.
Integer numberOfMountTargets
The current number of mount targets (see CreateMountTarget) the file system has.
FileSystemSize sizeInBytes
This object provides the latest known metered size of data stored in the
file system, in bytes, in its Value field, and the time at
which that size was determined in its Timestamp field. The
Timestamp value is the integer number of seconds since
1970-01-01T00:00:00Z. Note that the value does not represent the size of
a consistent snapshot of the file system, but it is eventually consistent
when there are no writes to the file system. That is, the value will
represent actual size only if the file system is not modified for a
period longer than a couple of hours. Otherwise, the value is not the
exact size the file system was at any instant in time.
String errorCode
String errorCode
String errorCode
String errorCode
String errorCode
String errorCode
String errorCode
String mountTargetId
The ID of the mount target whose security groups you want to modify.
com.amazonaws.internal.SdkInternalList<T> securityGroups
An array of up to five VPC security group IDs.
String errorCode
String ownerId
The AWS account ID that owns the resource.
String mountTargetId
The system-assigned mount target ID.
String fileSystemId
The ID of the file system for which the mount target is intended.
String subnetId
The ID of the subnet that the mount target is in.
String lifeCycleState
The lifecycle state the mount target is in.
String ipAddress
The address at which the file system may be mounted via the mount target.
String networkInterfaceId
The ID of the network interface that Amazon EFS created when it created the mount target.
String errorCode
String errorCode
String errorCode
String errorCode
String errorCode
String errorCode
String errorCode
Boolean enabled
String s3BucketName
Integer emitInterval
Default: 60 minutes
String s3BucketPrefix
my-bucket-prefix/prod. If the prefix is not
provided, the log is placed at the root level of the bucket.com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Constraints:
Length: 1 -
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
Integer instancePort
Constraints:
Range: 1 - 65535
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
String loadBalancerName
HealthCheck healthCheck
HealthCheck healthCheck
Integer idleTimeout
Constraints:
Range: 1 - 3600
String loadBalancerName
String policyName
String cookieName
String loadBalancerName
String policyName
Long cookieExpirationPeriod
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> listeners
String loadBalancerName
String policyName
String policyTypeName
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyAttributes
String loadBalancerName
This name must be unique within your set of load balancers for the region, must have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and cannot begin or end with a hyphen.
com.amazonaws.internal.ListWithAutoConstructFlag<T> listeners
For more information, see Listeners for Your Load Balancer in the Elastic Load Balancing Developer Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
You must specify at least one Availability Zone.
You can add more Availability Zones after you create the load balancer using EnableAvailabilityZonesForLoadBalancer.
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
AvailabilityZones.com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
String scheme
By default, Elastic Load Balancing creates an Internet-facing load balancer with a publicly resolvable DNS name, which resolves to public IP addresses. For more information about Internet-facing and Internal load balancers, see Internet-facing and Internal Load Balancers in the Elastic Load Balancing Developer Guide.
Specify internal to create an
internal load balancer with a DNS name that resolves to private IP
addresses.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
For more information about tagging your load balancer, see Tagging in the Elastic Load Balancing Developer Guide.
Constraints:
Length: 1 -
String dNSName
Boolean enabled
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerPorts
String loadBalancerName
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceStates
String loadBalancerName
LoadBalancerAttributes loadBalancerAttributes
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyDescriptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyTypeNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyTypeDescriptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
String marker
Integer pageSize
Constraints:
Range: 1 - 400
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerDescriptions
String nextMarker
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
Constraints:
Length: 1 - 20
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagDescriptions
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
String target
TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.
Integer interval
Constraints:
Range: 1 - 300
Integer timeout
This value must be less than the
Interval value.
Constraints:
Range: 1 - 300
Integer unhealthyThreshold
Unhealthy state.
Constraints:
Range: 2 - 10
Integer healthyThreshold
Healthy state.
Constraints:
Range: 2 - 10
String instanceId
String instanceId
String state
Valid values:
InService | OutOfService |
Unknown
String reasonCode
OutOfService instances.
Specifically, whether the cause is Elastic Load Balancing or the
instance. Valid values: ELB | Instance |
N/A
String description
N/A
A transient error occurred. Please try again
later.
Instance has failed at least the
UnhealthyThreshold number of health checks consecutively.
Instance has not passed the configured HealthyThreshold
number of health checks consecutively.
Instance registration is still in progress.
Instance is in the EC2 Availability Zone for which
LoadBalancer is not configured to route traffic to.
Instance is not currently registered with the
LoadBalancer.
Instance deregistration
currently in progress.
Disable Availability
Zone is currently in progress.
Instance is
in pending state.
Instance is in stopped
state.
Instance is in terminated
state.
String policyName
Long cookieExpirationPeriod
String protocol
Integer loadBalancerPort
String instanceProtocol
If the front-end protocol is HTTP, HTTPS, TCP,
or SSL, InstanceProtocol must be at the same protocol.
If there is another listener with the same
InstancePort whose InstanceProtocol is
secure, (HTTPS or SSL), the listener's InstanceProtocol
must also be secure.
If there is another listener with the same
InstancePort whose InstanceProtocol is HTTP
or TCP, the listener's InstanceProtocol must be HTTP or
TCP.
Integer instancePort
Constraints:
Range: 1 - 65535
String sSLCertificateId
Listener listener
For information about the protocols and the ports supported by Elastic Load Balancing, see Listener Configurations for Elastic Load Balancing in the Elastic Load Balancing Developer Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
CrossZoneLoadBalancing crossZoneLoadBalancing
For more information, see Enable Cross-Zone Load Balancing in the Elastic Load Balancing Developer Guide.
AccessLog accessLog
For more information, see Enable Access Logs in the Elastic Load Balancing Developer Guide.
ConnectionDraining connectionDraining
For more information, see Enable Connection Draining in the Elastic Load Balancing Developer Guide.
ConnectionSettings connectionSettings
By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. For more information, see Configure Idle Connection Timeout in the Elastic Load Balancing Developer Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> additionalAttributes
String loadBalancerName
String dNSName
String canonicalHostedZoneName
For more information, see Using Domain Names With Elastic Load Balancing in the Elastic Load Balancing Developer Guide.
String canonicalHostedZoneNameID
com.amazonaws.internal.ListWithAutoConstructFlag<T> listenerDescriptions
Policies policies
com.amazonaws.internal.ListWithAutoConstructFlag<T> backendServerDescriptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
String vPCId
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
HealthCheck healthCheck
SourceSecurityGroup sourceSecurityGroup
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
Date createdTime
String scheme
If Scheme is internet-facing, the load
balancer has a public DNS name that resolves to a public IP address.
If Scheme is internal, the load balancer
has a public DNS name that resolves to a private IP address.
String loadBalancerName
LoadBalancerAttributes loadBalancerAttributes
String loadBalancerName
LoadBalancerAttributes loadBalancerAttributes
com.amazonaws.internal.ListWithAutoConstructFlag<T> appCookieStickinessPolicies
com.amazonaws.internal.ListWithAutoConstructFlag<T> lBCookieStickinessPolicies
com.amazonaws.internal.ListWithAutoConstructFlag<T> otherPolicies
String attributeName
String attributeType
Boolean or
Integer.String description
String defaultValue
String cardinality
Valid values:
String policyName
String policyTypeName
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyAttributeDescriptions
String policyTypeName
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyAttributeTypeDescriptions
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Constraints:
Length: 1 -
String loadBalancerName
Integer instancePort
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
String loadBalancerName
Integer loadBalancerPort
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Constraints:
Length: 1 -
String key
Constraints:
Length: 1 - 128
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
com.amazonaws.internal.SdkInternalList<T> instanceGroups
Instance Groups to add.
String jobFlowId
Job flow in which to add the instance groups.
String jobFlowId
The job flow ID in which the instance groups are added.
com.amazonaws.internal.SdkInternalList<T> instanceGroupIds
Instance group IDs of the newly created instance groups.
String jobFlowId
A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow and can also be obtained from ListClusters.
com.amazonaws.internal.SdkInternalList<T> steps
A list of StepConfig to be executed by the job flow.
com.amazonaws.internal.SdkInternalList<T> stepIds
The identifiers of the list of steps added to the job flow.
String resourceId
The Amazon EMR resource identifier to which tags will be added. This value must be a cluster identifier.
com.amazonaws.internal.SdkInternalList<T> tags
A list of tags to associate with a cluster and propagate to Amazon EC2 instances. Tags are user-defined key/value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.
String name
The name of the application.
String version
The version of the application.
com.amazonaws.internal.SdkInternalList<T> args
Arguments for Amazon EMR to pass to the application.
com.amazonaws.internal.SdkInternalMap<K,V> additionalInfo
This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.
String name
The name of the bootstrap action.
ScriptBootstrapActionConfig scriptBootstrapAction
The script run by the bootstrap action.
BootstrapActionConfig bootstrapActionConfig
A description of the bootstrap action.
String id
The unique identifier for the cluster.
String name
The name of the cluster.
ClusterStatus status
The current status details about the cluster.
Ec2InstanceAttributes ec2InstanceAttributes
String logUri
The path to the Amazon S3 location where logs for this cluster are stored.
String requestedAmiVersion
The AMI version requested for this cluster.
String runningAmiVersion
The AMI version running on this cluster.
String releaseLabel
The release label for the Amazon EMR release. For Amazon EMR 3.x and 2.x AMIs, use amiVersion instead instead of ReleaseLabel.
Boolean autoTerminate
Specifies whether the cluster should terminate after completing all steps.
Boolean terminationProtected
Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.
Boolean visibleToAllUsers
Indicates whether the job flow is visible to all IAM users of the AWS
account associated with the job flow. If this value is set to
true, all IAM users of that AWS account can view and manage
the job flow if they have the proper policy permissions set. If this
value is false, only the IAM user that created the cluster
can view and manage it. This value can be changed using the
SetVisibleToAllUsers action.
com.amazonaws.internal.SdkInternalList<T> applications
The applications installed on this cluster.
com.amazonaws.internal.SdkInternalList<T> tags
A list of tags associated with a cluster.
String serviceRole
The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
Integer normalizedInstanceHours
An approximation of the cost of the job flow, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.
String masterPublicDnsName
The public DNS name of the master EC2 instance.
com.amazonaws.internal.SdkInternalList<T> configurations
Amazon EMR releases 4.x or later.
The list of Configurations supplied to the EMR cluster.
String state
The current state of the cluster.
ClusterStateChangeReason stateChangeReason
The reason for the cluster status change.
ClusterTimeline timeline
A timeline that represents the status of a cluster over the lifetime of the cluster.
String id
The unique identifier for the cluster.
String name
The name of the cluster.
ClusterStatus status
The details about the current status of the cluster.
Integer normalizedInstanceHours
An approximation of the cost of the job flow, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.
String name
The name of the command.
String scriptPath
The Amazon S3 location of the command script.
com.amazonaws.internal.SdkInternalList<T> args
Arguments for Amazon EMR to pass to the command for execution.
String classification
The classification of a configuration. For more information see, Amazon EMR Configurations.
com.amazonaws.internal.SdkInternalList<T> configurations
A list of configurations you apply to this configuration object.
com.amazonaws.internal.SdkInternalMap<K,V> properties
A set of properties supplied to the Configuration object.
String clusterId
The identifier of the cluster to describe.
Cluster cluster
This output contains the details for the requested cluster.
Date createdAfter
Return only job flows created after this date and time.
Date createdBefore
Return only job flows created before this date and time.
com.amazonaws.internal.SdkInternalList<T> jobFlowIds
Return only job flows whose job flow ID is contained in this list.
com.amazonaws.internal.SdkInternalList<T> jobFlowStates
Return only job flows whose state is contained in this list.
com.amazonaws.internal.SdkInternalList<T> jobFlows
A list of job flows matching the parameters supplied.
Step step
The step details for the requested step identifier.
String ec2KeyName
The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named "hadoop".
String ec2SubnetId
To launch the job flow in Amazon VPC, set this parameter to the identifier of the Amazon VPC subnet where you want the job flow to launch. If you do not specify this value, the job flow is launched in the normal AWS cloud, outside of a VPC.
Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus, you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a VPC.
String ec2AvailabilityZone
The Availability Zone in which the cluster will run.
String iamInstanceProfile
The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.
String emrManagedMasterSecurityGroup
The identifier of the Amazon EC2 security group for the master node.
String emrManagedSlaveSecurityGroup
The identifier of the Amazon EC2 security group for the slave nodes.
String serviceAccessSecurityGroup
The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
com.amazonaws.internal.SdkInternalList<T> additionalMasterSecurityGroups
A list of additional Amazon EC2 security group IDs for the master node.
com.amazonaws.internal.SdkInternalList<T> additionalSlaveSecurityGroups
A list of additional Amazon EC2 security group IDs for the slave nodes.
com.amazonaws.internal.SdkInternalList<T> properties
A list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.
String jar
A path to a JAR file run during the step.
String mainClass
The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class in its manifest file.
com.amazonaws.internal.SdkInternalList<T> args
A list of command line arguments passed to the JAR file's main function when executed.
String jar
The path to the JAR file that runs during the step.
com.amazonaws.internal.SdkInternalMap<K,V> properties
The list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.
String mainClass
The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file.
com.amazonaws.internal.SdkInternalList<T> args
The list of command line arguments to pass to the JAR file's main function for execution.
String id
The unique identifier for the instance in Amazon EMR.
String ec2InstanceId
The unique identifier of the instance in Amazon EC2.
String publicDnsName
The public DNS name of the instance.
String publicIpAddress
The public IP address of the instance.
String privateDnsName
The private DNS name of the instance.
String privateIpAddress
The private IP address of the instance.
InstanceStatus status
The current status of the instance.
String id
The identifier of the instance group.
String name
The name of the instance group.
String market
The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
String instanceGroupType
The type of the instance group. Valid values are MASTER, CORE or TASK.
String bidPrice
The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.
String instanceType
The EC2 instance type for all instances in the instance group.
Integer requestedInstanceCount
The target number of instances for the instance group.
Integer runningInstanceCount
The number of instances currently running in this instance group.
InstanceGroupStatus status
The current status of the instance group.
com.amazonaws.internal.SdkInternalList<T> configurations
Amazon EMR releases 4.x or later.
The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
String name
Friendly name given to the instance group.
String market
Market type of the Amazon EC2 instances used to create a cluster node.
String instanceRole
The role of the instance group in the cluster.
String bidPrice
Bid price for each Amazon EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.
String instanceType
The Amazon EC2 instance type for all instances in the instance group.
Integer instanceCount
Target number of instances for the instance group.
com.amazonaws.internal.SdkInternalList<T> configurations
Amazon EMR releases 4.x or later.
The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
String instanceGroupId
Unique identifier for the instance group.
String name
Friendly name for the instance group.
String market
Market type of the Amazon EC2 instances used to create a cluster node.
String instanceRole
Instance group role in the cluster
String bidPrice
Bid price for EC2 Instances when launching nodes as Spot Instances, expressed in USD.
String instanceType
Amazon EC2 Instance type.
Integer instanceRequestCount
Target number of instances to run in the instance group.
Integer instanceRunningCount
Actual count of running instances.
String state
State of instance group. The following values are deprecated: STARTING, TERMINATED, and FAILED.
String lastStateChangeReason
Details regarding the state of the instance group.
Date creationDateTime
The date/time the instance group was created.
Date startDateTime
The date/time the instance group was started.
Date readyDateTime
The date/time the instance group was available to the cluster.
Date endDateTime
The date/time the instance group was terminated.
String instanceGroupId
Unique ID of the instance group to expand or shrink.
Integer instanceCount
Target size for the instance group.
com.amazonaws.internal.SdkInternalList<T> eC2InstanceIdsToTerminate
The EC2 InstanceIds to terminate. For advanced users only. Once you terminate the instances, the instance group will not return to its original requested size.
String state
The current state of the instance group.
InstanceGroupStateChangeReason stateChangeReason
The status change reason details for the instance group.
InstanceGroupTimeline timeline
The timeline of the instance group status over time.
String state
The current state of the instance.
InstanceStateChangeReason stateChangeReason
The details of the status change reason for the instance.
InstanceTimeline timeline
The timeline of the instance status over time.
String errorCode
The error code associated with the exception.
String jobFlowId
The job flow identifier.
String name
The name of the job flow.
String logUri
The location in Amazon S3 where log files for the job are stored.
String amiVersion
The version of the AMI used to initialize Amazon EC2 instances in the job flow. For a list of AMI versions currently supported by Amazon ElasticMapReduce, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer Guide.
JobFlowExecutionStatusDetail executionStatusDetail
Describes the execution status of the job flow.
JobFlowInstancesDetail instances
Describes the Amazon EC2 instances of the job flow.
com.amazonaws.internal.SdkInternalList<T> steps
A list of steps run by the job flow.
com.amazonaws.internal.SdkInternalList<T> bootstrapActions
A list of the bootstrap actions run by the job flow.
com.amazonaws.internal.SdkInternalList<T> supportedProducts
A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.
Boolean visibleToAllUsers
Specifies whether the job flow is visible to all IAM users of the AWS
account associated with the job flow. If this value is set to
true, all IAM users of that AWS account can view and (if
they have the proper policy permissions set) manage the job flow. If it
is set to false, only the IAM user that created the job flow
can view and manage it. This value can be changed using the
SetVisibleToAllUsers action.
String jobFlowRole
The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.
String serviceRole
The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
String state
The state of the job flow.
Date creationDateTime
The creation date and time of the job flow.
Date startDateTime
The start date and time of the job flow.
Date readyDateTime
The date and time when the job flow was ready to start running bootstrap actions.
Date endDateTime
The completion date and time of the job flow.
String lastStateChangeReason
Description of the job flow last changed state.
String masterInstanceType
The EC2 instance type of the master node.
String slaveInstanceType
The EC2 instance type of the slave nodes.
Integer instanceCount
The number of Amazon EC2 instances used to execute the job flow.
com.amazonaws.internal.SdkInternalList<T> instanceGroups
Configuration for the job flow's instance groups.
String ec2KeyName
The name of the Amazon EC2 key pair that can be used to ssh to the master node as the user called "hadoop."
PlacementType placement
The Availability Zone the job flow will run in.
Boolean keepJobFlowAliveWhenNoSteps
Specifies whether the job flow should be kept alive after completing all steps.
Boolean terminationProtected
Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job flow error.
String hadoopVersion
The Hadoop version for the job flow. Valid inputs are "0.18" (deprecated), "0.20" (deprecated), "0.20.205" (deprecated), "1.0.3", "2.2.0", or "2.4.0". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.
String ec2SubnetId
To launch the job flow in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the job flow to launch. If you do not specify this value, the job flow is launched in the normal Amazon Web Services cloud, outside of an Amazon VPC.
Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a Amazon VPC.
String emrManagedMasterSecurityGroup
The identifier of the Amazon EC2 security group for the master node.
String emrManagedSlaveSecurityGroup
The identifier of the Amazon EC2 security group for the slave nodes.
String serviceAccessSecurityGroup
The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
com.amazonaws.internal.SdkInternalList<T> additionalMasterSecurityGroups
A list of additional Amazon EC2 security group IDs for the master node.
com.amazonaws.internal.SdkInternalList<T> additionalSlaveSecurityGroups
A list of additional Amazon EC2 security group IDs for the slave nodes.
String masterInstanceType
The Amazon EC2 master node instance type.
String masterPublicDnsName
The DNS name of the master node.
String masterInstanceId
The Amazon EC2 instance identifier of the master node.
String slaveInstanceType
The Amazon EC2 slave node instance type.
Integer instanceCount
The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and slave node. If the value is greater than 1, one instance is the master node and all others are slave nodes.
com.amazonaws.internal.SdkInternalList<T> instanceGroups
Details about the job flow's instance groups.
Integer normalizedInstanceHours
An approximation of the cost of the job flow, represented in m1.small/hours. This value is incremented once for every hour an m1.small runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.
String ec2KeyName
The name of an Amazon EC2 key pair that can be used to ssh to the master node of job flow.
String ec2SubnetId
For job flows launched within Amazon Virtual Private Cloud, this value specifies the identifier of the subnet where the job flow was launched.
PlacementType placement
The Amazon EC2 Availability Zone for the job flow.
Boolean keepJobFlowAliveWhenNoSteps
Specifies whether the job flow should terminate after completing all steps.
Boolean terminationProtected
Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job flow error.
String hadoopVersion
The Hadoop version for the job flow.
com.amazonaws.internal.SdkInternalList<T> bootstrapActions
The bootstrap actions associated with the cluster .
String marker
The pagination token that indicates the next set of results to retrieve .
Date createdAfter
The creation date and time beginning value filter for listing clusters .
Date createdBefore
The creation date and time end value filter for listing clusters .
com.amazonaws.internal.SdkInternalList<T> clusterStates
The cluster state filters to apply when listing clusters.
String marker
The pagination token that indicates the next set of results to retrieve.
com.amazonaws.internal.SdkInternalList<T> clusters
The list of clusters for the account based on the given filters.
String marker
The pagination token that indicates the next set of results to retrieve.
com.amazonaws.internal.SdkInternalList<T> instanceGroups
The list of instance groups for the cluster and given filters.
String marker
The pagination token that indicates the next set of results to retrieve.
String clusterId
The identifier of the cluster for which to list the instances.
String instanceGroupId
The identifier of the instance group for which to list the instances.
com.amazonaws.internal.SdkInternalList<T> instanceGroupTypes
The type of instance group for which to list the instances.
String marker
The pagination token that indicates the next set of results to retrieve.
com.amazonaws.internal.SdkInternalList<T> instances
The list of instances for the cluster and given filters.
String marker
The pagination token that indicates the next set of results to retrieve.
String clusterId
The identifier of the cluster for which to list the steps.
com.amazonaws.internal.SdkInternalList<T> stepStates
The filter to limit the step list based on certain states.
com.amazonaws.internal.SdkInternalList<T> stepIds
The filter to limit the step list based on the identifier of the steps.
String marker
The pagination token that indicates the next set of results to retrieve.
com.amazonaws.internal.SdkInternalList<T> steps
The filtered list of steps for the cluster.
String marker
The pagination token that indicates the next set of results to retrieve.
com.amazonaws.internal.SdkInternalList<T> instanceGroups
Instance groups to change.
String availabilityZone
The Amazon EC2 Availability Zone for the job flow.
String resourceId
The Amazon EMR resource identifier from which tags will be removed. This value must be a cluster identifier.
com.amazonaws.internal.SdkInternalList<T> tagKeys
A list of tag keys to remove from a resource.
String name
The name of the job flow.
String logUri
The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.
String additionalInfo
A JSON string for selecting additional features.
String amiVersion
For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use ReleaseLabel.
The version of the Amazon Machine Image (AMI) to use when launching Amazon EC2 instances in the job flow. The following values are valid:
If the AMI supports multiple versions of Hadoop (for example, AMI 1.0
supports both Hadoop 0.18 and 0.20) you can use the
JobFlowInstancesConfig HadoopVersion parameter to
modify the version of Hadoop from the defaults shown above.
For details about the AMI versions currently supported by Amazon Elastic MapReduce, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer's Guide.
String releaseLabel
Amazon EMR releases 4.x or later.
The release label for the Amazon EMR release. For Amazon EMR 3.x and 2.x AMIs, use amiVersion instead instead of ReleaseLabel.
JobFlowInstancesConfig instances
A specification of the number and type of Amazon EC2 instances on which to run the job flow.
com.amazonaws.internal.SdkInternalList<T> steps
A list of steps to be executed by the job flow.
com.amazonaws.internal.SdkInternalList<T> bootstrapActions
A list of bootstrap actions that will be run before Hadoop is started on the cluster nodes.
com.amazonaws.internal.SdkInternalList<T> supportedProducts
For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use Applications.
A list of strings that indicates third-party software to use with the job flow. For more information, go to Use Third Party Applications with Amazon EMR. Currently supported values are:
com.amazonaws.internal.SdkInternalList<T> newSupportedProducts
For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use Applications.
A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see Launch a Job Flow on the MapR Distribution for Hadoop. Currently supported values are:
com.amazonaws.internal.SdkInternalList<T> applications
Amazon EMR releases 4.x or later.
A list of applications for the cluster. Valid values are: "Hadoop", "Hive", "Mahout", "Pig", and "Spark." They are case insensitive.
com.amazonaws.internal.SdkInternalList<T> configurations
Amazon EMR releases 4.x or later.
The list of configurations supplied for the EMR cluster you are creating.
Boolean visibleToAllUsers
Whether the job flow is visible to all IAM users of the AWS account
associated with the job flow. If this value is set to true,
all IAM users of that AWS account can view and (if they have the proper
policy permissions set) manage the job flow. If it is set to
false, only the IAM user that created the job flow can view
and manage it.
String jobFlowRole
Also called instance profile and EC2 role. An IAM role for an EMR
cluster. The EC2 instances of the cluster assume this role. The default
role is EMR_EC2_DefaultRole. In order to use the default
role, you must have already created it using the CLI or console.
String serviceRole
The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
com.amazonaws.internal.SdkInternalList<T> tags
A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
String jobFlowId
An unique identifier for the job flow.
String path
Location of the script to run during a bootstrap action. Can be either a location in Amazon S3 or on a local file system.
com.amazonaws.internal.SdkInternalList<T> args
A list of command line arguments to pass to the bootstrap action script.
com.amazonaws.internal.SdkInternalList<T> jobFlowIds
A list of strings that uniquely identify the job flows to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .
Boolean terminationProtected
A Boolean that indicates whether to protect the job flow and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.
com.amazonaws.internal.SdkInternalList<T> jobFlowIds
Identifiers of the job flows to receive the new visibility setting.
Boolean visibleToAllUsers
Whether the specified job flows are visible to all IAM users of the AWS account associated with the job flow. If this value is set to True, all IAM users of that AWS account can view and, if they have the proper IAM policy permissions set, manage the job flows. If it is set to False, only the IAM user that created a job flow can view and manage it.
String id
The identifier of the cluster step.
String name
The name of the cluster step.
HadoopStepConfig config
The Hadoop job configuration of the cluster step.
String actionOnFailure
This specifies what action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE.
StepStatus status
The current execution status details of the cluster step.
String name
The name of the job flow step.
String actionOnFailure
The action to take if the job flow step fails.
HadoopJarStepConfig hadoopJarStep
The JAR file used for the job flow step.
StepConfig stepConfig
The step configuration.
StepExecutionStatusDetail executionStatusDetail
The description of the step status.
String state
The state of the job flow step.
Date creationDateTime
The creation date and time of the step.
Date startDateTime
The start date and time of the step.
Date endDateTime
The completion date and time of the step.
String lastStateChangeReason
A description of the step's current state.
String state
The execution state of the cluster step.
StepStateChangeReason stateChangeReason
The reason for the step execution status change.
StepTimeline timeline
The timeline of the cluster step status over time.
String id
The identifier of the cluster step.
String name
The name of the cluster step.
HadoopStepConfig config
The Hadoop job configuration of the cluster step.
String actionOnFailure
This specifies what action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE.
StepStatus status
The current execution status details of the cluster step.
String name
The name of the product configuration.
com.amazonaws.internal.SdkInternalList<T> args
The list of user-supplied arguments.
String key
A user-defined key, which is the minimum required information for a valid tag. For more information, see Tagging Amazon EMR Resources.
String value
A user-defined value, which is optional in a tag. For more information, see Tagging Amazon EMR Resources.
com.amazonaws.internal.SdkInternalList<T> jobFlowIds
A list of job flows to be shutdown.
String options
The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See Configuring Access Policiesfor more information.
OptionStatus status
The status of the access policy for the Elasticsearch domain. See
OptionStatus for the status information that's included.
Map<K,V> options
Specifies the status of advanced options for the specified Elasticsearch domain.
OptionStatus status
Specifies the status of OptionStatus for advanced options
for the specified Elasticsearch domain.
String domainName
The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
ElasticsearchClusterConfig elasticsearchClusterConfig
Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.
EBSOptions eBSOptions
Options to enable, disable and specify the type and size of EBS storage volumes.
String accessPolicies
IAM access policy as a JSON-formatted string.
SnapshotOptions snapshotOptions
Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.
Map<K,V> advancedOptions
Option to allow references to indices in an HTTP request body. Must be
false when configuring access to individual sub-resources.
By default, the value is true. See Configuration Advanced Options for more information.
ElasticsearchDomainStatus domainStatus
The status of the newly created Elasticsearch domain.
String domainName
The name of the Elasticsearch domain that you want to permanently delete.
ElasticsearchDomainStatus domainStatus
The status of the Elasticsearch domain being deleted.
String domainName
The Elasticsearch domain that you want to get information about.
ElasticsearchDomainConfig domainConfig
The configuration information of the domain requested in the
DescribeElasticsearchDomainConfig request.
String domainName
The name of the Elasticsearch domain for which you want information.
ElasticsearchDomainStatus domainStatus
The current status of the Elasticsearch domain.
String domainName
Specifies the DomainName.
Boolean eBSEnabled
Specifies whether EBS-based storage is enabled.
String volumeType
Specifies the volume type for EBS-based storage.
Integer volumeSize
Integer to specify the size of an EBS volume.
Integer iops
Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).
EBSOptions options
Specifies the EBS options for the specified Elasticsearch domain.
OptionStatus status
Specifies the status of the EBS options for the specified Elasticsearch domain.
String instanceType
The instance type for an Elasticsearch cluster.
Integer instanceCount
The number of instances in the specified domain cluster.
Boolean dedicatedMasterEnabled
A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.
Boolean zoneAwarenessEnabled
A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.
String dedicatedMasterType
The instance type for a dedicated master node.
Integer dedicatedMasterCount
Total number of dedicated master nodes, active and on standby, for the cluster.
ElasticsearchClusterConfig options
Specifies the cluster configuration for the specified Elasticsearch domain.
OptionStatus status
Specifies the status of the configuration for the specified Elasticsearch domain.
ElasticsearchClusterConfigStatus elasticsearchClusterConfig
Specifies the ElasticsearchClusterConfig for the
Elasticsearch domain.
EBSOptionsStatus eBSOptions
Specifies the EBSOptions for the Elasticsearch domain.
AccessPoliciesStatus accessPolicies
IAM access policy as a JSON-formatted string.
SnapshotOptionsStatus snapshotOptions
Specifies the SnapshotOptions for the Elasticsearch domain.
AdvancedOptionsStatus advancedOptions
Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.
String domainId
The unique identifier for the specified Elasticsearch domain.
String domainName
The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
String aRN
The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
Boolean created
The domain creation status. True if the creation of an
Elasticsearch domain is complete. False if domain creation
is still in progress.
Boolean deleted
The domain deletion status. True if a delete request has
been received for the domain but resource cleanup is still in progress.
False if the domain has not been deleted. Once domain
deletion is complete, the status of the domain is no longer returned.
String endpoint
The Elasticsearch domain endpoint that you use to submit index and search requests.
Boolean processing
The status of the Elasticsearch domain configuration. True
if Amazon Elasticsearch Service is processing configuration changes.
False if the configuration is active.
ElasticsearchClusterConfig elasticsearchClusterConfig
The type and number of instances in the domain cluster.
EBSOptions eBSOptions
The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.
String accessPolicies
IAM access policy as a JSON-formatted string.
SnapshotOptions snapshotOptions
Specifies the status of the SnapshotOptions
Map<K,V> advancedOptions
Specifies the status of the AdvancedOptions
String aRN
Specify the ARN for the Elasticsearch domain to which the
tags are attached that you want to view.
Date creationDate
Timestamp which tells the creation date for the entity.
Date updateDate
Timestamp which tells the last updated time for the entity.
Integer updateVersion
Specifies the latest version for the entity.
String state
Provides the OptionState for the Elasticsearch domain.
Boolean pendingDeletion
Indicates whether the Elasticsearch domain is being deleted.
Integer automatedSnapshotStartHour
Specifies the time, in UTC format, when the service takes a daily
automated snapshot of the specified Elasticsearch domain. Default value
is 0 hours.
SnapshotOptions options
Specifies the daily snapshot options specified for the Elasticsearch domain.
OptionStatus status
Specifies the status of a daily automated snapshot.
String key
Specifies the TagKey, the name of the tag. Tag keys must be
unique for the Elasticsearch domain to which they are attached.
String value
Specifies the TagValue, the value assigned to the
corresponding tag key. Tag values can be null and do not have to be
unique in a tag set. For example, you can have a key value pair in a tag
set of project : Trinity and
cost-center : Trinity
String domainName
The name of the Elasticsearch domain that you are updating.
ElasticsearchClusterConfig elasticsearchClusterConfig
The type and number of instances to instantiate for the domain cluster.
EBSOptions eBSOptions
Specify the type and size of the EBS volume that you want to use.
SnapshotOptions snapshotOptions
Option to set the time, in UTC format, for the daily automated snapshot.
Default value is 0 hours.
Map<K,V> advancedOptions
Modifies the advanced option to allow references to indices in an HTTP
request body. Must be false when configuring access to
individual sub-resources. By default, the value is true. See
Configuration Advanced Options for more information.
String accessPolicies
IAM access policy as a JSON-formatted string.
ElasticsearchDomainConfig domainConfig
The status of the updated Elasticsearch domain.
String inputKey
The name of the file to be used as album art. To determine which Amazon
S3 bucket contains the specified file, Elastic Transcoder checks the
pipeline specified by PipelineId; the
InputBucket object in that pipeline identifies the bucket.
If the file name includes a prefix, for example,
cooking/pie.jpg, include the prefix in the key. If the file
isn't in the specified bucket, Elastic Transcoder returns an error.
String maxWidth
The maximum width of the output album art in pixels. If you specify
auto, Elastic Transcoder uses 600 as the default value. If
you specify a numeric value, enter an even integer between 32 and 4096,
inclusive.
String maxHeight
The maximum height of the output album art in pixels. If you specify
auto, Elastic Transcoder uses 600 as the default value. If
you specify a numeric value, enter an even integer between 32 and 3072,
inclusive.
String sizingPolicy
Specify one of the following values to control scaling of the output album art:
Fit: Elastic Transcoder scales the output art so it
matches the value that you specified in either MaxWidth or
MaxHeight without exceeding the other value.Fill: Elastic Transcoder scales the output art so it
matches the value that you specified in either MaxWidth or
MaxHeight and matches or exceeds the other value. Elastic
Transcoder centers the output art and then crops it in the dimension (if
any) that exceeds the maximum value.Stretch: Elastic Transcoder stretches the output art to
match the values that you specified for MaxWidth and
MaxHeight. If the relative proportions of the input art and
the output art are different, the output art will be distorted.Keep: Elastic Transcoder does not scale the output art.
If either dimension of the input art exceeds the values that you
specified for MaxWidth and MaxHeight, Elastic
Transcoder crops the output art.ShrinkToFit: Elastic Transcoder scales the output art
down so that its dimensions match the values that you specified for at
least one of MaxWidth and MaxHeight without
exceeding either value. If you specify this option, Elastic Transcoder
does not scale the art up.ShrinkToFill Elastic Transcoder scales the output art
down so that its dimensions match the values that you specified for at
least one of MaxWidth and MaxHeight without
dropping below either value. If you specify this option, Elastic
Transcoder does not scale the art up.String paddingPolicy
When you set PaddingPolicy to Pad, Elastic
Transcoder may add white bars to the top and bottom and/or left and right
sides of the output album art to make the total size of the output art
match the values that you specified for MaxWidth and
MaxHeight.
String albumArtFormat
The format of album art, if any. Valid formats are .jpg and
.png.
Encryption encryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.
String profile
You can only choose an audio profile when you specify AAC for the value of Audio:Codec.
Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles:
auto: If you specify auto, Elastic
Transcoder will select the profile based on the bit rate selected for the
output file.AAC-LC: The most common AAC profile. Use for bit rates
larger than 64 kbps.HE-AAC: Not supported on some older players and devices.
Use for bit rates between 40 and 80 kbps.HE-AACv2: Not supported on some players and devices. Use
for bit rates less than 48 kbps.
All outputs in a Smooth playlist must have the same value
for Profile.
If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated your presets to use AAC-LC. You can change the value as required.
String bitDepth
You can only choose an audio bit depth when you specify flac
or pcm for the value of Audio:Codec.
The bit depth of a sample is how many bits of information are included in the audio samples. The higher the bit depth, the better the audio, but the larger the file.
Valid values are 16 and 24.
The most common bit depth is 24.
String bitOrder
You can only choose an audio bit order when you specify pcm
for the value of Audio:Codec.
The order the bits of a PCM sample are stored in.
The supported value is LittleEndian.
String signed
You can only choose whether an audio sample is signed when you specify
pcm for the value of Audio:Codec.
Whether audio samples are represented with negative and positive numbers (signed) or only positive numbers (unsigned).
The supported value is Signed.
String codec
The audio codec for the output file. Valid values include
aac, flac, mp2, mp3,
pcm, and vorbis.
String sampleRate
The sample rate of the audio stream in the output file, in Hertz. Valid values include:
auto, 22050, 32000,
44100, 48000, 96000
If you specify auto, Elastic Transcoder automatically
detects the sample rate.
String bitRate
The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 64 and 320, inclusive.
String channels
The number of audio channels in the output file. The following values are valid:
auto, 0, 1, 2
One channel carries the information played by a single speaker. For
example, a stereo track with two channels sends one channel to the left
speaker, and the other channel to the right speaker. The output channels
are organized into tracks. If you want Elastic Transcoder to
automatically detect the number of audio channels in the input file and
use that value for the output file, select auto.
The output of a specific channel value and inputs are as follows:
auto channel specified, with any input: Pass
through up to eight input channels.0 channels specified, with any input: Audio
omitted from the output.1 channel specified, with at least one input
channel: Mono sound.2 channels specified, with any input: Two
identical mono channels or stereo. For more information about tracks, see
Audio:AudioPackingMode.
For more information about how Elastic Transcoder organizes channels and
tracks, see Audio:AudioPackingMode.
String audioPackingMode
The method of organizing audio channels and tracks. Use
Audio:Channels to specify the number of channels in your
output, and Audio:AudioPackingMode to specify the number of
tracks and their relation to the channels. If you do not specify an
Audio:AudioPackingMode, Elastic Transcoder uses
SingleTrack.
The following values are valid:
SingleTrack, OneChannelPerTrack, and
OneChannelPerTrackWithMosTo8Tracks
When you specify SingleTrack, Elastic Transcoder creates a
single track for your output. The track can have up to eight channels.
Use SingleTrack for all non-mxf containers.
The outputs of SingleTrack for a specific channel value and
inputs are as follows:
0 channels with any input: Audio omitted from
the output1, 2, or auto channels with no audio input:
Audio omitted from the output1 channel with any input with audio: One track
with one channel, downmixed if necessary2 channels with one track with one channel: One
track with two identical channels2 or auto channels with two tracks with one channel
each: One track with two channels2 or auto channels with one track with two
channels: One track with two channels2 channels with one track with multiple
channels: One track with two channelsauto channels with one track with one channel:
One track with one channelauto channels with one track with multiple
channels: One track with multiple channels
When you specify OneChannelPerTrack, Elastic Transcoder
creates a new track for every channel in your output. Your output can
have up to eight single-channel tracks.
The outputs of OneChannelPerTrack for a specific channel
value and inputs are as follows:
0 channels with any input: Audio omitted from
the output1, 2, or auto channels with no audio input:
Audio omitted from the output1 channel with any input with audio: One track
with one channel, downmixed if necessary2 channels with one track with one channel: Two
tracks with one identical channel each2 or auto channels with two tracks with one channel
each: Two tracks with one channel each2 or auto channels with one track with two
channels: Two tracks with one channel each2 channels with one track with multiple
channels: Two tracks with one channel eachauto channels with one track with one channel:
One track with one channelauto channels with one track with multiple
channels: Up to eight tracks with one channel each
When you specify OneChannelPerTrackWithMosTo8Tracks, Elastic
Transcoder creates eight single-channel tracks for your output. All
tracks that do not contain audio data from an input channel are MOS, or
Mit Out Sound, tracks.
The outputs of OneChannelPerTrackWithMosTo8Tracks for a
specific channel value and inputs are as follows:
0 channels with any input: Audio omitted from
the output1, 2, or auto channels with no audio input:
Audio omitted from the output1 channel with any input with audio: One track
with one channel, downmixed if necessary, plus six MOS tracks2 channels with one track with one channel: Two
tracks with one identical channel each, plus six MOS tracks2 or auto channels with two tracks with one channel
each: Two tracks with one channel each, plus six MOS tracks2 or auto channels with one track with two
channels: Two tracks with one channel each, plus six MOS tracks2 channels with one track with multiple
channels: Two tracks with one channel each, plus six MOS tracksauto channels with one track with one channel:
One track with one channel, plus seven MOS tracksauto channels with one track with multiple
channels: Up to eight tracks with one channel each, plus MOS tracks
until there are eight tracks in allAudioCodecOptions codecOptions
If you specified AAC for Audio:Codec, this is
the AAC compression profile to use. Valid values include:
auto, AAC-LC, HE-AAC,
HE-AACv2
If you specify auto, Elastic Transcoder chooses a profile
based on the bit rate of the output file.
String id
The identifier of the job that you want to cancel.
To get a list of the jobs (including their jobId) that have
a status of Submitted, use the ListJobsByStatus API
action.
String format
The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.
Valid Embedded Caption Formats:
for FLAC: None
For MP3: None
For MP4: mov-text
For MPEG-TS: None
For ogg: None
For webm: None
Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
For FMP4: dfxp
Non-FMP4 outputs: All sidecar types
fmp4 captions have an extension of .ismt
String pattern
The prefix for caption filenames, in the form description-
{language}, where:
{language} is a literal value that Elastic Transcoder
replaces with the two- or three-letter code for the language of the
caption in the output file names.
If you don't include {language} in the file name
pattern, Elastic Transcoder automatically appends "
{language}" to the value that you specify for the
description. In addition, Elastic Transcoder automatically appends the
count to the end of the segment files.
For example, suppose you're transcoding into srt format. When you enter "Sydney-{language}-sunrise", and the language of the captions is English (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.
Encryption encryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats.
String mergePolicy
A policy that determines how Elastic Transcoder handles the existence of multiple captions.
MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.
MergeRetain: Elastic Transcoder transcodes both embedded and
sidecar captions into outputs. If captions for a language are embedded in
the input file and also appear in a sidecar file, Elastic Transcoder uses
the embedded captions and ignores the sidecar captions for that language.
If CaptionSources is empty, Elastic Transcoder omits all
sidecar captions from the output files.
Override: Elastic Transcoder transcodes only the sidecar captions
that you specify in CaptionSources.
MergePolicy cannot be null.
com.amazonaws.internal.SdkInternalList<T> captionSources
Source files for the input sidecar captions used during the transcoding
process. To omit all sidecar captions, leave CaptionSources
blank.
com.amazonaws.internal.SdkInternalList<T> captionFormats
The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.
String key
The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.
String language
A string that specifies the language of the caption. Specify this as one of:
2-character ISO 639-1 code
3-character ISO 639-2 code
For more information on ISO language codes and language names, see the List of ISO 639-1 codes.
String timeOffset
For clip generation or captions that do not start at the same time as the
associated video file, the TimeOffset tells Elastic
Transcoder how much of the video to encode before including captions.
Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
String label
The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.
Encryption encryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your caption sources.
TimeSpan timeSpan
Settings that determine when a clip begins and how long it lasts.
String key
The name to assign to the transcoded file. Elastic Transcoder saves the
file in the Amazon S3 bucket specified by the OutputBucket
object in the pipeline that is specified by the pipeline ID. If a file
with the specified name already exists in the output bucket, the job
fails.
String thumbnailPattern
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.
If you don't want Elastic Transcoder to create thumbnails, specify "".
If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
{count} (Required): If you want to create thumbnails,
you must include {count} in the
ThumbnailPattern object. Wherever you specify
{count}, Elastic Transcoder adds a five-digit sequence
number (beginning with 00001) to thumbnail file names. The number
indicates where a given thumbnail appears in the sequence of thumbnails
for a transcoded file.
{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.
Encryption thumbnailEncryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
String rotate
The number of degrees clockwise by which you want Elastic Transcoder to
rotate the output relative to the input. Enter one of the following
values: auto, 0, 90,
180, 270. The value auto generally
works only if the file that you're transcoding contains rotation
metadata.
String presetId
The Id of the preset to use for this job. The preset
determines the audio, video, and thumbnail settings that Elastic
Transcoder uses for transcoding.
String segmentDuration
PresetId for
which the value of Container is fmp4
(Fragmented MP4) or ts (MPEG-TS),
SegmentDuration is the target maximum duration of each
segment in seconds. For HLSv3 format playlists, each media
segment is stored in a separate .ts file. For
HLSv4 and Smooth playlists, all media segments
for an output are stored in a single file. Each segment is approximately
the length of the SegmentDuration, though individual
segments might be shorter or longer.
The range of valid values is 1 to 60 seconds. If the duration of the
video is not evenly divisible by SegmentDuration, the
duration of the last segment is the remainder of total
length/SegmentDuration.
Elastic Transcoder creates an output-specific playlist for each output
HLS output that you specify in OutputKeys. To add an output
to the master playlist for this job, include it in the
OutputKeys of the associated playlist.
com.amazonaws.internal.SdkInternalList<T> watermarks
Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset for the current output.
JobAlbumArt albumArt
Information about the album art that you want Elastic Transcoder to add to the file during transcoding. You can specify up to twenty album artworks for each output. Settings for each artwork must be defined in the job for the current output.
com.amazonaws.internal.SdkInternalList<T> composition
You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.
Captions captions
You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions:
Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.
Valid input values include: CEA-608 (EIA-608, first
non-empty channel only), CEA-708 (EIA-708, first non-empty
channel only), and mov-text
Valid outputs include: mov-text
Elastic Transcoder supports a maximum of one embedded format per output.
Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.
Valid input values include: dfxp (first div element only),
ebu-tt, scc, smpt,
srt, ttml (first div element only), and
webvtt
Valid outputs include: dfxp (first div element only),
scc, srt, and webvtt.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.
To remove captions or leave the captions empty, set Captions
to null. To pass through existing captions unchanged, set the
MergePolicy to MergeRetain, and pass in a null
CaptionSources array.
For more information on embedded files, see the Subtitles Wikipedia page.
For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.
Encryption encryption
You can specify encryption settings for any output files that you want to use for a transcoding job. This includes the output file and any watermarks, thumbnails, album art, or captions that you want to use. You must specify encryption settings for each file individually.
String name
The name that you want Elastic Transcoder to assign to the master
playlist, for example, nyc-vacation.m3u8. If the name includes a
/ character, the section of the name before the last
/ must be identical for all Name objects. If
you create more than one master playlist, the values of all
Name objects must be unique.
Note: Elastic Transcoder automatically appends the relevant file
extension to the file name (.m3u8 for HLSv3 and
HLSv4 playlists, and .ism and
.ismc for Smooth playlists). If you include a
file extension in Name, the file name will have two
extensions.
String format
The format of the output playlist. Valid formats include
HLSv3, HLSv4, and Smooth.
com.amazonaws.internal.SdkInternalList<T> outputKeys
For each output in this job that you want to include in a master
playlist, the value of the Outputs:Key object.
If your output is not HLS or does not have a segment
duration set, the name of the output file is a concatenation of
OutputKeyPrefix and Outputs:Key:
OutputKeyPrefixOutputs:Key
If your output is HLSv3 and has a segment duration set, or
is not included in a playlist, Elastic Transcoder creates an output
playlist file with a file extension of .m3u8, and a series
of .ts files that include a five-digit sequential counter
beginning with 00000:
OutputKeyPrefixOutputs:Key.m3u8
OutputKeyPrefixOutputs:Key00000.ts
If your output is HLSv4, has a segment duration set, and is
included in an HLSv4 playlist, Elastic Transcoder creates an
output playlist file with a file extension of _v4.m3u8. If
the output is video, Elastic Transcoder also creates an output file with
an extension of _iframe.m3u8:
OutputKeyPrefixOutputs:Key_v4.m3u8
OutputKeyPrefixOutputs:Key_iframe.m3u8
OutputKeyPrefixOutputs:Key.ts
Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.
If you include more than one output in a playlist, any segment duration
settings, clip settings, or caption settings must be the same for all
outputs in the playlist. For Smooth playlists, the
Audio:Profile, Video:Profile, and
Video:FrameRate to Video:KeyframesMaxDist ratio
must be the same for all outputs.
HlsContentProtection hlsContentProtection
The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
PlayReadyDrm playReadyDrm
The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
String pipelineId
The Id of the pipeline that you want Elastic Transcoder to
use for transcoding. The pipeline determines several settings, including
the Amazon S3 bucket from which Elastic Transcoder gets the files to
transcode and the bucket into which Elastic Transcoder puts the
transcoded files.
JobInput input
A section of the request body that provides information about the file that is being transcoded.
CreateJobOutput output
com.amazonaws.internal.SdkInternalList<T> outputs
A section of the request body that provides information about the
transcoded (target) files. We recommend that you use the
Outputs syntax instead of the Output syntax.
String outputKeyPrefix
The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists.
com.amazonaws.internal.SdkInternalList<T> playlists
If you specify a preset in PresetId for which the value of
Container is fmp4 (Fragmented MP4) or ts (MPEG-TS),
Playlists contains information about the master playlists that you want
Elastic Transcoder to create.
The maximum number of master playlists in a job is 30.
com.amazonaws.internal.SdkInternalMap<K,V> userMetadata
User-defined metadata that you want to associate with an Elastic
Transcoder job. You specify metadata in key/value pairs, and
you can add up to 10 key/value pairs per job. Elastic
Transcoder does not guarantee that key/value pairs will be
returned in the same order in which you specify them.
Job job
A section of the response body that provides information about the job that is created.
String name
The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.
Constraints: Maximum 40 characters.
String inputBucket
The Amazon S3 bucket in which you saved the media files that you want to transcode.
String outputBucket
The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.)
Specify this value when all of the following are true:
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.
String role
The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.
String awsKmsKeyArn
The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.
If you use either S3 or S3-AWS-KMS as your
Encryption:Mode, you don't need to provide a key with your
job because a default key, known as an AWS-KMS key, is created for you
automatically. You need to provide an AWS-KMS key only if you want to use
a non-default AWS-KMS key, or if you are using an
Encryption:Mode of AES-PKCS7,
AES-CTR, or AES-GCM.
Notifications notifications
The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
PipelineOutputConfig contentConfig
The optional ContentConfig object specifies information
about the Amazon S3 bucket in which you want Elastic Transcoder to save
transcoded files and playlists: which bucket to use, which users you want
to have access to the files, the type of access you want users to have,
and the storage class that you want to assign to the files.
If you specify values for ContentConfig, you must also
specify values for ThumbnailConfig.
If you specify values for ContentConfig and
ThumbnailConfig, omit the OutputBucket object.
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
The ThumbnailConfig object specifies several values,
including the Amazon S3 bucket in which you want Elastic Transcoder to
save thumbnail files, which users you want to have access to the files,
the type of access you want users to have, and the storage class that you
want to assign to the files.
If you specify values for ContentConfig, you must also
specify values for ThumbnailConfig even if you don't want to
create thumbnails.
If you specify values for ContentConfig and
ThumbnailConfig, omit the OutputBucket object.
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
A section of the response body that provides information about the pipeline that is created.
com.amazonaws.internal.SdkInternalList<T> warnings
Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline.
Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.
String name
The name of the preset. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.
String description
A description of the preset.
String container
The container type for the output file. Valid values include
flac, flv, fmp4, gif,
mp3, mp4, mpg, mxf,
oga, ogg, ts, and
webm.
VideoParameters video
A section of the request body that specifies the video parameters.
AudioParameters audio
A section of the request body that specifies the audio parameters.
Thumbnails thumbnails
A section of the request body that specifies the thumbnail parameters, if any.
Preset preset
A section of the response body that provides information about the preset that is created.
String warning
If the preset settings don't comply with the standards for the video codec but Elastic Transcoder created the preset, this message explains the reason the preset settings don't meet the standard. Elastic Transcoder created the preset because the settings might produce acceptable output.
String id
The identifier of the pipeline that you want to delete.
String id
The identifier of the preset for which you want to get detailed information.
Integer width
The detected width of the input file, in pixels.
Integer height
The detected height of the input file, in pixels.
String frameRate
The detected frame rate of the input file, in frames per second.
Long fileSize
The detected file size of the input file, in bytes.
Long durationMillis
The detected duration of the input file, in milliseconds.
String mode
The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting your input files or encrypting your output files. Elastic Transcoder supports the following options:
S3: Amazon S3 creates and manages the keys used for encrypting your files.
S3-AWS-KMS: Amazon S3 calls the Amazon Key Management Service,
which creates and manages the keys that are used for encrypting your
files. If you specify S3-AWS-KMS and you don't want to use
the default key, you must add the AWS-KMS key that you want to use to
your pipeline.
AES-CBC-PKCS7: A padded cipher-block mode of operation originally used for HLS files.
AES-CTR: AES Counter Mode.
AES-GCM: AES Galois Counter Mode, a mode of operation that is an authenticated encryption format, meaning that a file, key, or initialization vector that has been tampered with will fail the decryption process.
For all three AES options, you must provide the following settings, which must be base64-encoded:
Key
Key MD5
Initialization Vector
For the AES modes, your private encryption keys and your unencrypted data are never stored by AWS; therefore, it is important that you safely manage your encryption keys. If you lose them, you won't be able to unencrypt your data.
String key
The data encryption key that you want Elastic Transcoder to use to encrypt your output file, or that was used to encrypt your input file. The key must be base64-encoded and it must be one of the following bit lengths before being base64-encoded:
128, 192, or 256.
The key must also be encrypted by using the Amazon Key Management Service.
String keyMd5
The MD5 digest of the key that you used to encrypt your input file, or that you want Elastic Transcoder to use to encrypt your output file. Elastic Transcoder uses the key digest as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.
String initializationVector
The series of random bits created by a random bit generator, unique for every encryption operation, that you used to encrypt your input files or that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.
String method
The content protection method for your output. The only valid value is:
aes-128.
This value will be written into the method attribute of the
EXT-X-KEY metadata tag in the output playlist.
String key
If you want Elastic Transcoder to generate a key for you, leave this field blank.
If you choose to supply your own key, you must encrypt the key by using AWS KMS. The key must be base64-encoded, and it must be one of the following bit lengths before being base64-encoded:
128, 192, or 256.
String keyMd5
If Elastic Transcoder is generating your key for you, you must leave this field blank.
The MD5 digest of the key that you want Elastic Transcoder to use to encrypt your output file, and that you want Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes before being base64- encoded.
String initializationVector
If Elastic Transcoder is generating your key for you, you must leave this field blank.
The series of random bits created by a random bit generator, unique for every encryption operation, that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes before being base64-encoded.
String licenseAcquisitionUrl
The location of the license key required to decrypt your HLS playlist. The URL must be an absolute path, and is referenced in the URI attribute of the EXT-X-KEY metadata tag in the playlist file.
String keyStoragePolicy
Specify whether you want Elastic Transcoder to write your HLS license key
to an Amazon S3 bucket. If you choose WithVariantPlaylists,
LicenseAcquisitionUrl must be left blank and Elastic
Transcoder writes your data key into the same bucket as the associated
playlist.
String id
The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.
String arn
The Amazon Resource Name (ARN) for the job.
String pipelineId
The Id of the pipeline that you want Elastic Transcoder to
use for transcoding. The pipeline determines several settings, including
the Amazon S3 bucket from which Elastic Transcoder gets the files to
transcode and the bucket into which Elastic Transcoder puts the
transcoded files.
JobInput input
A section of the request or response body that provides information about the file that is being transcoded.
JobOutput output
If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.
com.amazonaws.internal.SdkInternalList<T> outputs
Information about the output files. We recommend that you use the
Outputs syntax for all jobs, even when you want Elastic
Transcoder to transcode a file into only one format. Do not use both the
Outputs and Output syntaxes in the same
request. You can create a maximum of 30 outputs per job.
If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.
String outputKeyPrefix
The value, if any, that you want Elastic Transcoder to prepend to the
names of all files that this job creates, including output files,
thumbnails, and playlists. We recommend that you add a / or some other
delimiter to the end of the OutputKeyPrefix.
com.amazonaws.internal.SdkInternalList<T> playlists
PresetId for
which the value of Container is fmp4 (Fragmented MP4) or ts
(MPEG-TS), Playlists contains information about the master
playlists that you want Elastic Transcoder to create.
The maximum number of master playlists in a job is 30.
String status
The status of the job: Submitted, Progressing,
Complete, Canceled, or Error.
com.amazonaws.internal.SdkInternalMap<K,V> userMetadata
User-defined metadata that you want to associate with an Elastic
Transcoder job. You specify metadata in key/value pairs, and
you can add up to 10 key/value pairs per job. Elastic
Transcoder does not guarantee that key/value pairs will be
returned in the same order in which you specify them.
Metadata keys and values must use characters
from the following list:
0-9
A-Z and a-z
Space
The following symbols: _.:/=+-%@
Timing timing
Details about the timing of a job.
String mergePolicy
A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.
Replace: The specified album art will replace any
existing album art.Prepend: The specified album art will be placed in front
of any existing album art.Append: The specified album art will be placed after any
existing album art.Fallback: If the original input file contains artwork,
Elastic Transcoder will use that artwork for the output. If the original
input does not contain artwork, Elastic Transcoder will use the specified
album art file.com.amazonaws.internal.SdkInternalList<T> artwork
The file to be used as album art. There can be multiple artworks
associated with an audio file, to a maximum of 20. Valid formats are
.jpg and .png
String key
The name of the file to transcode. Elsewhere in the body of the JSON
block is the the ID of the pipeline to use for processing the job. The
InputBucket object in that pipeline tells Elastic Transcoder
which Amazon S3 bucket to get the file from.
If the file name includes a prefix, such as
cooking/lasagna.mpg, include the prefix in the key. If the
file isn't in the specified bucket, Elastic Transcoder returns an error.
String frameRate
The frame rate of the input file. If you want Elastic Transcoder to
automatically detect the frame rate of the input file, specify
auto. If you want to specify the frame rate for the input
file, enter one of the following values:
10, 15, 23.97, 24,
25, 29.97, 30, 60
If you specify a value other than auto, Elastic Transcoder
disables automatic detection of the frame rate.
String resolution
This value must be auto, which causes Elastic Transcoder to
automatically detect the resolution of the input file.
String aspectRatio
The aspect ratio of the input file. If you want Elastic Transcoder to
automatically detect the aspect ratio of the input file, specify
auto. If you want to specify the aspect ratio for the output
file, enter one of the following values:
1:1, 4:3, 3:2, 16:9
If you specify a value other than auto, Elastic Transcoder
disables automatic detection of the aspect ratio.
String interlaced
Whether the input file is interlaced. If you want Elastic Transcoder to
automatically detect whether the input file is interlaced, specify
auto. If you want to specify whether the input file is
interlaced, enter one of the following values:
true, false
If you specify a value other than auto, Elastic Transcoder
disables automatic detection of interlacing.
String container
The container type for the input file. If you want Elastic Transcoder to
automatically detect the container type of the input file, specify
auto. If you want to specify the container type for the
input file, enter one of the following values:
3gp, aac, asf, avi,
divx, flv, m4a, mkv,
mov, mp3, mp4, mpeg,
mpeg-ps, mpeg-ts, mxf,
ogg, vob, wav, webm
Encryption encryption
The encryption settings, if any, that are used for decrypting your input files. If your input file is encrypted, you must specify the mode that Elastic Transcoder will use to decrypt your file.
DetectedProperties detectedProperties
The detected properties of the input file.
String id
A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the Output syntax, this value is always 1.
String key
The name to assign to the transcoded file. Elastic Transcoder saves the
file in the Amazon S3 bucket specified by the OutputBucket
object in the pipeline that is specified by the pipeline ID.
String thumbnailPattern
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.
If you don't want Elastic Transcoder to create thumbnails, specify "".
If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
{count} (Required): If you want to create thumbnails,
you must include {count} in the
ThumbnailPattern object. Wherever you specify
{count}, Elastic Transcoder adds a five-digit sequence
number (beginning with 00001) to thumbnail file names. The number
indicates where a given thumbnail appears in the sequence of thumbnails
for a transcoded file.
{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.
Encryption thumbnailEncryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
String rotate
The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values:
auto, 0, 90, 180,
270
The value auto generally works only if the file that you're
transcoding contains rotation metadata.
String presetId
The value of the Id object for the preset that you want to
use for this job. The preset determines the audio, video, and thumbnail
settings that Elastic Transcoder uses for transcoding. To use a preset
that you created, specify the preset ID that Elastic Transcoder returned
in the response when you created the preset. You can also use the Elastic
Transcoder system presets, which you can get with
ListPresets.
String segmentDuration
PresetId for
which the value of Container is fmp4
(Fragmented MP4) or ts (MPEG-TS),
SegmentDuration is the target maximum duration of each
segment in seconds. For HLSv3 format playlists, each media
segment is stored in a separate .ts file. For
HLSv4 and Smooth playlists, all media segments
for an output are stored in a single file. Each segment is approximately
the length of the SegmentDuration, though individual
segments might be shorter or longer.
The range of valid values is 1 to 60 seconds. If the duration of the
video is not evenly divisible by SegmentDuration, the
duration of the last segment is the remainder of total
length/SegmentDuration.
Elastic Transcoder creates an output-specific playlist for each output
HLS output that you specify in OutputKeys. To add an output
to the master playlist for this job, include it in the
OutputKeys of the associated playlist.
String status
The status of one output in a job. If you specified only one output for
the job, Outputs:Status is always the same as
Job:Status. If you specified more than one output:
Job:Status and Outputs:Status for all of
the outputs is Submitted until Elastic Transcoder starts to process the
first output.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.
String statusDetail
Information that further explains Status.
Long duration
Duration of the output file, in seconds.
Integer width
Specifies the width of the output file in pixels.
Integer height
Height of the output file, in pixels.
String frameRate
Frame rate of the output file, in frames per second.
Long fileSize
File size of the output file, in bytes.
Long durationMillis
Duration of the output file, in milliseconds.
com.amazonaws.internal.SdkInternalList<T> watermarks
Information about the watermarks that you want Elastic Transcoder to add
to the video during transcoding. You can specify up to four watermarks
for each output. Settings for each watermark must be defined in the
preset that you specify in Preset for the current output.
Watermarks are added to the output video in the sequence in which you list them in the job output—the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add will cover the first one, the third one will cover the second, and the fourth one will cover the third.
JobAlbumArt albumArt
The album art to be associated with the output file, if any.
com.amazonaws.internal.SdkInternalList<T> composition
You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.
Captions captions
You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions:
Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.
Valid input values include: CEA-608 (EIA-608, first
non-empty channel only), CEA-708 (EIA-708, first non-empty
channel only), and mov-text
Valid outputs include: mov-text
Elastic Transcoder supports a maximum of one embedded format per output.
Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.
Valid input values include: dfxp (first div element only),
ebu-tt, scc, smpt,
srt, ttml (first div element only), and
webvtt
Valid outputs include: dfxp (first div element only),
scc, srt, and webvtt.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.
To remove captions or leave the captions empty, set Captions
to null. To pass through existing captions unchanged, set the
MergePolicy to MergeRetain, and pass in a null
CaptionSources array.
For more information on embedded files, see the Subtitles Wikipedia page.
For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.
Encryption encryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your output files. If you choose to use encryption, you must specify a mode to use. If you choose not to use encryption, Elastic Transcoder will write an unencrypted file to your Amazon S3 bucket.
String appliedColorSpaceConversion
If Elastic Transcoder used a preset with a
ColorSpaceConversionMode to transcode the output file, the
AppliedColorSpaceConversion parameter shows the conversion
used. If no ColorSpaceConversionMode was defined in the
preset, this parameter will not be included in the job response.
String presetWatermarkId
The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding. The settings are in the preset specified by Preset for the current output. In that preset, the value of Watermarks Id tells Elastic Transcoder which settings to use.
String inputKey
The name of the .png or .jpg file that you want to use for the watermark.
To determine which Amazon S3 bucket contains the specified file, Elastic
Transcoder checks the pipeline specified by 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.
Encryption encryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your watermarks.
String pipelineId
The ID of the pipeline for which you want to get job information.
String ascending
To list jobs in chronological order by the date and time that they were
submitted, enter true. To list jobs in reverse chronological
order, enter false.
String pageToken
When Elastic Transcoder returns more than one page of results, use
pageToken in subsequent GET requests to get
each successive page of results.
com.amazonaws.internal.SdkInternalList<T> jobs
An array of Job objects that are in the specified pipeline.
String nextPageToken
A value that you use to access the second and subsequent pages of
results, if any. When the jobs in the specified pipeline fit on one page
or when you've reached the last page of results, the value of
NextPageToken is null.
String status
To get information about all of the jobs associated with the current AWS
account that have a given status, specify the following status:
Submitted, Progressing, Complete,
Canceled, or Error.
String ascending
To list jobs in chronological order by the date and time that they were
submitted, enter true. To list jobs in reverse chronological
order, enter false.
String pageToken
When Elastic Transcoder returns more than one page of results, use
pageToken in subsequent GET requests to get
each successive page of results.
com.amazonaws.internal.SdkInternalList<T> jobs
An array of Job objects that have the specified status.
String nextPageToken
A value that you use to access the second and subsequent pages of
results, if any. When the jobs in the specified pipeline fit on one page
or when you've reached the last page of results, the value of
NextPageToken is null.
String ascending
To list pipelines in chronological order by the date and time that they
were created, enter true. To list pipelines in reverse
chronological order, enter false.
String pageToken
When Elastic Transcoder returns more than one page of results, use
pageToken in subsequent GET requests to get
each successive page of results.
com.amazonaws.internal.SdkInternalList<T> pipelines
An array of Pipeline objects.
String nextPageToken
A value that you use to access the second and subsequent pages of
results, if any. When the pipelines fit on one page or when you've
reached the last page of results, the value of NextPageToken
is null.
String ascending
To list presets in chronological order by the date and time that they
were created, enter true. To list presets in reverse
chronological order, enter false.
String pageToken
When Elastic Transcoder returns more than one page of results, use
pageToken in subsequent GET requests to get
each successive page of results.
com.amazonaws.internal.SdkInternalList<T> presets
An array of Preset objects.
String nextPageToken
A value that you use to access the second and subsequent pages of
results, if any. When the presets fit on one page or when you've reached
the last page of results, the value of NextPageToken is
null.
String progressing
The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.
String completed
The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
String warning
The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
String error
The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.
String granteeType
The type of value that appears in the Grantee object:
Canonical: Either the canonical user ID for an AWS
account or an origin access identity for an Amazon CloudFront
distribution. Email: The registered email address of an AWS account.Group: One of the following predefined Amazon S3 groups:
AllUsers, AuthenticatedUsers, or
LogDelivery.String grantee
The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.
com.amazonaws.internal.SdkInternalList<T> access
The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:
READ: The grantee can read the thumbnails and metadata
for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP: The grantee can read the object ACL for
thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP: The grantee can write the ACL for the
thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL: The grantee has READ, READ_ACP, and
WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to
the Amazon S3 bucket.String id
The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.
String arn
The Amazon Resource Name (ARN) for the pipeline.
String name
The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.
Constraints: Maximum 40 characters
String status
The current status of the pipeline:
Active: The pipeline is processing jobs.Paused: The pipeline is not currently processing jobs.String inputBucket
The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks.
String outputBucket
The Amazon S3 bucket in which you want Elastic Transcoder to save
transcoded files, thumbnails, and playlists. Either you specify this
value, or you specify both ContentConfig and
ThumbnailConfig.
String role
The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.
String awsKmsKeyArn
The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.
If you use either S3 or S3-AWS-KMS as your
Encryption:Mode, you don't need to provide a key with your
job because a default key, known as an AWS-KMS key, is created for you
automatically. You need to provide an AWS-KMS key only if you want to use
a non-default AWS-KMS key, or if you are using an
Encryption:Mode of AES-PKCS7,
AES-CTR, or AES-GCM.
Notifications notifications
The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
PipelineOutputConfig contentConfig
Information about the Amazon S3 bucket in which you want Elastic
Transcoder to save transcoded files and playlists. Either you specify
both ContentConfig and ThumbnailConfig, or you
specify OutputBucket.
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
Information about the Amazon S3 bucket in which you want Elastic
Transcoder to save thumbnail files. Either you specify both
ContentConfig and ThumbnailConfig, or you
specify OutputBucket.
Bucket: The Amazon S3 bucket in which you want Elastic
Transcoder to save thumbnail files.Permissions: A list of the users and/or predefined
Amazon S3 groups you want to have access to thumbnail files, and the type
of access that you want them to have.
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
The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when all of the following are true:
ContentConfig and ThumbnailConfig instead.
String storageClass
The Amazon S3 storage class, Standard or
ReducedRedundancy, that you want Elastic Transcoder to
assign to the video files and playlists that it stores in your Amazon S3
bucket.
com.amazonaws.internal.SdkInternalList<T> permissions
Optional. The 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.
String name
The name that you want Elastic Transcoder to assign to the master
playlist, for example, nyc-vacation.m3u8. If the name includes a
/ character, the section of the name before the last
/ must be identical for all Name objects. If
you create more than one master playlist, the values of all
Name objects must be unique.
Note: Elastic Transcoder automatically appends the relevant file
extension to the file name (.m3u8 for HLSv3 and
HLSv4 playlists, and .ism and
.ismc for Smooth playlists). If you include a
file extension in Name, the file name will have two
extensions.
String format
The format of the output playlist. Valid formats include
HLSv3, HLSv4, and Smooth.
com.amazonaws.internal.SdkInternalList<T> outputKeys
For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.
If your output is not HLS or does not have a segment
duration set, the name of the output file is a concatenation of
OutputKeyPrefix and Outputs:Key:
OutputKeyPrefixOutputs:Key
If your output is HLSv3 and has a segment duration set, or
is not included in a playlist, Elastic Transcoder creates an output
playlist file with a file extension of .m3u8, and a series
of .ts files that include a five-digit sequential counter
beginning with 00000:
OutputKeyPrefixOutputs:Key.m3u8
OutputKeyPrefixOutputs:Key00000.ts
If your output is HLSv4, has a segment duration set, and is
included in an HLSv4 playlist, Elastic Transcoder creates an
output playlist file with a file extension of _v4.m3u8. If
the output is video, Elastic Transcoder also creates an output file with
an extension of _iframe.m3u8:
OutputKeyPrefixOutputs:Key_v4.m3u8
OutputKeyPrefixOutputs:Key_iframe.m3u8
OutputKeyPrefixOutputs:Key.ts
Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.
If you include more than one output in a playlist, any segment duration
settings, clip settings, or caption settings must be the same for all
outputs in the playlist. For Smooth playlists, the
Audio:Profile, Video:Profile, and
Video:FrameRate to Video:KeyframesMaxDist ratio
must be the same for all outputs.
HlsContentProtection hlsContentProtection
The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
PlayReadyDrm playReadyDrm
The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
String status
The status of the job with which the playlist is associated.
String statusDetail
Information that further explains the status.
String format
The type of DRM, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
String key
The DRM key for your file, provided by your DRM license provider. The key must be base64-encoded, and it must be one of the following bit lengths before being base64-encoded:
128, 192, or 256.
The key must also be encrypted by using AWS KMS.
String keyMd5
The MD5 digest of the key used for DRM on your file, and that you want Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes before being base64-encoded.
String keyId
The ID for your DRM key, so that your DRM license provider knows which key to provide.
The key ID must be provided in big endian, and Elastic Transcoder will convert it to little endian before inserting it into the PlayReady DRM headers. If you are unsure whether your license server provides your key ID in big or little endian, check with your DRM provider.
String initializationVector
The series of random bits created by a random bit generator, unique for every encryption operation, that you want Elastic Transcoder to use to encrypt your files. The initialization vector must be base64-encoded, and it must be exactly 8 bytes long before being base64-encoded. If no initialization vector is provided, Elastic Transcoder generates one for you.
String licenseAcquisitionUrl
The location of the license key required to play DRM content. The URL
must be an absolute path, and is referenced by the PlayReady header. The
PlayReady header is referenced in the protection header of the client
manifest for Smooth Streaming outputs, and in the EXT-X-DXDRM and
EXT-XDXDRMINFO metadata tags for HLS playlist outputs. An example URL
looks like this:
String id
Identifier for the new preset. You use this value to get settings for the preset or to delete it.
String arn
The Amazon Resource Name (ARN) for the preset.
String name
The name of the preset.
String description
A description of the preset.
String container
The container type for the output file. Valid values include
flac, flv, fmp4, gif,
mp3, mp4, mpg, mxf,
oga, ogg, ts, and
webm.
AudioParameters audio
A section of the response body that provides information about the audio preset values.
VideoParameters video
A section of the response body that provides information about the video preset values.
Thumbnails thumbnails
A section of the response body that provides information about the thumbnail preset values, if any.
String type
Whether the preset is a default preset provided by Elastic Transcoder (
System) or a preset that you have defined (
Custom).
String id
Id can be up to 40 characters long.String maxWidth
The maximum width of the watermark in one of the following formats:
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.
String maxHeight
The maximum height of the watermark in one of the following formats:
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.
String sizingPolicy
A value that controls scaling of the watermark:
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.String horizontalAlign
The horizontal position of the watermark unless you specify a non-zero
value for HorizontalOffset:
String horizontalOffset
The amount by which you want the horizontal position of the watermark to be offset from the position specified by HorizontalAlign:
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.
String verticalAlign
The vertical position of the watermark unless you specify a non-zero
value for VerticalOffset:
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.
String opacity
A percentage that indicates how much you want a watermark to obscure the
video in the location where it appears. Valid values are 0 (the watermark
is invisible) to 100 (the watermark completely obscures the video in the
specified location). The datatype of 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.
String target
A value that determines how Elastic Transcoder interprets values that you
specified for 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.
String id
The identifier of the job for which you want to get detailed information.
Job job
A section of the response body that provides information about the job.
String id
The identifier of the pipeline to read.
Pipeline pipeline
A section of the response body that provides information about the pipeline.
com.amazonaws.internal.SdkInternalList<T> warnings
Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline.
Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.
String id
The identifier of the preset for which you want to get detailed information.
Preset preset
A section of the response body that provides information about the preset.
String role
The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.
String inputBucket
The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket.
String outputBucket
The Amazon S3 bucket that Elastic Transcoder will write transcoded media files to. The action attempts to read from this bucket.
com.amazonaws.internal.SdkInternalList<T> topics
The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.
String success
If the operation is successful, this value is true;
otherwise, the value is false.
com.amazonaws.internal.SdkInternalList<T> messages
If the Success element contains false, this
value is an array of one or more error messages that were generated
during the test process.
String format
The format of thumbnails, if any. Valid values are jpg and
png.
You specify whether you want Elastic Transcoder to create thumbnails when you create a job.
String interval
The approximate number of seconds between thumbnails. Specify an integer value.
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.
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.
String maxWidth
The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 4096.
String maxHeight
The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 3072.
String sizingPolicy
Specify one of the following values to control scaling of thumbnails:
Fit: Elastic Transcoder scales thumbnails so they match
the value that you specified in thumbnail MaxWidth or MaxHeight settings
without exceeding the other value.Fill: Elastic Transcoder scales thumbnails so they match
the value that you specified in thumbnail MaxWidth or
MaxHeight settings and matches or exceeds the other value.
Elastic Transcoder centers the image in thumbnails and then crops in the
dimension (if any) that exceeds the maximum value.Stretch: Elastic Transcoder stretches thumbnails to
match the values that you specified for thumbnail MaxWidth
and MaxHeight settings. If the relative proportions of the
input video and thumbnails are different, the thumbnails will be
distorted.Keep: Elastic Transcoder does not scale thumbnails. If
either dimension of the input video exceeds the values that you specified
for thumbnail MaxWidth and MaxHeight settings,
Elastic Transcoder crops the thumbnails.ShrinkToFit: Elastic Transcoder scales thumbnails down
so that their dimensions match the values that you specified for at least
one of thumbnail MaxWidth and MaxHeight without
exceeding either value. If you specify this option, Elastic Transcoder
does not scale thumbnails up.ShrinkToFill: Elastic Transcoder scales thumbnails down
so that their dimensions match the values that you specified for at least
one of MaxWidth and MaxHeight without dropping
below either value. If you specify this option, Elastic Transcoder does
not scale thumbnails up.String paddingPolicy
When you set PaddingPolicy to Pad, Elastic
Transcoder may add black bars to the top and bottom and/or left and right
sides of thumbnails to make the total size of the thumbnails match the
values that you specified for thumbnail MaxWidth and
MaxHeight settings.
String startTime
The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.
String duration
The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder creates an output file from StartTime to the end of the file.
If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes the file and returns a warning message.
Long submitTimeMillis
The time the job was submitted to Elastic Transcoder, in epoch milliseconds.
Long startTimeMillis
The time the job began transcoding, in epoch milliseconds.
Long finishTimeMillis
The time the job finished transcoding, in epoch milliseconds.
String id
The identifier of the pipeline for which you want to change notification settings.
Notifications notifications
The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
Pipeline pipeline
A section of the response body that provides information about the pipeline.
String id
The ID of the pipeline that you want to update.
String name
The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.
Constraints: Maximum 40 characters
String inputBucket
The Amazon S3 bucket in which you saved the media files that you want to transcode and the graphics that you want to use as watermarks.
String role
The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode jobs for this pipeline.
String awsKmsKeyArn
The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.
If you use either S3 or S3-AWS-KMS as your
Encryption:Mode, you don't need to provide a key with your
job because a default key, known as an AWS-KMS key, is created for you
automatically. You need to provide an AWS-KMS key only if you want to use
a non-default AWS-KMS key, or if you are using an
Encryption:Mode of AES-PKCS7,
AES-CTR, or AES-GCM.
Notifications notifications
PipelineOutputConfig contentConfig
The optional ContentConfig object specifies information
about the Amazon S3 bucket in which you want Elastic Transcoder to save
transcoded files and playlists: which bucket to use, which users you want
to have access to the files, the type of access you want users to have,
and the storage class that you want to assign to the files.
If you specify values for ContentConfig, you must also
specify values for ThumbnailConfig.
If you specify values for ContentConfig and
ThumbnailConfig, omit the OutputBucket object.
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
The ThumbnailConfig object specifies several values,
including the Amazon S3 bucket in which you want Elastic Transcoder to
save thumbnail files, which users you want to have access to the files,
the type of access you want users to have, and the storage class that you
want to assign to the files.
If you specify values for ContentConfig, you must also
specify values for ThumbnailConfig even if you don't want to
create thumbnails.
If you specify values for ContentConfig and
ThumbnailConfig, omit the OutputBucket object.
Permissions object
specifies which users and/or predefined Amazon S3 groups you want to have
access to thumbnail files, and the type of access you want them to have.
You can grant permissions to a maximum of 30 users and/or predefined
Amazon S3 groups.Grantee object is
either the canonical user ID for an AWS account or an origin access
identity for an Amazon CloudFront distribution. Grantee object is the
registered email address of an AWS account.Grantee object is one of
the following predefined Amazon S3 groups: AllUsers,
AuthenticatedUsers, or LogDelivery.Grantee. Permissions are granted on
the thumbnail files that Elastic Transcoder adds to the bucket. Valid
values include:
READ: The grantee can read the thumbnails and metadata
for objects that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP: The grantee can read the object ACL for
thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP: The grantee can write the ACL for the
thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL: The grantee has READ,
READ_ACP, and WRITE_ACP permissions for the
thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.Standard or ReducedRedundancy, that you want
Elastic Transcoder to assign to the thumbnails that it stores in your
Amazon S3 bucket.Pipeline pipeline
com.amazonaws.internal.SdkInternalList<T> warnings
Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline.
Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.
Pipeline pipeline
A section of the response body that provides information about the pipeline.
String codec
The video codec for the output file. Valid values include
gif, H.264, mpeg2, and
vp8. You can only specify vp8 when the
container type is webm, gif when the container
type is gif, and mpeg2 when the container type
is mpg.
com.amazonaws.internal.SdkInternalMap<K,V> codecOptions
Profile (H.264/VP8 Only)
The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following profiles:
baseline: The profile most commonly used for
videoconferencing and for mobile applications.main: The profile used for standard-definition digital
TV broadcasts.high: The profile used for high-definition digital TV
broadcasts and for Blu-ray discs.Level (H.264 Only)
The H.264 level that you want to use for the output file. Elastic Transcoder supports the following levels:
1, 1b, 1.1, 1.2,
1.3, 2, 2.1, 2.2,
3, 3.1, 3.2, 4,
4.1
MaxReferenceFrames (H.264 Only)
Applicable only when the value of Video:Codec is H.264. The maximum number of previously decoded frames to use as a reference for decoding future frames. Valid values are integers 0 through 16, but we recommend that you not use a value greater than the following:
Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels * Height in pixels)), 16)
where Width in pixels and Height in pixels represent either
MaxWidth and MaxHeight, or Resolution. Maximum decoded picture buffer
in macroblocks depends on the value of the Level object.
See the list below. (A macroblock is a block of pixels measuring 16x16.)
MaxBitRate (Optional, H.264/MPEG2/VP8 only)
The maximum number of bits per second in a video buffer; the size of the
buffer is specified by BufferSize. Specify a value between
16 and 62,500. You can reduce the bandwidth required to stream a video by
reducing the maximum bit rate, but this also reduces the quality of the
video.
BufferSize (Optional, H.264/MPEG2/VP8 only)
The maximum number of bits in any x seconds of the output video. This
window is commonly 10 seconds, the standard segment duration when you're
using FMP4 or MPEG-TS for the container type of the output video. Specify
an integer greater than 0. If you specify MaxBitRate and
omit BufferSize, Elastic Transcoder sets
BufferSize to 10 times the value of MaxBitRate.
InterlacedMode (Optional, H.264/MPEG2 Only)
The interlace mode for the output video.
Interlaced video is used to double the perceived frame rate for a video by interlacing two fields (one field on every other line, the other field on the other lines) so that the human eye registers multiple pictures per frame. Interlacing reduces the bandwidth required for transmitting a video, but can result in blurred images and flickering.
Valid values include Progressive (no interlacing, top to
bottom), TopFirst (top field first),
BottomFirst (bottom field first), and Auto.
If InterlaceMode is not specified, Elastic Transcoder uses
Progressive for the output. If Auto is
specified, Elastic Transcoder interlaces the output.
ColorSpaceConversionMode (Optional, H.264/MPEG2 Only)
The color space conversion Elastic Transcoder applies to the output
video. Color spaces are the algorithms used by the computer to store
information about how to render color. Bt.601 is the
standard for standard definition video, while Bt.709 is the
standard for high definition video.
Valid values include None, Bt709toBt601,
Bt601toBt709, and Auto.
If you chose Auto for ColorSpaceConversionMode
and your output is interlaced, your frame rate is one of
23.97, 24, 25, 29.97,
50, or 60, your SegmentDuration is
null, and you are using one of the resolution changes from the list
below, Elastic Transcoder applies the following color space conversions:
Bt601ToBt709Bt601ToBt709Bt709ToBt601Bt709ToBt601ColorspaceConversionMode Auto mode in the
future. All outputs in a playlist must use the same
ColorSpaceConversionMode.
If you do not specify a ColorSpaceConversionMode, Elastic
Transcoder does not change the color space of a file. If you are unsure
what ColorSpaceConversionMode was applied to your output
file, you can check the AppliedColorSpaceConversion
parameter included in your job response. If your job does not have an
AppliedColorSpaceConversion in its response, no
ColorSpaceConversionMode was applied.
ChromaSubsampling
The sampling pattern for the chroma (color) channels of the output video.
Valid values include yuv420p and yuv422p.
yuv420p samples the chroma information of every other
horizontal and every other vertical line, yuv422p samples
the color information of every horizontal line and every other vertical
line.
LoopCount (Gif Only)
The number of times you want the output gif to loop. Valid values include
Infinite and integers between 0 and
100, inclusive.
String keyframesMaxDist
Applicable only when the value of Video:Codec is one of
H.264, MPEG2, or VP8.
The maximum number of frames between key frames. Key frames are fully encoded frames; the frames between key frames are encoded based, in part, on the content of the key frames. The value is an integer formatted as a string; valid values are between 1 (every frame is a key frame) and 100000, inclusive. A higher value results in higher compression but may also discernibly decrease video quality.
For Smooth outputs, the FrameRate must have a
constant ratio to the KeyframesMaxDist. This allows
Smooth playlists to switch between different quality levels
while the file is being played.
For example, an input file can have a FrameRate of 30 with a
KeyframesMaxDist of 90. The output file then needs to have a
ratio of 1:3. Valid outputs would have FrameRate of 30, 25,
and 10, and KeyframesMaxDist of 90, 75, and 30,
respectively.
Alternately, this can be achieved by setting FrameRate to
auto and having the same values for MaxFrameRate and
KeyframesMaxDist.
String fixedGOP
Applicable only when the value of Video:Codec is one of
H.264, MPEG2, or VP8.
Whether to use a fixed value for FixedGOP. Valid values are
true and false:
true: Elastic Transcoder uses the value of
KeyframesMaxDist for the distance between key frames (the
number of frames in a group of pictures, or GOP).false: The distance between key frames can vary.
FixedGOP must be set to true for
fmp4 containers.
String bitRate
The bit rate of the video stream in the output file, in kilobits/second.
Valid values depend on the values of Level and
Profile. If you specify auto, Elastic
Transcoder uses the detected bit rate of the input source. If you specify
a value other than auto, we recommend that you specify a
value less than or equal to the maximum H.264-compliant value listed for
your level and profile:
Level - Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum video bit rate in kilobits/second (high Profile)
String frameRate
The frames per second for the video stream in the output file. Valid values include:
auto, 10, 15, 23.97,
24, 25, 29.97, 30,
60
If you specify auto, Elastic Transcoder uses the detected
frame rate of the input source. If you specify a frame rate, we recommend
that you perform the following calculation:
Frame rate = maximum recommended decoding speed in luma samples/second / (width in pixels * height in pixels)
where:
The maximum recommended decoding speed in Luma samples/second for each level is described in the following list (Level - Decoding speed):
String maxFrameRate
If you specify 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.
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:
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.
String maxWidth
The maximum width of the output video in pixels. If you specify
auto, Elastic Transcoder uses 1920 (Full HD) as the default
value. If you specify a numeric value, enter an even integer between 128
and 4096.
String maxHeight
The maximum height of the output video in pixels. If you specify
auto, Elastic Transcoder uses 1080 (Full HD) as the default
value. If you specify a numeric value, enter an even integer between 96
and 3072.
String displayAspectRatio
The value that Elastic Transcoder adds to the metadata in the output file.
String sizingPolicy
Specify one of the following values to control scaling of the output video:
Fit: Elastic Transcoder scales the output video so it
matches the value that you specified in either MaxWidth or
MaxHeight without exceeding the other value.Fill: Elastic Transcoder scales the output video so it
matches the value that you specified in either MaxWidth or
MaxHeight and matches or exceeds the other value. Elastic
Transcoder centers the output video and then crops it in the dimension
(if any) that exceeds the maximum value.Stretch: Elastic Transcoder stretches the output video
to match the values that you specified for MaxWidth and
MaxHeight. If the relative proportions of the input video
and the output video are different, the output video will be distorted.Keep: Elastic Transcoder does not scale the output
video. If either dimension of the input video exceeds the values that you
specified for MaxWidth and MaxHeight, Elastic
Transcoder crops the output video.ShrinkToFit: Elastic Transcoder scales the output video
down so that its dimensions match the values that you specified for at
least one of MaxWidth and MaxHeight without
exceeding either value. If you specify this option, Elastic Transcoder
does not scale the video up.ShrinkToFill: Elastic Transcoder scales the output video
down so that its dimensions match the values that you specified for at
least one of MaxWidth and MaxHeight without
dropping below either value. If you specify this option, Elastic
Transcoder does not scale the video up.String paddingPolicy
When you set PaddingPolicy to Pad, Elastic
Transcoder may add black bars to the top and bottom and/or left and right
sides of the output video to make the total size of the output video
match the values that you specified for MaxWidth and
MaxHeight.
com.amazonaws.internal.SdkInternalList<T> watermarks
Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay over videos that are transcoded using this preset. You can specify settings for up to four watermarks. Watermarks appear in the specified size and location, and with the specified opacity for the duration of the transcoded video.
Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.
When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions.
String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String uploadId
String accountId
AccountId value is the AWS account ID. This value
must match the AWS account ID associated with the credentials used to
sign the request. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you specify your account ID, do not include
any hyphens ('-') in the ID.String vaultName
String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
Map<K,V> tags
String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String uploadId
String archiveSize
String checksum
String accountId
AccountId value is the AWS account ID. This value
must match the AWS account ID associated with the credentials used to
sign the request. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you specify your account ID, do not include
any hyphens ('-') in the ID.String vaultName
String lockId
lockId value is the lock ID obtained from a
InitiateVaultLock request.String accountId
AccountId value is the AWS account ID. This value
must match the AWS account ID associated with the credentials used to
sign the request. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you specify your account ID, do not include
any hyphens ('-') in the ID.String vaultName
String location
com.amazonaws.internal.ListWithAutoConstructFlag<T> rules
String strategy
Valid values: BytesPerHour|FreeTier|None
Long bytesPerHour
This
field is required only if the value of the Strategy field is
BytesPerHour. Your PUT operation will be rejected if the
Strategy field is not set to BytesPerHour and you set
this field.
String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String archiveId
String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String jobId
String jobId
String jobDescription
String action
Constraints:
Allowed Values: ArchiveRetrieval, InventoryRetrieval
String archiveId
String vaultARN
String creationDate
Boolean completed
String statusCode
Constraints:
Allowed Values: InProgress, Succeeded, Failed
String statusMessage
Long archiveSizeInBytes
Long inventorySizeInBytes
String sNSTopic
String completionDate
String sHA256TreeHash
The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.
For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.
This field is null in the following situations:
Archive retrieval jobs that specify a range that is not tree-hash aligned.
Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.
Inventory jobs.
String archiveSHA256TreeHash
String retrievalByteRange
InventoryRetrievalJobDescription inventoryRetrievalParameters
String vaultARN
String vaultName
String creationDate
String lastInventoryDate
Long numberOfArchives
null if an inventory has not yet
run on the vault, for example, if you just created the vault.Long sizeInBytes
String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String vaultARN
String vaultName
String creationDate
String lastInventoryDate
Long numberOfArchives
null if an inventory has not yet
run on the vault, for example, if you just created the vault.Long sizeInBytes
String accountId
AccountId value is the AWS account ID. This value
must match the AWS account ID associated with the credentials used to
sign the request. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you specify your account ID, do not include
any hyphens ('-') in the ID.DataRetrievalPolicy policy
String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String jobId
String range
InputStream body
String checksum
Integer status
String contentRange
String acceptRanges
String contentType
String archiveDescription
String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
VaultAccessPolicy policy
String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String policy
String state
InProgress or
Locked.String expirationDate
null if the vault lock is in a Locked state.String creationDate
InProgress state.String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
VaultNotificationConfig vaultNotificationConfig
String jobId
String jobDescription
String action
Constraints:
Allowed Values: ArchiveRetrieval, InventoryRetrieval
String archiveId
String vaultARN
String creationDate
Boolean completed
String statusCode
Constraints:
Allowed Values: InProgress, Succeeded, Failed
String statusMessage
Long archiveSizeInBytes
Long inventorySizeInBytes
String sNSTopic
String completionDate
String sHA256TreeHash
The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.
For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.
This field is null in the following situations:
Archive retrieval jobs that specify a range that is not tree-hash aligned.
Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.
Inventory jobs.
String archiveSHA256TreeHash
String retrievalByteRange
InventoryRetrievalJobDescription inventoryRetrievalParameters
String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
JobParameters jobParameters
String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String archiveDescription
The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).
String partSize
String accountId
AccountId value is the AWS account ID. This value
must match the AWS account ID associated with the credentials used to
sign the request. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you specify your account ID, do not include
any hyphens ('-') in the ID.String vaultName
VaultLockPolicy policy
String lockId
String format
String startDate
String endDate
String limit
String marker
null.
For more information, see
Range Inventory Retrieval.String startDate
String endDate
String limit
String marker
null.String format
String type
String archiveId
Type is set to archive-retrieval. An
error occurs if you specify this request parameter for an inventory
retrieval job request.String description
String sNSTopic
String retrievalByteRange
An error occurs if you specify this field for an inventory retrieval job request.
InventoryRetrievalJobInput inventoryRetrievalParameters
String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String limit
String marker
String statuscode
String completed
true or false.com.amazonaws.internal.ListWithAutoConstructFlag<T> jobList
String marker
null.String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String uploadIdMarker
String limit
com.amazonaws.internal.ListWithAutoConstructFlag<T> uploadsList
String marker
null.String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String uploadId
String marker
String limit
String multipartUploadId
String vaultARN
String archiveDescription
Long partSizeInBytes
String creationDate
com.amazonaws.internal.ListWithAutoConstructFlag<T> parts
String marker
null.String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String accountId
AccountId value is the AWS account ID. This value
must match the AWS account ID associated with the credentials used to
sign the request. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you specify your account ID, do not include
any hyphens ('-') in the ID.String marker
String limit
com.amazonaws.internal.ListWithAutoConstructFlag<T> vaultList
String marker
String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
String accountId
AccountId value is the AWS account ID. This value
must match the AWS account ID associated with the credentials used to
sign the request. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you specify your account ID, do not include
any hyphens ('-') in the ID.DataRetrievalPolicy policy
String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
VaultAccessPolicy policy
String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
VaultNotificationConfig vaultNotificationConfig
Long contentLength
String vaultName
String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String archiveDescription
String checksum
InputStream body
String multipartUploadId
String vaultARN
String archiveDescription
Long partSizeInBytes
String creationDate
String accountId
AccountId value is the AWS account ID of the account
that owns the vault. You can either specify an AWS account ID or
optionally a single '-' (hyphen), in which case Amazon
Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any
hyphens ('-') in the ID.String vaultName
String uploadId
String checksum
String range
InputStream body
String checksum
String policy
String policy
String sNSTopic
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String userName
The name of the IAM user that the access key is associated with.
String accessKeyId
The ID for this access key.
String status
The status of the access key. Active means the key is valid
for API calls, while Inactive means it is not.
String secretAccessKey
The secret key used to sign requests.
Date createDate
The date when the access key was created.
Date lastUsedDate
The date and time, in ISO 8601 date-time format, when the access key was most recently used. This field is null when:
The user does not have an access key.
An access key exists but has never been used, at least not since IAM started tracking this information on April 22nd, 2015.
There is no sign-in data associated with the user
String serviceName
The name of the AWS service with which this access key was most recently used. This field is null when:
The user does not have an access key.
An access key exists but has never been used, at least not since IAM started tracking this information on April 22nd, 2015.
There is no sign-in data associated with the user
String region
The AWS region where this access key was most recently used. This field is null when:
The user does not have an access key.
An access key exists but has never been used, at least not since IAM started tracking this information on April 22nd, 2015.
There is no sign-in data associated with the user
For more information about AWS regions, see Regions and Endpoints in the Amazon Web Services General Reference.
String userName
The name of the IAM user that the key is associated with.
String accessKeyId
The ID for this access key.
String status
The status of the access key. Active means the key is valid
for API calls; Inactive means it is not.
Date createDate
The date when the access key was created.
String openIDConnectProviderArn
The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider to add the client ID to. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders action.
String clientID
The client ID (also known as audience) to add to the IAM OpenID Connect provider.
String contextKeyName
The full name of a condition context key, including the service prefix.
For example, aws:SourceIp or s3:VersionId.
com.amazonaws.internal.SdkInternalList<T> contextKeyValues
The value (or values, if the condition context key supports multiple
values) to provide to the simulation for use when the key is referenced
by a Condition element in an input policy.
String contextKeyType
The data type of the value (or values) specified in the
ContextKeyValues parameter.
String userName
The user name that the new key will belong to.
AccessKey accessKey
Information about the access key.
String accountAlias
The account alias to create.
String path
The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
String groupName
The name of the group to create. Do not include the path in this value.
Group group
Information about the group.
String instanceProfileName
The name of the instance profile to create.
String path
The path to the instance profile. For more information about paths, see IAM Identifiers in the Using IAM guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
InstanceProfile instanceProfile
Information about the instance profile.
LoginProfile loginProfile
The user name and password create date.
String url
The URL of the identity provider. The URL must begin with "https://" and
should correspond to the iss claim in the provider's OpenID
Connect ID tokens. Per the OIDC standard, path components are allowed but
query parameters are not. Typically the URL consists of only a host name,
like "https://server.example.org" or "https://example.com".
You cannot register the same provider multiple times in a single AWS account. If you try to submit a URL that has already been used for an OpenID Connect provider in the AWS account, you will get an error.
com.amazonaws.internal.SdkInternalList<T> clientIDList
A list of client IDs (also known as audiences). When a mobile or web app
registers with an OpenID Connect provider, they establish a value that
identifies the application. (This is the value that's sent as the
client_id parameter on OAuth requests.)
You can register multiple client IDs with the same provider. For example, you might have multiple applications that use the same OIDC provider. You cannot register more than 100 client IDs with a single IAM OIDC provider.
There is no defined format for a client ID. The
CreateOpenIDConnectProviderRequest action accepts client IDs
up to 255 characters long.
com.amazonaws.internal.SdkInternalList<T> thumbprintList
A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s). Typically this list includes only one entry. However, IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain multiple thumbprints if the identity provider is rotating certificates.
The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.
You must provide at least one thumbprint when creating an IAM OIDC
provider. For example, if the OIDC provider is
server.example.com and the provider stores its keys at
"https://keys.server.example.com/openid-connect", the thumbprint string
would be the hex-encoded SHA-1 hash value of the certificate used by
https://keys.server.example.com.
For more information about obtaining the OIDC provider's thumbprint, see Obtaining the Thumbprint for an OpenID Connect Provider in the IAM User Guide.
String openIDConnectProviderArn
The Amazon Resource Name (ARN) of the IAM OpenID Connect provider that was created. For more information, see OpenIDConnectProviderListEntry.
String policyName
The name of the policy document.
String path
The path for the policy.
For more information about paths, see IAM Identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
String policyDocument
The policy document.
String description
A friendly description of the policy.
Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."
The policy description is immutable. After a value is assigned, it cannot be changed.
Policy policy
Information about the policy.
String policyArn
String policyDocument
The policy document.
Boolean setAsDefault
Specifies whether to set this version as the policy's default version.
When this parameter is true, the new policy version becomes
the operative version; that is, the version that is in effect for the IAM
users, groups, and roles that the policy is attached to.
For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
PolicyVersion policyVersion
Information about the policy version.
String path
The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
String roleName
The name of the role to create.
String assumeRolePolicyDocument
The trust relationship policy document that grants an entity permission to assume the role.
Role role
Information about the role.
String sAMLMetadataDocument
An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.
For more information, see About SAML 2.0-based Federation in the IAM User Guide
String name
The name of the provider to create.
String sAMLProviderArn
The Amazon Resource Name (ARN) of the SAML provider.
String path
The path for the user name. For more information about paths, see IAM Identifiers in the Using IAM guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
String userName
The name of the user to create.
User user
Information about the user.
String path
The path for the virtual MFA device. For more information about paths, see IAM Identifiers in the Using IAM guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
String virtualMFADeviceName
The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device.
VirtualMFADevice virtualMFADevice
A newly created virtual MFA device.
String accountAlias
The name of the account alias to delete.
String groupName
The name of the group to delete.
String instanceProfileName
The name of the instance profile to delete.
String userName
The name of the user whose password you want to delete.
String openIDConnectProviderArn
The Amazon Resource Name (ARN) of the IAM OpenID Connect provider to delete. You can get a list of OpenID Connect provider ARNs by using the ListOpenIDConnectProviders action.
String policyArn
String policyArn
String versionId
The policy version to delete.
For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
String roleName
The name of the role to delete.
String sAMLProviderArn
The Amazon Resource Name (ARN) of the SAML provider to delete.
String serverCertificateName
The name of the server certificate you want to delete.
String userName
The name of the user to delete.
String serialNumber
The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the same as the ARN.
String userName
The name of the user for whom you want to enable the MFA device.
String serialNumber
The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.
String authenticationCode1
An authentication code emitted by the device.
String authenticationCode2
A subsequent authentication code emitted by the device.
String evalActionName
The name of the API action tested on the indicated resource.
String evalResourceName
The ARN of the resource that the indicated API action was tested on.
String evalDecision
The result of the simulation.
com.amazonaws.internal.SdkInternalList<T> matchedStatements
A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the action on the resource, if only one statement denies that action, then the explicit deny overrides any allow, and the deny statement is the only entry included in the result.
com.amazonaws.internal.SdkInternalList<T> missingContextValues
A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.
If the response includes any keys in this list, then the reported results might be untrustworthy because the simulation could not completely evaluate all of the conditions specified in the policies that would occur in a real world request.
com.amazonaws.internal.SdkInternalMap<K,V> evalDecisionDetails
Additional details about the results of the evaluation decision. When there are both IAM policies and resource policies, this parameter explains how each set of policies contributes to the final evaluation decision. When simulating cross-account access to a resource, both the resource-based policy and the caller's IAM policy must grant access. See How IAM Roles Differ from Resource-based Policies
com.amazonaws.internal.SdkInternalList<T> resourceSpecificResults
The individual results of the simulation of the API action specified in EvalActionName on each resource.
String accessKeyId
The identifier of an access key.
String userName
The name of the AWS IAM user that owns this access key.
AccessKeyLastUsed accessKeyLastUsed
Contains information about the last time the access key was used.
com.amazonaws.internal.SdkInternalList<T> filter
A list of entity types (user, group, role, local managed policy, or AWS managed policy) for filtering the results.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
com.amazonaws.internal.SdkInternalList<T> userDetailList
A list containing information about IAM users.
com.amazonaws.internal.SdkInternalList<T> groupDetailList
A list containing information about IAM groups.
com.amazonaws.internal.SdkInternalList<T> roleDetailList
A list containing information about IAM roles.
com.amazonaws.internal.SdkInternalList<T> policies
A list containing information about managed policies.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
PasswordPolicy passwordPolicy
com.amazonaws.internal.SdkInternalMap<K,V> summaryMap
A set of key value pairs containing information about IAM entity usage and IAM quotas.
SummaryMap contains the following keys:
AccessKeysPerUserQuota
The maximum number of active access keys allowed for each IAM user.
AccountAccessKeysPresent
This value is 1 if the AWS account (root) has an access key, otherwise it is 0.
AccountMFAEnabled
This value is 1 if the AWS account (root) has an MFA device assigned, otherwise it is 0.
AccountSigningCertificatesPresent
This value is 1 if the AWS account (root) has a signing certificate, otherwise it is 0.
AssumeRolePolicySizeQuota
The maximum allowed size for assume role policy documents (trust policies), in non-whitespace characters.
AttachedPoliciesPerGroupQuota
The maximum number of managed policies that can be attached to an IAM group.
AttachedPoliciesPerRoleQuota
The maximum number of managed policies that can be attached to an IAM role.
AttachedPoliciesPerUserQuota
The maximum number of managed policies that can be attached to an IAM user.
GroupPolicySizeQuota
The maximum allowed size for the aggregate of all inline policies embedded in an IAM group, in non-whitespace characters.
Groups
The number of IAM groups in the AWS account.
GroupsPerUserQuota
The maximum number of IAM groups each IAM user can belong to.
GroupsQuota
The maximum number of IAM groups allowed in the AWS account.
InstanceProfiles
The number of instance profiles in the AWS account.
InstanceProfilesQuota
The maximum number of instance profiles allowed in the AWS account.
MFADevices
The number of MFA devices in the AWS account, including those assigned and unassigned.
MFADevicesInUse
The number of MFA devices that have been assigned to an IAM user or to the AWS account (root).
Policies
The number of customer managed policies in the AWS account.
PoliciesQuota
The maximum number of customer managed policies allowed in the AWS account.
PolicySizeQuota
The maximum allowed size of a customer managed policy, in non-whitespace characters.
PolicyVersionsInUse
The number of managed policies that are attached to IAM users, groups, or roles in the AWS account.
PolicyVersionsInUseQuota
The maximum number of managed policies that can be attached to IAM users, groups, or roles in the AWS account.
Providers
The number of identity providers in the AWS account.
RolePolicySizeQuota
The maximum allowed size for the aggregate of all inline policies (access policies, not the trust policy) embedded in an IAM role, in non-whitespace characters.
Roles
The number of IAM roles in the AWS account.
RolesQuota
The maximum number of IAM roles allowed in the AWS account.
ServerCertificates
The number of server certificates in the AWS account.
ServerCertificatesQuota
The maximum number of server certificates allowed in the AWS account.
SigningCertificatesPerUserQuota
The maximum number of X.509 signing certificates allowed for each IAM user.
UserPolicySizeQuota
The maximum allowed size for the aggregate of all inline policies embedded in an IAM user, in non-whitespace characters.
Users
The number of IAM users in the AWS account.
UsersQuota
The maximum number of IAM users allowed in the AWS account.
VersionsPerPolicyQuota
The maximum number of policy versions allowed for each managed policy.
com.amazonaws.internal.SdkInternalList<T> policyInputList
A list of policies for which you want list of context keys used in
Condition elements. Each document is specified as a string
containing the complete, valid JSON text of an IAM policy.
com.amazonaws.internal.SdkInternalList<T> contextKeyNames
The list of context keys that are used in the Condition
elements of the input policies.
String policySourceArn
The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies attached to the user as well as to all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.
com.amazonaws.internal.SdkInternalList<T> policyInputList
A optional list of additional policies for which you want list of context
keys used in Condition elements.
com.amazonaws.internal.SdkInternalList<T> contextKeyNames
The list of context keys that are used in the Condition
elements of the input policies.
ByteBuffer content
Contains the credential report. The report is Base64-encoded.
String reportFormat
The format (MIME type) of the credential report.
Date generatedTime
The date and time when the credential report was created, in ISO 8601 date-time format.
String groupName
The name of the group.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
Group group
Information about the group.
com.amazonaws.internal.SdkInternalList<T> users
A list of users in the group.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String instanceProfileName
The name of the instance profile to get information about.
InstanceProfile instanceProfile
Information about the instance profile.
String userName
The name of the user whose login profile you want to retrieve.
LoginProfile loginProfile
The user name and password create date for the user.
String openIDConnectProviderArn
The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider to get information for. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders action.
String url
The URL that the IAM OpenID Connect provider is associated with. For more information, see CreateOpenIDConnectProvider.
com.amazonaws.internal.SdkInternalList<T> clientIDList
A list of client IDs (also known as audiences) that are associated with the specified IAM OpenID Connect provider. For more information, see CreateOpenIDConnectProvider.
com.amazonaws.internal.SdkInternalList<T> thumbprintList
A list of certificate thumbprints that are associated with the specified IAM OpenID Connect provider. For more information, see CreateOpenIDConnectProvider.
Date createDate
The date and time when the IAM OpenID Connect provider entity was created in the AWS account.
String policyArn
Policy policy
Information about the policy.
PolicyVersion policyVersion
Information about the policy version.
For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
String roleName
The name of the role to get information about.
Role role
Information about the role.
String sAMLProviderArn
The Amazon Resource Name (ARN) of the SAML provider to get information about.
String serverCertificateName
The name of the server certificate you want to retrieve information about.
ServerCertificate serverCertificate
Information about the server certificate.
String userName
The name of the IAM user associated with the SSH public key.
String sSHPublicKeyId
The unique identifier for the SSH public key.
String encoding
Specifies the public key encoding format to use in the response. To
retrieve the public key in ssh-rsa format, use SSH. To
retrieve the public key in PEM format, use PEM.
SSHPublicKey sSHPublicKey
Information about the SSH public key.
String userName
The name of the user to get information about.
This parameter is optional. If it is not included, it defaults to the user making the request.
User user
Information about the user.
String path
The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.
String groupName
The friendly name that identifies the group.
String groupId
The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.
String arn
The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.
Date createDate
The date and time, in ISO 8601 date-time format, when the group was created.
String path
The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.
String groupName
The friendly name that identifies the group.
String groupId
The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.
String arn
Date createDate
The date and time, in ISO 8601 date-time format, when the group was created.
com.amazonaws.internal.SdkInternalList<T> groupPolicyList
A list of the inline policies embedded in the group.
com.amazonaws.internal.SdkInternalList<T> attachedManagedPolicies
A list of the managed policies attached to the group.
String path
The path to the instance profile. For more information about paths, see IAM Identifiers in the Using IAM guide.
String instanceProfileName
The name identifying the instance profile.
String instanceProfileId
The stable and unique string identifying the instance profile. For more information about IDs, see IAM Identifiers in the Using IAM guide.
String arn
The Amazon Resource Name (ARN) specifying the instance profile. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.
Date createDate
The date when the instance profile was created.
com.amazonaws.internal.SdkInternalList<T> roles
The role associated with the instance profile.
String userName
The name of the user.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> accessKeyMetadata
A list of access key metadata.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> accountAliases
A list of aliases associated with the account. AWS supports only one alias per account.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String groupName
The name (friendly name, not ARN) of the group to list attached policies for.
String pathPrefix
The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> attachedPolicies
A list of the attached policies.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String roleName
The name (friendly name, not ARN) of the role to list attached policies for.
String pathPrefix
The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> attachedPolicies
A list of the attached policies.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String userName
The name (friendly name, not ARN) of the user to list attached policies for.
String pathPrefix
The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> attachedPolicies
A list of the attached policies.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String policyArn
String entityFilter
The entity type to use for filtering the results.
For example, when EntityFilter is Role, only
the roles that are attached to the specified policy are returned. This
parameter is optional. If it is not included, all attached entities
(users, groups, and roles) are returned.
String pathPrefix
The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> policyGroups
A list of groups that the policy is attached to.
com.amazonaws.internal.SdkInternalList<T> policyUsers
A list of users that the policy is attached to.
com.amazonaws.internal.SdkInternalList<T> policyRoles
A list of roles that the policy is attached to.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String groupName
The name of the group to list policies for.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> policyNames
A list of policy names.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String userName
The name of the user to list groups for.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> groups
A list of groups.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String pathPrefix
The path prefix for filtering the results. For example, the prefix
/division_abc/subdivision_xyz/ gets all groups whose path
starts with /division_abc/subdivision_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> groups
A list of groups.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String roleName
The name of the role to list instance profiles for.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> instanceProfiles
A list of instance profiles.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String pathPrefix
The path prefix for filtering the results. For example, the prefix
/application_abc/component_xyz/ gets all instance profiles
whose path starts with /application_abc/component_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> instanceProfiles
A list of instance profiles.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String userName
The name of the user whose MFA devices you want to list.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> mFADevices
A list of MFA devices.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
com.amazonaws.internal.SdkInternalList<T> openIDConnectProviderList
The list of IAM OpenID Connect providers in the AWS account.
String scope
The scope to use for filtering the results.
To list only AWS managed policies, set Scope to
AWS. To list only the customer managed policies in your AWS
account, set Scope to Local.
This parameter is optional. If it is not included, or if it is set to
All, all policies are returned.
Boolean onlyAttached
A flag to filter the results to only the attached policies.
When OnlyAttached is true, the returned list
contains only the policies that are attached to a user, group, or role.
When OnlyAttached is false, or when the
parameter is not included, all policies are returned.
String pathPrefix
The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> policies
A list of policies.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String policyArn
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> versions
A list of policy versions.
For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String roleName
The name of the role to list policies for.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> policyNames
A list of policy names.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String pathPrefix
The path prefix for filtering the results. For example, the prefix
/application_abc/component_xyz/ gets all roles whose path
starts with /application_abc/component_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> roles
A list of roles.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
com.amazonaws.internal.SdkInternalList<T> sAMLProviderList
The list of SAML providers for this account.
String pathPrefix
The path prefix for filtering the results. For example:
/company/servercerts would get all server certificates for
which the path starts with /company/servercerts.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> serverCertificateMetadataList
A list of server certificates.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String userName
The name of the user.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> certificates
A list of the user's signing certificate information.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String userName
The name of the IAM user to list SSH public keys for. If none is specified, the UserName field is determined implicitly based on the AWS access key used to sign the request.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> sSHPublicKeys
A list of SSH public keys.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String userName
The name of the user to list policies for.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> policyNames
A list of policy names.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String pathPrefix
The path prefix for filtering the results. For example:
/division_abc/subdivision_xyz/, which would get all user
names whose path starts with /division_abc/subdivision_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> users
A list of users.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String assignmentStatus
The status (unassigned or assigned) of the devices to list. If you do not
specify an AssignmentStatus, the action defaults to
Any which lists both assigned and unassigned virtual MFA
devices.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
com.amazonaws.internal.SdkInternalList<T> virtualMFADevices
The list of virtual MFA devices in the current account that match the
AssignmentStatus value that was passed in the request.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String userName
The name of the user, which can be used for signing in to the AWS Management Console.
Date createDate
The date when the password for the user was created.
Boolean passwordResetRequired
Specifies whether the user is required to set a new password on next sign-in.
String policyName
The friendly name (not ARN) identifying the policy.
String policyId
The stable and unique string identifying the policy.
For more information about IDs, see IAM Identifiers in the Using IAM guide.
String arn
String path
The path to the policy.
For more information about paths, see IAM Identifiers in the Using IAM guide.
String defaultVersionId
The identifier for the version of the policy that is set as the default (operative) version.
For more information about policy versions, see Versioning for Managed Policies in the Using IAM guide.
Integer attachmentCount
The number of principal entities (users, groups, and roles) that the policy is attached to.
Boolean isAttachable
Specifies whether the policy can be attached to an IAM user, group, or role.
String description
A friendly description of the policy.
Date createDate
The date and time, in ISO 8601 date-time format, when the policy was created.
Date updateDate
The date and time, in ISO 8601 date-time format, when the policy was last updated.
When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.
com.amazonaws.internal.SdkInternalList<T> policyVersionList
A list containing information about the versions of the policy.
String userName
The user with whom the MFA device is associated.
String serialNumber
The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.
Date enableDate
The date when the MFA device was enabled for the user.
String arn
Integer minimumPasswordLength
Minimum length to require for IAM user passwords.
Boolean requireSymbols
Specifies whether to require symbols for IAM user passwords.
Boolean requireNumbers
Specifies whether to require numbers for IAM user passwords.
Boolean requireUppercaseCharacters
Specifies whether to require uppercase characters for IAM user passwords.
Boolean requireLowercaseCharacters
Specifies whether to require lowercase characters for IAM user passwords.
Boolean allowUsersToChangePassword
Specifies whether IAM users are allowed to change their own password.
Boolean expirePasswords
Indicates whether passwords in the account expire. Returns true if MaxPasswordAge is contains a value greater than 0. Returns false if MaxPasswordAge is 0 or not present.
Integer maxPasswordAge
The number of days that an IAM user password is valid.
Integer passwordReusePrevention
Specifies the number of previous passwords that IAM users are prevented from reusing.
Boolean hardExpiry
Specifies whether IAM users are prevented from setting a new password after their password has expired.
String policyName
The friendly name (not ARN) identifying the policy.
String policyId
The stable and unique string identifying the policy.
For more information about IDs, see IAM Identifiers in the Using IAM guide.
String arn
String path
The path to the policy.
For more information about paths, see IAM Identifiers in the Using IAM guide.
String defaultVersionId
The identifier for the version of the policy that is set as the default version.
Integer attachmentCount
The number of entities (users, groups, and roles) that the policy is attached to.
Boolean isAttachable
Specifies whether the policy can be attached to an IAM user, group, or role.
String description
A friendly description of the policy.
This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.
Date createDate
The date and time, in ISO 8601 date-time format, when the policy was created.
Date updateDate
The date and time, in ISO 8601 date-time format, when the policy was last updated.
When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.
String groupName
The name (friendly name, not ARN) identifying the group.
String roleName
The name (friendly name, not ARN) identifying the role.
String userName
The name (friendly name, not ARN) identifying the user.
String document
The policy document.
The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations.
String versionId
The identifier for the policy version.
Policy version identifiers always begin with v (always
lowercase). When a policy is created, the first policy version is
v1.
Boolean isDefaultVersion
Specifies whether the policy version is set as the policy's default version.
Date createDate
The date and time, in ISO 8601 date-time format, when the policy version was created.
String openIDConnectProviderArn
The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider to remove the client ID from. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders action.
String clientID
The client ID (also known as audience) to remove from the IAM OpenID Connect provider. For more information about client IDs, see CreateOpenIDConnectProvider.
String evalResourceName
The name of the simulated resource, in Amazon Resource Name (ARN) format.
String evalResourceDecision
The result of the simulation of the simulated API action on the resource
specified in EvalResourceName.
com.amazonaws.internal.SdkInternalList<T> matchedStatements
A list of the statements in the input policies that determine the result for this part of the simulation. Remember that even if multiple statements allow the action on the resource, if any statement denies that action, then the explicit deny overrides any allow, and the deny statement is the only entry included in the result.
com.amazonaws.internal.SdkInternalList<T> missingContextValues
A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.
com.amazonaws.internal.SdkInternalMap<K,V> evalDecisionDetails
Additional details about the results of the evaluation decision. When there are both IAM policies and resource policies, this parameter explains how each set of policies contributes to the final evaluation decision. When simulating cross-account access to a resource, both the resource-based policy and the caller's IAM policy must grant access.
String userName
The name of the user whose MFA device you want to resynchronize.
String serialNumber
Serial number that uniquely identifies the MFA device.
String authenticationCode1
An authentication code emitted by the device.
String authenticationCode2
A subsequent authentication code emitted by the device.
String path
The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.
String roleName
The friendly name that identifies the role.
String roleId
The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.
String arn
The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.
Date createDate
The date and time, in ISO 8601 date-time format, when the role was created.
String assumeRolePolicyDocument
The policy that grants an entity permission to assume the role.
String path
The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.
String roleName
The friendly name that identifies the role.
String roleId
The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.
String arn
Date createDate
The date and time, in ISO 8601 date-time format, when the role was created.
String assumeRolePolicyDocument
The trust policy that grants permission to assume the role.
com.amazonaws.internal.SdkInternalList<T> instanceProfileList
com.amazonaws.internal.SdkInternalList<T> rolePolicyList
A list of inline policies embedded in the role. These policies are the role's access (permissions) policies.
com.amazonaws.internal.SdkInternalList<T> attachedManagedPolicies
A list of managed policies attached to the role. These policies are the role's access (permissions) policies.
ServerCertificateMetadata serverCertificateMetadata
The meta information of the server certificate, such as its name, path, ID, and ARN.
String certificateBody
The contents of the public key certificate.
String certificateChain
The contents of the public key certificate chain.
String path
The path to the server certificate. For more information about paths, see IAM Identifiers in the Using IAM guide.
String serverCertificateName
The name that identifies the server certificate.
String serverCertificateId
The stable and unique string identifying the server certificate. For more information about IDs, see IAM Identifiers in the Using IAM guide.
String arn
The Amazon Resource Name (ARN) specifying the server certificate. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.
Date uploadDate
The date when the server certificate was uploaded.
Date expiration
The date on which the certificate is set to expire.
String policyArn
String versionId
The version of the policy to set as the default (operative) version.
For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
String userName
The name of the user the signing certificate is associated with.
String certificateId
The ID for the signing certificate.
String certificateBody
The contents of the signing certificate.
String status
The status of the signing certificate. Active means the key
is valid for API calls, while Inactive means it is not.
Date uploadDate
The date when the signing certificate was uploaded.
com.amazonaws.internal.SdkInternalList<T> policyInputList
A list of policy documents to include in the simulation. Each document is
specified as a string containing the complete, valid JSON text of an IAM
policy. Do not include any resource-based policies in this parameter. Any
resource-based policy must be submitted with the
ResourcePolicy parameter. The policies cannot be
"scope-down" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole APIs to restrict what a user can do while using the
temporary credentials.
com.amazonaws.internal.SdkInternalList<T> actionNames
A list of names of API actions to evaluate in the simulation. Each action
is evaluated against each resource. Each action must include the service
identifier, such as iam:CreateUser.
com.amazonaws.internal.SdkInternalList<T> resourceArns
A list of ARNs of AWS resources to include in the simulation. If this
parameter is not provided then the value defaults to * (all
resources). Each API in the ActionNames parameter is
evaluated for each resource in this list. The simulation determines the
access result (allowed or denied) of each combination and reports it in
the response.
The simulation does not automatically retrieve policies for the specified
resources. If you want to include a resource policy in the simulation,
then you must include the policy as a string in the
ResourcePolicy parameter.
If you include a ResourcePolicy, then it must be applicable
to all of the resources included in the simulation or you receive an
invalid input error.
String resourcePolicy
A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.
String resourceOwner
An AWS account ID that specifies the owner of any simulated resource that
does not identify its owner in the resource ARN, such as an S3 bucket or
object. If ResourceOwner is specified, it is also used as
the account owner of any ResourcePolicy included in the
simulation. If the ResourceOwner parameter is not specified,
then the owner of the resources and the resource policy defaults to the
account of the identity provided in CallerArn. This
parameter is required only if you specify a resource-based policy and
account that owns the resource is different from the account that owns
the simulated calling user CallerArn.
String callerArn
The ARN of the user that you want to use as the simulated caller of the
APIs. CallerArn is required if you include a
ResourcePolicy so that the policy's Principal
element has a value to use in evaluating the policy.
You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.
com.amazonaws.internal.SdkInternalList<T> contextEntries
A list of context keys and corresponding values for the simulation to
use. Whenever a context key is evaluated by a Condition
element in one of the simulated IAM permission policies, the
corresponding value is supplied.
String resourceHandlingOption
Specifies the type of simulation to run. Different APIs that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.
Each of the EC2 scenarios requires that you specify instance, image, and security-group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network-interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported Platforms in the AWS EC2 User Guide.
EC2-Classic-InstanceStore
instance, image, security-group
EC2-Classic-EBS
instance, image, security-group, volume
EC2-VPC-InstanceStore
instance, image, security-group, network-interface
EC2-VPC-InstanceStore-Subnet
instance, image, security-group, network-interface, subnet
EC2-VPC-EBS
instance, image, security-group, network-interface, volume
EC2-VPC-EBS-Subnet
instance, image, security-group, network-interface, subnet, volume
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
com.amazonaws.internal.SdkInternalList<T> evaluationResults
The results of the simulation.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String policySourceArn
The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If you specify a user, group, or role, the simulation includes all policies that are associated with that entity. If you specify a user, the simulation also includes all policies that are attached to any groups the user belongs to.
com.amazonaws.internal.SdkInternalList<T> policyInputList
An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.
com.amazonaws.internal.SdkInternalList<T> actionNames
A list of names of API actions to evaluate in the simulation. Each action
is evaluated for each resource. Each action must include the service
identifier, such as iam:CreateUser.
com.amazonaws.internal.SdkInternalList<T> resourceArns
A list of ARNs of AWS resources to include in the simulation. If this
parameter is not provided then the value defaults to * (all
resources). Each API in the ActionNames parameter is
evaluated for each resource in this list. The simulation determines the
access result (allowed or denied) of each combination and reports it in
the response.
The simulation does not automatically retrieve policies for the specified
resources. If you want to include a resource policy in the simulation,
then you must include the policy as a string in the
ResourcePolicy parameter.
String resourcePolicy
A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.
String resourceOwner
An AWS account ID that specifies the owner of any simulated resource that
does not identify its owner in the resource ARN, such as an S3 bucket or
object. If ResourceOwner is specified, it is also used as
the account owner of any ResourcePolicy included in the
simulation. If the ResourceOwner parameter is not specified,
then the owner of the resources and the resource policy defaults to the
account of the identity provided in CallerArn. This
parameter is required only if you specify a resource-based policy and
account that owns the resource is different from the account that owns
the simulated calling user CallerArn.
String callerArn
The ARN of the user that you want to specify as the simulated caller of
the APIs. If you do not specify a CallerArn, it defaults to
the ARN of the user that you specify in PolicySourceArn, if
you specified a user. If you include both a PolicySourceArn
(for example, arn:aws:iam::123456789012:user/David) and a
CallerArn (for example,
arn:aws:iam::123456789012:user/Bob), the result is that you
simulate calling the APIs as Bob, as if Bob had David's policies.
You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.
CallerArn is required if you include a
ResourcePolicy and the PolicySourceArn is not
the ARN for an IAM user. This is required so that the resource-based
policy's Principal element has a value to use in evaluating
the policy.
com.amazonaws.internal.SdkInternalList<T> contextEntries
A list of context keys and corresponding values for the simulation to
use. Whenever a context key is evaluated by a Condition
element in one of the simulated policies, the corresponding value is
supplied.
String resourceHandlingOption
Specifies the type of simulation to run. Different APIs that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.
Each of the EC2 scenarios requires that you specify instance, image, and security-group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network-interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported Platforms in the AWS EC2 User Guide.
EC2-Classic-InstanceStore
instance, image, security-group
EC2-Classic-EBS
instance, image, security-group, volume
EC2-VPC-InstanceStore
instance, image, security-group, network-interface
EC2-VPC-InstanceStore-Subnet
instance, image, security-group, network-interface, subnet
EC2-VPC-EBS
instance, image, security-group, network-interface, volume
EC2-VPC-EBS-Subnet
instance, image, security-group, network-interface, subnet, volume
Integer maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the
maximum you specify, the IsTruncated response element is
true.
This parameter is optional. If you do not include it, it defaults to 100.
Note that IAM might return fewer results, even when there are more
results available. In that case, the IsTruncated response
element returns true and Marker contains a
value to include in the subsequent call that tells the service where to
continue from.
String marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated. Set it to
the value of the Marker element in the response that you
received to indicate where the next call should start.
com.amazonaws.internal.SdkInternalList<T> evaluationResults
The results of the simulation.
Boolean isTruncated
A flag that indicates whether there are more items to return. If your
results were truncated, you can make a subsequent pagination request
using the Marker request parameter to retrieve more items.
Note that IAM might return fewer than the MaxItems number of
results even when there are more results available. We recommend that you
check IsTruncated after every call to ensure that you
receive all of your results.
String marker
When IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
String userName
The name of the IAM user associated with the SSH public key.
String sSHPublicKeyId
The unique identifier for the SSH public key.
String fingerprint
The MD5 message digest of the SSH public key.
String sSHPublicKeyBody
The SSH public key.
String status
The status of the SSH public key. Active means the key can
be used for authentication with an AWS CodeCommit repository.
Inactive means the key cannot be used.
Date uploadDate
The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.
String userName
The name of the IAM user associated with the SSH public key.
String sSHPublicKeyId
The unique identifier for the SSH public key.
String status
The status of the SSH public key. Active means the key can
be used for authentication with an AWS CodeCommit repository.
Inactive means the key cannot be used.
Date uploadDate
The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.
String sourcePolicyId
The identifier of the policy that was provided as an input.
String sourcePolicyType
The type of the policy.
Position startPosition
The row and column of the beginning of the Statement in an
IAM policy.
Position endPosition
The row and column of the end of a Statement in an IAM
policy.
String userName
The name of the user whose key you want to update.
String accessKeyId
The access key ID of the secret access key you want to update.
String status
The status you want to assign to the secret access key.
Active means the key can be used for API calls to AWS, while
Inactive means the key cannot be used.
Integer minimumPasswordLength
The minimum number of characters allowed in an IAM user password.
Default value: 6
Boolean requireSymbols
Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:
! @ # $ % ^ & * ( ) _ + - = [ ] { } | '
Default value: false
Boolean requireNumbers
Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).
Default value: false
Boolean requireUppercaseCharacters
Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z).
Default value: false
Boolean requireLowercaseCharacters
Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z).
Default value: false
Boolean allowUsersToChangePassword
Allows all IAM users in your account to use the AWS Management Console to change their own passwords. For more information, see Letting IAM Users Change Their Own Passwords in the IAM User Guide.
Default value: false
Integer maxPasswordAge
The number of days that an IAM user password is valid. The default value of 0 means IAM user passwords never expire.
Default value: 0
Integer passwordReusePrevention
Specifies the number of previous passwords that IAM users are prevented from reusing. The default value of 0 means IAM users are not prevented from reusing previous passwords.
Default value: 0
Boolean hardExpiry
Prevents IAM users from setting a new password after their password has expired.
Default value: false
String groupName
Name of the group to update. If you're changing the name of the group, this is the original name.
String newPath
New path for the group. Only include this if changing the group's path.
String newGroupName
New name for the group. Only include this if changing the group's name.
String openIDConnectProviderArn
The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider to update the thumbprint for. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders action.
com.amazonaws.internal.SdkInternalList<T> thumbprintList
A list of certificate thumbprints that are associated with the specified IAM OpenID Connect provider. For more information, see CreateOpenIDConnectProvider.
String sAMLMetadataDocument
An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.
String sAMLProviderArn
The Amazon Resource Name (ARN) of the SAML provider to update.
String sAMLProviderArn
The Amazon Resource Name (ARN) of the SAML provider that was updated.
String serverCertificateName
The name of the server certificate that you want to update.
String newPath
The new path for the server certificate. Include this only if you are updating the server certificate's path.
String newServerCertificateName
The new name for the server certificate. Include this only if you are updating the server certificate's name. The name of the certificate cannot contain any spaces.
String userName
The name of the user the signing certificate belongs to.
String certificateId
The ID of the signing certificate you want to update.
String status
The status you want to assign to the certificate. Active
means the certificate can be used for API calls to AWS, while
Inactive means the certificate cannot be used.
String userName
The name of the IAM user associated with the SSH public key.
String sSHPublicKeyId
The unique identifier for the SSH public key.
String status
The status to assign to the SSH public key. Active means the
key can be used for authentication with an AWS CodeCommit repository.
Inactive means the key cannot be used.
String userName
Name of the user to update. If you're changing the name of the user, this is the original user name.
String newPath
New path for the user. Include this parameter only if you're changing the user's path.
String newUserName
New name for the user. Include this parameter only if you're changing the user's name.
String path
The path for the server certificate. For more information about paths, see IAM Identifiers in the Using IAM guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
--path option. The path must begin with
/cloudfront and must include a trailing slash (for example,
/cloudfront/test/). String serverCertificateName
The name for the server certificate. Do not include the path in this value. The name of the certificate cannot contain any spaces.
String certificateBody
The contents of the public key certificate in PEM-encoded format.
String privateKey
The contents of the private key in PEM-encoded format.
String certificateChain
The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.
ServerCertificateMetadata serverCertificateMetadata
The meta information of the uploaded server certificate without its certificate body, certificate chain, and private key.
SigningCertificate certificate
Information about the certificate.
SSHPublicKey sSHPublicKey
Contains information about the SSH public key.
String path
The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide.
String userName
The friendly name identifying the user.
String userId
The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the Using IAM guide.
String arn
The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the Using IAM guide.
Date createDate
The date and time, in ISO 8601 date-time format, when the user was created.
Date passwordLastUsed
The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an AWS website. For a list of AWS websites that capture a user's last sign-in time, see the Credential Reports topic in the Using IAM guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. This field is null (not present) when:
The user does not have a password
The password exists but has never been used (at least not since IAM started tracking this information on October 20th, 2014
there is no sign-in data associated with the user
This value is returned only in the GetUser and ListUsers actions.
String path
The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide.
String userName
The friendly name identifying the user.
String userId
The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the Using IAM guide.
String arn
Date createDate
The date and time, in ISO 8601 date-time format, when the user was created.
com.amazonaws.internal.SdkInternalList<T> userPolicyList
A list of the inline policies embedded in the user.
com.amazonaws.internal.SdkInternalList<T> groupList
A list of IAM groups that the user is in.
com.amazonaws.internal.SdkInternalList<T> attachedManagedPolicies
A list of the managed policies attached to the user.
String serialNumber
The serial number associated with VirtualMFADevice.
ByteBuffer base32StringSeed
The Base32 seed defined as specified in RFC3548. The
Base32StringSeed is Base64-encoded.
ByteBuffer qRCodePNG
A QR code PNG image that encodes
otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String
where $virtualMFADeviceName is one of the create call
arguments, AccountName is the user name if set (otherwise,
the account ID otherwise), and Base32String is the seed in
Base32 format. The Base32String value is Base64-encoded.
User user
Date enableDate
The date and time on which the virtual MFA device was enabled.
Boolean success
com.amazonaws.internal.SdkInternalList<T> jobIds
String name
String company
String phoneNumber
String country
String stateOrProvince
String city
String postalCode
String street1
String street2
String street3
String aPIVersion
String jobId
String jobType
String locationCode
String locationMessage
String progressCode
String progressMessage
String carrier
String trackingNumber
String logBucket
String logKey
Integer errorCount
String signature
String signatureFileContents
String currentManifest
Date creationDate
com.amazonaws.internal.SdkInternalList<T> artifactList
com.amazonaws.internal.SdkInternalList<T> jobs
Boolean isTruncated
Boolean success
String warningMessage
com.amazonaws.internal.SdkInternalList<T> artifactList
String message
Confirmation details of the action performed.
String agentId
The EC2 instance ID where the agent is installed.
String assessmentArn
The ARN of the assessment that is associated with the agent.
String agentHealth
The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY.
String agentHealthCode
The detailed health state of the agent. Values can be set to RUNNING, HEALTHY, UNHEALTHY, UNKNOWN, BLACKLISTED, SHUTDOWN, THROTTLED.
String agentHealthDetails
The description for the agent health code.
String autoScalingGroup
This data type property is currently not used.
String accountId
AWS account of the EC2 instance where the agent is installed.
List<E> telemetry
The Inspector application data metrics collected by the agent.
List<E> applicationNamePatterns
For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the applicationName property of the Application data type.
String assessmentArn
The ARN of the assessment.
String assessmentName
The name of the assessment.
String applicationArn
The ARN of the application that corresponds to this assessment.
String assessmentState
The state of the assessment. Values can be set to Created, Collecting Data, Stopping, and Completed.
String failureMessage
This data type property is not currently used.
Boolean dataCollected
Boolean value (true or false) specifying whether the data collection process is completed.
Date startTime
The assessment start time.
Date endTime
The assessment end time.
Integer durationInSeconds
The assessment duration in seconds. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).
List<E> userAttributesForFindings
The user-defined attributes that are assigned to every generated finding.
List<E> assessmentNamePatterns
For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the assessmentName property of the Assessment data type.
List<E> assessmentStates
For a record to match a filter, the value specified for this data type property must be the exact match of the value of the assessmentState property of the Assessment data type.
Boolean dataCollected
For a record to match a filter, the value specified for this data type property must be the exact match of the value of the dataCollected property of the Assessment data type.
TimestampRange startTimeRange
For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the startTime property of the Assessment data type.
TimestampRange endTimeRange
For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the endTime property of the Assessment data type.
DurationRange durationRange
For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the durationInSeconds property of the Assessment data type.
String message
Confirmation details of the action performed.
String applicationArn
The ARN specifying the application that is created.
String applicationArn
The ARN specifying the application for which you want to create an assessment.
String assessmentName
The user-defined name identifying the assessment that you want to create. You can create several assessments for an application. The names of the assessments corresponding to a particular application must be unique.
Integer durationInSeconds
The duration of the assessment in seconds. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).
List<E> userAttributesForFindings
The user-defined attributes that are assigned to every finding generated by running this assessment.
String assessmentArn
The ARN specifying the assessment that is created.
String resourceGroupTags
A collection of keys and an array of possible values in JSON format.
For example, [{"key":"key1","values":["Value1","Value2"]},{"key":"Key2","values" :["Value3"]}]
String resourceGroupArn
The ARN specifying the resource group that is created.
String applicationArn
The ARN specifying the application that you want to delete.
String message
Confirmation details of the action performed.
String assessmentArn
The ARN specifying the assessment that you want to delete.
String message
Confirmation details of the action performed.
String runArn
The ARN specifying the assessment run that you want to delete.
String message
Confirmation details of the action performed.
String applicationArn
The ARN specifying the application that you want to describe.
Application application
Information about the application.
String assessmentArn
The ARN specifying the assessment that you want to describe.
Assessment assessment
Information about the assessment.
String findingArn
The ARN specifying the finding that you want to describe.
Finding finding
Information about the finding.
String resourceGroupArn
The ARN specifying the resource group that you want to describe.
ResourceGroup resourceGroup
Information about the resource group.
String rulesPackageArn
The ARN specifying the rules package that you want to describe.
RulesPackage rulesPackage
Information about the rules package.
String runArn
The ARN specifying the assessment run that you want to describe.
Run run
Information about the assessment run.
String message
Confirmation details of the action performed.
String findingArn
The ARN specifying the finding.
String runArn
The ARN of the assessment run that generated the finding.
String rulesPackageArn
The ARN of the rules package that is used to generate the finding.
String ruleName
The rule name that is used to generate the finding.
String agentId
The EC2 instance ID where the agent is installed that is used during the assessment that generates the finding.
String autoScalingGroup
The autoscaling group of the EC2 instance where the agent is installed that is used during the assessment that generates the finding.
String severity
The finding severity. Values can be set to High, Medium, Low, and Informational.
LocalizedText finding
A short description that identifies the finding.
LocalizedText description
The description of the finding.
LocalizedText recommendation
The recommendation for the finding.
List<E> attributes
The system-defined attributes for the finding.
List<E> userAttributes
The user-defined attributes that are assigned to the finding.
List<E> rulesPackageArns
For a record to match a filter, the value specified for this data type property must be the exact match of the value of the rulesPackageArn property of the Finding data type.
List<E> ruleNames
For a record to match a filter, the value specified for this data type property must be the exact match of the value of the ruleName property of the Finding data type.
List<E> severities
For a record to match a filter, the value specified for this data type property must be the exact match of the value of the severity property of the Finding data type.
List<E> attributes
For a record to match a filter, the value specified for this data type property must be the exact match of the value of the attributes property of the Finding data type.
List<E> userAttributes
For a record to match a filter, the value specified for this data type property must be the exact match of the value of the userAttributes property of the Finding data type.
String assessmentArn
The ARN specifying the assessment the telemetry of which you want to obtain.
ApplicationsFilter filter
You can use this parameter to specify a subset of data to be included in the action's response.
For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
String nextToken
You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListApplications action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.
Integer maxResults
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
List<E> applicationArnList
A list of ARNs specifying the applications returned by the action.
String nextToken
When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.
String assessmentArn
The ARN specifying the assessment whose agents you want to list.
AgentsFilter filter
You can use this parameter to specify a subset of data to be included in the action's response.
For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
String nextToken
You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListAssessmentAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.
Integer maxResults
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
List<E> agentList
A list of ARNs specifying the agents returned by the action.
String nextToken
When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.
List<E> applicationArns
A list of ARNs specifying the applications the assessments of which you want to list.
AssessmentsFilter filter
You can use this parameter to specify a subset of data to be included in the action's response.
For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
String nextToken
You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListAssessments action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.
Integer maxResults
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
List<E> assessmentArnList
A list of ARNs specifying the assessments returned by the action.
String nextToken
When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.
String rulesPackageArn
The ARN specifying the rules package whose assessments you want to list.
AssessmentsFilter filter
You can use this parameter to specify a subset of data to be included in the action's response.
For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
String nextToken
You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListAttachedAssessments action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.
Integer maxResults
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
List<E> assessmentArnList
A list of ARNs specifying the assessments returned by the action.
String nextToken
When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.
String assessmentArn
The ARN specifying the assessment whose rules packages you want to list.
String nextToken
You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListAttachedRulesPackages action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.
Integer maxResults
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
List<E> rulesPackageArnList
A list of ARNs specifying the rules packages returned by the action.
String nextToken
When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.
List<E> runArns
The ARNs of the assessment runs that generate the findings that you want to list.
FindingsFilter filter
You can use this parameter to specify a subset of data to be included in the action's response.
For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
String nextToken
You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListFindings action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.
Integer maxResults
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
List<E> findingArnList
A list of ARNs specifying the findings returned by the action.
String nextToken
When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.
String nextToken
You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListRulesPackages action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.
Integer maxResults
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
List<E> rulesPackageArnList
The list of ARNs specifying the rules packages returned by the action.
String nextToken
When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.
List<E> assessmentArns
The ARNs specifying the assessments whose runs you want to list.
RunsFilter filter
You can use this parameter to specify a subset of data to be included in the action's response.
For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
String nextToken
You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListRuns action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.
Integer maxResults
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
List<E> runArnList
A list of ARNs specifying the assessment runs returned by the action.
String nextToken
When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.
String resourceArn
The ARN specifying the resource whose tags you want to list.
LocalizedTextKey key
The facility and id properties of the LocalizedTextKey data type.
List<E> parameters
Values for the dynamic elements of the string specified by the textual identifier.
String messageType
A specific type of behavioral data that is collected by the agent.
Long count
The number of times that the behavioral data is collected by the agent during an assessment.
Long dataSize
The total size of the behavioral data that is collected by the agent during an assessment.
String resourceGroupArn
The ARN of the resource group that is used to create an application.
String nextToken
You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the PreviewAgentsForResourceGroup action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.
Integer maxResults
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
List<E> agentPreviewList
The resulting list of agents.
String nextToken
When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.
String roleArn
String message
Confirmation details of the action performed.
String message
Confirmation details of the action performed.
String resourceGroupArn
The ARN of the resource group.
String resourceGroupTags
The tags (key and value pairs) of the resource group.
This data type property is used in the CreateResourceGroup action.
A collection of keys and an array of possible values in JSON format.
For example, [{ "key1" : ["Value1","Value2"]},{"Key2": ["Value3"]}]
String rulesPackageArn
The ARN of the rules package.
String rulesPackageName
The name of the rules package.
String version
The version id of the rules package.
String provider
The provider of the rules package.
LocalizedText description
The description of the rules package.
String runArn
The ARN of the run.
String runName
The auto-generated name for the run.
String assessmentArn
The ARN of the assessment that is associated with the run.
String runState
The state of the run. Values can be set to DataCollectionComplete, EvaluatingPolicies, EvaluatingPoliciesErrorCanRetry, Completed, Failed, TombStoned.
List<E> rulesPackages
Rules packages selected for the run of the assessment.
Date creationTime
Run creation time that corresponds to the data collection completion time or failure.
Date completionTime
Run completion time that corresponds to the rules packages evaluation completion time or failure.
String runArn
The ARN specifying the run of the assessment.
List<E> runNamePatterns
For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the runName property of the Run data type.
List<E> runStates
For a record to match a filter, the value specified for this data type property must be the exact match of the value of the runState property of the Run data type.
List<E> rulesPackages
For a record to match a filter, the value specified for this data type property must match a list of values of the rulesPackages property of the Run data type.
TimestampRange creationTime
For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the creationTime property of the Run data type.
TimestampRange completionTime
For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the completionTime property of the Run data type.
String message
Confirmation details of the action performed.
String assessmentArn
The ARN of the assessment for which you want to start the data collection process.
String message
Confirmation details of the action performed.
String assessmentArn
The ARN of the assessment for which you want to stop the data collection process.
String message
Confirmation details of the action performed.
String message
Confirmation details of the action performed.
String assessmentArn
Asessment ARN that you want to update.
String assessmentName
Assessment name that you want to update.
Integer durationInSeconds
Assessment duration in seconds that you want to update. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).
String message
Confirmation details of the action performed.
DynamoDBAction dynamoDB
Write to a DynamoDB table.
LambdaAction lambda
Invoke a Lambda function.
SnsAction sns
Publish to an SNS topic.
SqsAction sqs
Publish to an SQS queue.
KinesisAction kinesis
Write data to a Kinesis stream.
RepublishAction republish
Publish to another MQTT topic.
S3Action s3
Write to an S3 bucket.
FirehoseAction firehose
String certificateId
The ID of the certificate.
String certificateArn
The ARN of the certificate.
String certificateId
The ID of the certificate.
String status
The status of the certificate.
String certificatePem
The certificate data, in PEM format.
String ownedBy
The ID of the AWS account that owns the certificate.
Date creationDate
The date and time the certificate was created.
Date lastModifiedDate
The date and time the certificate was last modified.
String certificateArn
The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a principal for policy operations.
String certificateId
The ID of the certificate. Certificate management operations only take a certificateId.
String certificatePem
The certificate data, in PEM format.
Boolean setAsActive
Specifies whether the certificate is active.
String certificateArn
The ARN of the certificate.
String certificateId
The ID of the certificate. AWS IoT issues a default subject name for the certificate (e.g., AWS IoT Certificate).
String certificatePem
The certificate data, in PEM format.
KeyPair keyPair
The generated key pair.
String policyName
The policy name.
String policyDocument
The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048 excluding whitespaces
Boolean setAsDefault
Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version; that is, the version that is in effect for the certificates that the policy is attached to.
String thingName
The name of the thing.
AttributePayload attributePayload
The attribute payload. Which consists of up to 3 name/value pairs in a JSON document. For example: {\"attributes\":{\"string1\":\"string2\"}}
String ruleName
The name of the rule.
TopicRulePayload topicRulePayload
The rule payload.
String certificateId
The ID of the certificate.
String policyName
The name of the policy to delete.
String thingName
The thing name.
String ruleName
The name of the rule.
String certificateId
The ID of the certificate.
CertificateDescription certificateDescription
The description of the certificate.
String endpointAddress
The endpoint. The format of the endpoint is as follows: identifier.iot.region.amazonaws.com.
String thingName
The name of the thing.
String defaultClientId
The default client ID.
String thingName
The name of the thing.
Map<K,V> attributes
The attributes which are name/value pairs in JSON format. For example:
{\"attributes\":{\"some-name1\":\"some-value1\"}, {\"some-name2\":\"some-value2\"}, {\"some-name3\":\"some-value3\"}}
String tableName
The name of the DynamoDB table.
String roleArn
The ARN of the IAM role that grants access.
String hashKeyField
The hash key name.
String hashKeyValue
The hash key value.
String rangeKeyField
The range key name.
String rangeKeyValue
The range key value.
String payloadField
The action payload, this name can be customized.
String policyName
The name of the policy.
String policyArn
The policy ARN.
String policyName
The policy name.
String policyDocument
The JSON document that describes the policy.
String policyVersionId
The policy version ID.
Boolean isDefaultVersion
Specifies whether the policy version is the default.
String ruleName
The name of the rule.
TopicRule rule
The rule.
String functionArn
The ARN of the Lambda function.
String policyName
The policy name.
String thingName
The name of the thing.
String certificateId
The ID of the certificate.
String ruleName
The name of the rule.
TopicRulePayload topicRulePayload
The rule payload.
LoggingOptionsPayload loggingOptionsPayload
The logging options payload.
String ruleName
The name of the rule.
String sql
The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters properly.
String description
The description of the rule.
Date createdAt
The date and time the rule was created.
List<E> actions
The actions associated with the rule.
Boolean ruleDisabled
Specifies whether the rule is disabled.
String sql
The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide.
String description
The description of the rule.
List<E> actions
The actions associated with the rule.
Boolean ruleDisabled
Specifies whether the rule is disabled.
String transferredCertificateArn
The ARN of the certificate.
String thingName
The thing name.
AttributePayload attributePayload
The attribute payload, a JSON string containing up to three key-value pairs.
For example: {\"attributes\":{\"string1\":\"string2\"}}
String thingName
The name of the thing.
ByteBuffer payload
The state information, in JSON format.
String thingName
The name of the thing.
ByteBuffer payload
The state information, in JSON format.
String topic
The name of the MQTT topic.
Integer qos
The Quality of Service (QoS) level.
ByteBuffer payload
The state information, in JSON format.
String thingName
The name of the thing.
ByteBuffer payload
The state information, in JSON format.
ByteBuffer payload
The state information, in JSON format.
String streamName
The name of the stream.
com.amazonaws.internal.SdkInternalMap<K,V> tags
The set of key-value pairs to use to create the tags.
String streamName
A name to identify the stream. The stream name is scoped to the AWS account used by the application that creates the stream. It is also scoped by region. That is, two streams in two different AWS accounts can have the same name, and two streams in the same AWS account, but in two different regions, can have the same name.
Integer shardCount
The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.
DefaultShardLimit;
String streamName
The name of the stream to delete.
StreamDescription streamDescription
The current status of the stream, the stream ARN, an array of shard objects that comprise the stream, and states whether there are more shards available.
String shardIterator
The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.
Integer limit
The maximum number of records to return. Specify a value of up to 10,000.
If you specify a value that is greater than 10,000, GetRecords
throws InvalidArgumentException.
com.amazonaws.internal.SdkInternalList<T> records
The data records retrieved from the shard.
String nextShardIterator
The next position in the shard from which to start sequentially reading
data records. If set to null, the shard has been closed and
the requested iterator will not return any more data.
Long millisBehindLatest
The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates record processing is caught up, and there are no new records to process at this moment.
String streamName
The name of the stream.
String shardId
The shard ID of the shard to get the iterator for.
String shardIteratorType
Determines how the shard iterator is used to start reading data records from the shard.
The following are the valid shard iterator types:
String startingSequenceNumber
The sequence number of the data record in the shard from which to start reading from.
String shardIterator
The position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard.
com.amazonaws.internal.SdkInternalList<T> streamNames
The names of the streams that are associated with the AWS account making
the ListStreams request.
Boolean hasMoreStreams
If set to true, there are more streams available to list.
String streamName
The name of the stream.
String exclusiveStartTagKey
The key to use as the starting point for the list of tags. If this
parameter is set, ListTagsForStream gets all tags that occur
after ExclusiveStartTagKey.
Integer limit
The number of tags to return. If this number is less than the total
number of tags associated with the stream, HasMoreTags is
set to true. To list additional tags, set
ExclusiveStartTagKey to the last key in the response.
com.amazonaws.internal.SdkInternalList<T> tags
A list of tags associated with StreamName, starting with the
first tag after ExclusiveStartTagKey and up to the specified
Limit.
Boolean hasMoreTags
If set to true, more tags are available. To request
additional tags, set ExclusiveStartTagKey to the key of the
last tag returned.
String streamName
The name of the stream to put the data record into.
ByteBuffer data
The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).
String partitionKey
Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key will map to the same shard within the stream.
String explicitHashKey
The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
String sequenceNumberForOrdering
Guarantees strictly increasing sequence numbers, for puts from the same
client and to the same partition key. Usage: set the
SequenceNumberForOrdering of record n to the sequence
number of record n-1 (as returned in the result when putting
record n-1). If this parameter is not set, records will be
coarsely ordered based on arrival time.
String shardId
The shard ID of the shard where the data record was placed.
String sequenceNumber
The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique across all records in the stream. A sequence number is the identifier associated with every record put into the stream.
com.amazonaws.internal.SdkInternalList<T> records
The records associated with the request.
String streamName
The stream name associated with the request.
ByteBuffer data
The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).
String explicitHashKey
The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.
String partitionKey
Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.
Integer failedRecordCount
The number of unsuccessfully processed records in a
PutRecords request.
com.amazonaws.internal.SdkInternalList<T> records
An array of successfully and unsuccessfully processed record results,
correlated with the request by natural ordering. A record that is
successfully added to your Amazon Kinesis stream includes
SequenceNumber and ShardId in the result. A
record that fails to be added to your Amazon Kinesis stream includes
ErrorCode and ErrorMessage in the result.
String sequenceNumber
The sequence number for an individual record result.
String shardId
The shard ID for an individual record result.
String errorCode
The error code for an individual record result. ErrorCodes
can be either ProvisionedThroughputExceededException or
InternalFailure.
String errorMessage
The error message for an individual record result. An
ErrorCode value of
ProvisionedThroughputExceededException has an error message
that includes the account ID, stream name, and shard ID. An
ErrorCode value of InternalFailure has the
error message "Internal Service Failure".
String sequenceNumber
The unique identifier of the record in the stream.
Date approximateArrivalTimestamp
The approximate time that the record was inserted into the stream.
ByteBuffer data
The data blob. The data in the blob is both opaque and immutable to the Amazon Kinesis service, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).
String partitionKey
Identifies which shard in the stream the data record is assigned to.
String streamName
The name of the stream.
com.amazonaws.internal.SdkInternalList<T> tagKeys
A list of tag keys. Each corresponding tag is removed from the stream.
String shardId
The unique identifier of the shard within the Amazon Kinesis stream.
String parentShardId
The shard Id of the shard's parent.
String adjacentParentShardId
The shard Id of the shard adjacent to the shard's parent.
HashKeyRange hashKeyRange
The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
SequenceNumberRange sequenceNumberRange
The range of possible sequence numbers for the shard.
String streamName
The name of the stream for the shard split.
String shardToSplit
The shard ID of the shard to split.
String newStartingHashKey
A hash key value for the starting hash key of one of the child shards
created by the split. The hash key range for a given shard constitutes a
set of ordered contiguous positive integers. The value for
NewStartingHashKey must be in the range of hash keys being
mapped into the shard. The NewStartingHashKey hash key value
and all higher hash key values in hash key range are distributed to one
of the child shards. All the lower hash key values in the range are
distributed to the other child shard.
String streamName
The name of the stream being described.
String streamARN
The Amazon Resource Name (ARN) for the stream being described.
String streamStatus
The current status of the stream being described.
The stream status is one of the following states:
CREATING - The stream is being created. Amazon Kinesis
immediately returns and sets StreamStatus to
CREATING.DELETING - The stream is being deleted. The specified
stream is in the DELETING state until Amazon Kinesis
completes the deletion.ACTIVE - The stream exists and is ready for read and
write operations or deletion. You should perform read and write
operations only on an ACTIVE stream.UPDATING - Shards in the stream are being merged or
split. Read and write operations continue to work while the stream is in
the UPDATING state.com.amazonaws.internal.SdkInternalList<T> shards
The shards that comprise the stream.
Boolean hasMoreShards
If set to true, more shards in the stream are available to
describe.
Integer retentionPeriodHours
The current retention period, in hours.
String key
A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
String value
An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
Integer sizeInMBs
Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
We recommend setting SizeInMBs to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec set SizeInMBs to be 10 MB or higher.
Integer intervalInSeconds
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.
String dataTableName
The name of the target table. The table must already exist in the database.
String dataTableColumns
A comma-separated list of column names.
String copyOptions
Optional parameters to use with the Amazon Redshift COPY
command. For more information, see the "Optional Parameters" section of
Amazon
Redshift COPY command. Some possible examples that would apply to
Amazon Kinesis Firehose are as follows.
delimiter '\t' lzop; - fields are delimited with "\t" (TAB
character) and compressed using lzop.
delimiter '| - fields are delimited with "|" (this is the
default delimiter).
delimiter '|' escape - the delimiter should be escaped.
fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6'
- fields are fixed width in the source, with each width specified after
every column in the table.
JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format,
and the path specified is the format of the data.
For more examples, see and Amazon Redshift COPY command exmaples.
String deliveryStreamName
The name of the delivery stream.
S3DestinationConfiguration s3DestinationConfiguration
The destination in Amazon S3. This value must be specified if
RedshiftDestinationConfiguration is specified (see
restrictions listed above).
RedshiftDestinationConfiguration redshiftDestinationConfiguration
The destination in Amazon Redshift. This value cannot be specified if Amazon S3 is the desired destination (see restrictions listed above).
String deliveryStreamARN
The ARN of the delivery stream.
String deliveryStreamName
The name of the delivery stream.
String deliveryStreamName
The name of the delivery stream.
String deliveryStreamARN
The Amazon Resource Name (ARN) of the delivery stream.
String deliveryStreamStatus
The status of the delivery stream.
String versionId
Used when calling the UpdateDestination operation. Each time the destination is updated for the delivery stream, the VersionId is changed, and the current VersionId is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.
Date createTimestamp
The date and time that the delivery stream was created.
Date lastUpdateTimestamp
The date and time that the delivery stream was last updated.
List<E> destinations
The destinations.
Boolean hasMoreDestinations
Indicates whether there are more destinations available to list.
String deliveryStreamName
The name of the delivery stream.
Integer limit
The limit on the number of destinations to return. Currently, you can have one destination per delivery stream.
String exclusiveStartDestinationId
Specifies the destination ID to start returning the destination information. Currently Amazon Kinesis Firehose supports one destination per delivery stream.
DeliveryStreamDescription deliveryStreamDescription
Information about the delivery stream.
String destinationId
The ID of the destination.
S3DestinationDescription s3DestinationDescription
The Amazon S3 destination.
RedshiftDestinationDescription redshiftDestinationDescription
The destination in Amazon Redshift.
String noEncryptionConfig
Specifically override existing encryption information to ensure no encryption is used.
KMSEncryptionConfig kMSEncryptionConfig
The encryption key.
String aWSKMSKeyARN
The ARN of the encryption key. Must belong to the same region as the destination Amazon S3 bucket.
String recordId
The ID of the record.
ByteBuffer data
The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KB.
String roleARN
The ARN of the AWS credentials.
String clusterJDBCURL
The database connection string.
CopyCommand copyCommand
The COPY command.
String username
The name of the user.
String password
The user password.
S3DestinationConfiguration s3Configuration
The S3 configuration for the intermediate location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream.
The compression formats SNAPPY or ZIP cannot be
specified in
RedshiftDestinationConfiguration.S3Configuration because the
Amazon Redshift COPY operation that reads from the S3 bucket
doesn't support these compression formats.
String roleARN
The ARN of the AWS credentials.
String clusterJDBCURL
The database connection string.
CopyCommand copyCommand
The COPY command.
String username
The name of the user.
S3DestinationDescription s3DestinationDescription
The Amazon S3 destination.
String roleARN
The ARN of the AWS credentials.
String clusterJDBCURL
The database connection string.
CopyCommand copyCommand
The COPY command.
String username
The name of the user.
String password
The user password.
S3DestinationUpdate s3Update
The Amazon S3 destination.
The compression formats SNAPPY or ZIP cannot be
specified in RedshiftDestinationUpdate.S3Update because the
Amazon Redshift COPY operation that reads from the S3 bucket
doesn't support these compression formats.
String roleARN
The ARN of the AWS credentials.
String bucketARN
The ARN of the S3 bucket.
String prefix
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the guide-fh-dev.
BufferingHints bufferingHints
The buffering option. If no value is specified,
BufferingHints object default values are used.
String compressionFormat
The compression format. If no value is specified, the default is
UNCOMPRESSED.
The compression formats SNAPPY or ZIP cannot be
specified for Amazon Redshift destinations because they are not supported
by the Amazon Redshift COPY operation that reads from the S3
bucket.
EncryptionConfiguration encryptionConfiguration
The encryption configuration. If no value is specified, the default is no encryption.
String roleARN
The ARN of the AWS credentials.
String bucketARN
The ARN of the S3 bucket.
String prefix
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the guide-fh-dev.
BufferingHints bufferingHints
The buffering option. If no value is specified,
BufferingHints object default values are used.
String compressionFormat
The compression format. If no value is specified, the default is
NOCOMPRESSION.
EncryptionConfiguration encryptionConfiguration
The encryption configuration. If no value is specified, the default is no encryption.
String roleARN
The ARN of the AWS credentials.
String bucketARN
The ARN of the S3 bucket.
String prefix
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the guide-fh-dev.
BufferingHints bufferingHints
The buffering option. If no value is specified,
BufferingHints object default values are used.
String compressionFormat
The compression format. If no value is specified, the default is
NOCOMPRESSION.
The compression formats SNAPPY or ZIP cannot be
specified for Amazon Redshift destinations because they are not supported
by the Amazon Redshift COPY operation that reads from the S3
bucket.
EncryptionConfiguration encryptionConfiguration
The encryption configuration. If no value is specified, the default is no encryption.
String deliveryStreamName
The name of the delivery stream.
String currentDeliveryStreamVersionId
Obtain this value from the VersionId result of the
DeliveryStreamDescription operation. This value is required, and
helps the service to perform conditional operations. For example, if
there is a interleaving update and this value is null, then the update
destination fails. After the update is successful, the
VersionId value is updated. The service then performs a
merge of the old configuration with the new configuration.
String destinationId
The ID of the destination.
S3DestinationUpdate s3DestinationUpdate
RedshiftDestinationUpdate redshiftDestinationUpdate
String keyId
The unique identifier for the customer master key (CMK) for which to cancel deletion.
To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
String keyId
The unique identifier of the master key for which deletion is canceled.
String aliasName
String that contains the display name. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved.
String targetKeyId
An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key.
String keyId
The unique identifier for the customer master key (CMK) that the grant applies to.
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
String granteePrincipal
The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
String retiringPrincipal
The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
com.amazonaws.internal.SdkInternalList<T> operations
A list of operations that the grant permits. The list can contain any combination of one or more of the following values:
GrantConstraints constraints
The conditions under which the operations permitted by the grant are allowed.
You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
com.amazonaws.internal.SdkInternalList<T> grantTokens
A list of grant tokens.
For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
String name
A friendly name for identifying the grant. Use this value to prevent unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result
in a new grant with a unique GrantId even if all the
supplied parameters are identical. This can result in unintended
duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant
request with identical parameters; if the grant already exists, the
original GrantId is returned without creating a new grant.
Note that the returned grant token is unique with every
CreateGrant request, even when a duplicate
GrantId is returned. All grant tokens obtained in this way
can be used interchangeably.
String grantToken
The grant token.
For more information about using grant tokens, see Grant Tokens in the AWS Key Management Service Developer Guide.
String grantId
The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant
or RevokeGrant operation.
String policy
Policy to attach to the key. This is required and delegates back to the account. The key is the root of trust. The policy size limit is 32 KiB (32768 bytes).
String description
Description of the key. We recommend that you choose a description that helps your customer decide whether the key is appropriate for a task.
String keyUsage
Specifies the intended use of the key. Currently this defaults to ENCRYPT/DECRYPT, and only symmetric encryption and decryption are supported.
KeyMetadata keyMetadata
Metadata associated with the key.
ByteBuffer ciphertextBlob
Ciphertext to be decrypted. The blob includes metadata.
com.amazonaws.internal.SdkInternalMap<K,V> encryptionContext
The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.
com.amazonaws.internal.SdkInternalList<T> grantTokens
A list of grant tokens.
For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
String keyId
ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.
ByteBuffer plaintext
Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.
String aliasName
The alias to be deleted. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved.
String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".
com.amazonaws.internal.SdkInternalList<T> grantTokens
A list of grant tokens.
For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
KeyMetadata keyMetadata
Metadata associated with the key.
String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".
ByteBuffer plaintext
Data to be encrypted.
com.amazonaws.internal.SdkInternalMap<K,V> encryptionContext
Name/value pair that specifies the encryption context to be used for
authenticated encryption. If used here, the same value must be supplied
to the Decrypt API or decryption will fail. For more
information, see Encryption Context.
com.amazonaws.internal.SdkInternalList<T> grantTokens
A list of grant tokens.
For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
ByteBuffer ciphertextBlob
The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
String keyId
The ID of the key used during encryption.
String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".
com.amazonaws.internal.SdkInternalMap<K,V> encryptionContext
Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.
Integer numberOfBytes
Integer that contains the number of bytes to generate. Common values are
128, 256, 512, and 1024. 1024 is the current limit. We recommend that you
use the KeySpec parameter instead.
String keySpec
Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.
com.amazonaws.internal.SdkInternalList<T> grantTokens
A list of grant tokens.
For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
ByteBuffer ciphertextBlob
Ciphertext that contains the encrypted data key. You must store the blob and enough information to reconstruct the encryption context so that the data encrypted by using the key can later be decrypted. You must provide both the ciphertext blob and the encryption context to the Decrypt API to recover the plaintext data key and decrypt the object.
If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
ByteBuffer plaintext
Plaintext that contains the data key. Use this for encryption and decryption and then remove it from memory as soon as possible.
String keyId
System generated unique identifier of the key to be used to decrypt the encrypted copy of the data key.
String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".
com.amazonaws.internal.SdkInternalMap<K,V> encryptionContext
Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.
String keySpec
Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.
Integer numberOfBytes
Integer that contains the number of bytes to generate. Common values are
128, 256, 512, 1024 and so on. We recommend that you use the
KeySpec parameter instead.
com.amazonaws.internal.SdkInternalList<T> grantTokens
A list of grant tokens.
For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
ByteBuffer ciphertextBlob
Ciphertext that contains the wrapped data key. You must store the blob and encryption context so that the key can be used in a future decrypt operation.
If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
String keyId
System generated unique identifier of the key to be used to decrypt the encrypted copy of the data key.
Integer numberOfBytes
Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. The current limit is 1024 bytes.
ByteBuffer plaintext
Plaintext that contains the unpredictable byte string.
String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
String policyName
String that contains the name of the policy. Currently, this must be "default". Policy names can be discovered by calling ListKeyPolicies.
String policy
A policy document in JSON format.
String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
Boolean keyRotationEnabled
A Boolean value that specifies whether key rotation is enabled.
com.amazonaws.internal.SdkInternalMap<K,V> encryptionContextSubset
Contains a list of key-value pairs, a subset of which must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list or is a subset of this list, the grant allows the operation. Otherwise, the operation is not allowed.
com.amazonaws.internal.SdkInternalMap<K,V> encryptionContextEquals
Contains a list of key-value pairs that must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list, the grant allows the operation. Otherwise, the operation is not allowed.
String keyId
The unique identifier for the customer master key (CMK) to which the grant applies.
String grantId
The unique identifier for the grant.
String name
The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.
Date creationDate
The date and time when the grant was created.
String granteePrincipal
The principal that receives the grant's permissions.
String retiringPrincipal
The principal that can retire the grant.
String issuingAccount
The AWS account under which the grant was issued.
com.amazonaws.internal.SdkInternalList<T> operations
The list of operations permitted by the grant.
GrantConstraints constraints
The conditions under which the grant's operations are allowed.
String aWSAccountId
The twelve-digit account ID of the AWS account that owns the key.
String keyId
The globally unique identifier for the key.
String arn
The Amazon Resource Name (ARN) of the key. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.
Date creationDate
The date and time when the key was created.
Boolean enabled
Specifies whether the key is enabled. When KeyState is
Enabled this value is true, otherwise it is false.
String description
The friendly description of the key.
String keyUsage
String keyState
The state of the customer master key (CMK).
For more information about how key state affects the use of a CMK, go to How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Date deletionDate
The date and time after which AWS KMS deletes the customer master key
(CMK). This value is present only when KeyState is
PendingDeletion, otherwise this value is null.
Integer limit
When paginating results, specify the maximum number of items to return in
the response. If additional items exist beyond the number you specify,
the Truncated element in the response is set to true.
This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
String marker
Use this parameter only when paginating results and only in a subsequent
request after you've received a response with truncated results. Set it
to the value of NextMarker from the response you just
received.
com.amazonaws.internal.SdkInternalList<T> aliases
A list of key aliases in the user's account.
String nextMarker
When Truncated is true, this value is present and contains
the value to use for the Marker parameter in a subsequent
pagination request.
Boolean truncated
A flag that indicates whether there are more items in the list. If your
results were truncated, you can use the Marker parameter to
make a subsequent pagination request to retrieve more items in the list.
Integer limit
When paginating results, specify the maximum number of items to return in
the response. If additional items exist beyond the number you specify,
the Truncated element in the response is set to true.
This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
String marker
Use this parameter only when paginating results and only in a subsequent
request after you've received a response with truncated results. Set it
to the value of NextMarker from the response you just
received.
String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
com.amazonaws.internal.SdkInternalList<T> grants
A list of grants.
String nextMarker
When Truncated is true, this value is present and contains
the value to use for the Marker parameter in a subsequent
pagination request.
Boolean truncated
A flag that indicates whether there are more items in the list. If your
results were truncated, you can use the Marker parameter to
make a subsequent pagination request to retrieve more items in the list.
String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".
Integer limit
When paginating results, specify the maximum number of items to return in
the response. If additional items exist beyond the number you specify,
the Truncated element in the response is set to true.
This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.
Currently only 1 policy can be attached to a key.
String marker
Use this parameter only when paginating results and only in a subsequent
request after you've received a response with truncated results. Set it
to the value of NextMarker from the response you just
received.
com.amazonaws.internal.SdkInternalList<T> policyNames
A list of policy names. Currently, there is only one policy and it is named "Default".
String nextMarker
When Truncated is true, this value is present and contains
the value to use for the Marker parameter in a subsequent
pagination request.
Boolean truncated
A flag that indicates whether there are more items in the list. If your
results were truncated, you can use the Marker parameter to
make a subsequent pagination request to retrieve more items in the list.
Integer limit
When paginating results, specify the maximum number of items to return in
the response. If additional items exist beyond the number you specify,
the Truncated element in the response is set to true.
This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.
String marker
Use this parameter only when paginating results and only in a subsequent
request after you've received a response with truncated results. Set it
to the value of NextMarker from the response you just
received.
com.amazonaws.internal.SdkInternalList<T> keys
A list of keys.
String nextMarker
When Truncated is true, this value is present and contains
the value to use for the Marker parameter in a subsequent
pagination request.
Boolean truncated
A flag that indicates whether there are more items in the list. If your
results were truncated, you can use the Marker parameter to
make a subsequent pagination request to retrieve more items in the list.
Integer limit
When paginating results, specify the maximum number of items to return in
the response. If additional items exist beyond the number you specify,
the Truncated element in the response is set to true.
This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
String marker
Use this parameter only when paginating results and only in a subsequent
request after you've received a response with truncated results. Set it
to the value of NextMarker from the response you just
received.
String retiringPrincipal
The retiring principal for which to list grants.
To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, go to AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
com.amazonaws.internal.SdkInternalList<T> grants
A list of grants.
String nextMarker
When Truncated is true, this value is present and contains
the value to use for the Marker parameter in a subsequent
pagination request.
Boolean truncated
A flag that indicates whether there are more items in the list. If your
results were truncated, you can use the Marker parameter to
make a subsequent pagination request to retrieve more items in the list.
String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
String policyName
Name of the policy to be attached. Currently, the only supported name is "default".
String policy
The policy to attach to the key. This is required and delegates back to the account. The key is the root of trust. The policy size limit is 32 KiB (32768 bytes).
ByteBuffer ciphertextBlob
Ciphertext of the data to re-encrypt.
com.amazonaws.internal.SdkInternalMap<K,V> sourceEncryptionContext
Encryption context used to encrypt and decrypt the data specified in the
CiphertextBlob parameter.
String destinationKeyId
A unique identifier for the customer master key used to re-encrypt the data. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".
com.amazonaws.internal.SdkInternalMap<K,V> destinationEncryptionContext
Encryption context to be used when the data is re-encrypted.
com.amazonaws.internal.SdkInternalList<T> grantTokens
A list of grant tokens.
For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
ByteBuffer ciphertextBlob
The re-encrypted data. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
String sourceKeyId
Unique identifier of the key used to originally encrypt the data.
String keyId
Unique identifier of the key used to re-encrypt the data.
String grantToken
Token that identifies the grant to be retired.
String keyId
A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or a fully specified ARN of the key.
String grantId
Unique identifier of the grant to be retired. The grant ID is returned by
the CreateGrant function.
String keyId
A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or the fully specified ARN to a key.
String grantId
Identifier of the grant to be revoked.
String keyId
The unique identifier for the customer master key (CMK) to delete.
To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
Integer pendingWindowInDays
The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).
This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.
String aliasName
String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.
String targetKeyId
Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.
You can call ListAliases to verify that the alias is mapped to the
correct TargetKeyId.
String keyId
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
String description
New description for the key.
boolean handled
String type
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String statementId
Constraints:
Length: 1 - 100
Pattern: ([a-zA-Z0-9-_]+)
String action
Constraints:
Pattern: (lambda:[*]|lambda:[a-zA-Z]+|[*])
String principal
Constraints:
Pattern: .*
String sourceArn
Constraints:
Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)
String sourceAccount
SourceArn identifies a bucket, then this
is the bucket owner's account ID. You can use this additional
condition to ensure the bucket you specify is owned by a specific
account (it is possible the bucket owner deleted the bucket and some
other AWS account created the bucket). You can also use this condition
to specify all sources (that is, you don't specify the
SourceArn) owned by a specific account.
Constraints:
Pattern: \d{12}
String qualifier
arn:aws:lambda:aws-region:acct-id:function:function-name:2
If you specify alias name, for example "PROD", then the permission is valid only for requests made using the alias ARN:
arn:aws:lambda:aws-region:acct-id:function:function-name:PROD
If the qualifier is not specified, the permission is valid only when requests is made using unqualified function ARN.
arn:aws:lambda:aws-region:acct-id:function:function-name
Constraints:
Length: 1 - 128
Pattern: (|[a-zA-Z0-9$_]+)
String statement
String aliasArn
arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA.
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?
String name
Constraints:
Length: 1 - 128
Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+)
String functionVersion
Constraints:
Length: 1 - 1024
Pattern: (\$LATEST|[0-9]+)
String description
Constraints:
Length: 0 - 256
String type
String functionName
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String name
Constraints:
Length: 1 - 128
Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+)
String functionVersion
Constraints:
Length: 1 - 1024
Pattern: (\$LATEST|[0-9]+)
String description
Constraints:
Length: 0 - 256
String aliasArn
arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA.
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?
String name
Constraints:
Length: 1 - 128
Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+)
String functionVersion
Constraints:
Length: 1 - 1024
Pattern: (\$LATEST|[0-9]+)
String description
Constraints:
Length: 0 - 256
String eventSourceArn
BatchSize. AWS Lambda POSTs the Amazon
Kinesis event, containing records, to your Lambda function as JSON.
Constraints:
Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
Boolean enabled
Enabled is true.Integer batchSize
Constraints:
Range: 1 - 10000
String startingPosition
Constraints:
Allowed Values: TRIM_HORIZON, LATEST
String uUID
Integer batchSize
Constraints:
Range: 1 - 10000
String eventSourceArn
Constraints:
Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)
String functionArn
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?
Date lastModified
String lastProcessingResult
String state
String stateTransitionReason
String functionName
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String runtime
Constraints:
Allowed Values: nodejs, java8, python2.7
String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
String handler
package.class-name::handler
or package.class-name. For more information, see Lambda
Function Handler (Java).
Constraints:
Length: 0 - 128
Pattern: [^\s]+
FunctionCode code
String description
Constraints:
Length: 0 - 256
Integer timeout
Constraints:
Range: 1 -
Integer memorySize
Constraints:
Range: 128 - 1536
Boolean publish
String functionName
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String functionArn
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?
String runtime
Constraints:
Allowed Values: nodejs, java8, python2.7
String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
String handler
Constraints:
Length: 0 - 128
Pattern: [^\s]+
Long codeSize
String description
Constraints:
Length: 0 - 256
Integer timeout
Constraints:
Range: 1 -
Integer memorySize
Constraints:
Range: 128 - 1536
String lastModified
String codeSha256
String version
Constraints:
Length: 1 - 1024
Pattern: (\$LATEST|[0-9]+)
String functionName
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String name
Constraints:
Length: 1 - 128
Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+)
String uUID
String uUID
Integer batchSize
Constraints:
Range: 1 - 10000
String eventSourceArn
Constraints:
Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)
String functionArn
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?
Date lastModified
String lastProcessingResult
String state
String stateTransitionReason
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String qualifier
You can only specify a function version and not alias name using this parameter. You cannot delete a function version using its alias.
If you don't specify this parameter, AWS Lambda will delete the function, including all its versions and aliases.
Constraints:
Length: 1 - 128
Pattern: (|[a-zA-Z0-9$_]+)
String uUID
Integer batchSize
Constraints:
Range: 1 - 10000
String eventSourceArn
Constraints:
Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)
String functionArn
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?
Date lastModified
String lastProcessingResult
String state
String stateTransitionReason
ByteBuffer zipFile
String s3Bucket
Constraints:
Length: 3 - 63
Pattern: ^[0-9A-Za-z\.\-_]*(?
String s3Key
Constraints:
Length: 1 - 1024
String s3ObjectVersion
Constraints:
Length: 1 - 1024
String functionName
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String functionArn
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?
String runtime
Constraints:
Allowed Values: nodejs, java8, python2.7
String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
String handler
Constraints:
Length: 0 - 128
Pattern: [^\s]+
Long codeSize
String description
Constraints:
Length: 0 - 256
Integer timeout
Constraints:
Range: 1 -
Integer memorySize
Constraints:
Range: 128 - 1536
String lastModified
String codeSha256
String version
Constraints:
Length: 1 - 1024
Pattern: (\$LATEST|[0-9]+)
String functionName
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String name
Constraints:
Length: 1 - 128
Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+)
String aliasArn
arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA.
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?
String name
Constraints:
Length: 1 - 128
Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+)
String functionVersion
Constraints:
Length: 1 - 1024
Pattern: (\$LATEST|[0-9]+)
String description
Constraints:
Length: 0 - 256
String uUID
String uUID
Integer batchSize
Constraints:
Range: 1 - 10000
String eventSourceArn
Constraints:
Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)
String functionArn
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?
Date lastModified
String lastProcessingResult
String state
String stateTransitionReason
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String qualifier
If you don't specify this parameter, the API uses unqualified function ARN, and returns information about the $LATEST function version.
Constraints:
Length: 1 - 128
Pattern: (|[a-zA-Z0-9$_]+)
String functionName
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String functionArn
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?
String runtime
Constraints:
Allowed Values: nodejs, java8, python2.7
String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
String handler
Constraints:
Length: 0 - 128
Pattern: [^\s]+
Long codeSize
String description
Constraints:
Length: 0 - 256
Integer timeout
Constraints:
Range: 1 -
Integer memorySize
Constraints:
Range: 128 - 1536
String lastModified
String codeSha256
String version
Constraints:
Length: 1 - 1024
Pattern: (\$LATEST|[0-9]+)
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String qualifier
Constraints:
Length: 1 - 128
Pattern: (|[a-zA-Z0-9$_]+)
FunctionConfiguration configuration
FunctionCodeLocation code
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String qualifier
Constraints:
Length: 1 - 128
Pattern: (|[a-zA-Z0-9$_]+)
String policy
String type
String type
String functionName
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
InputStream invokeArgs
Integer status
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String invocationType
Invoke API assumes "RequestResponse"
invocation type. You can optionally request asynchronous execution by
specifying "Event" as the InvocationType. You can also
use this parameter to request AWS Lambda to not execute the function
but do some verification, such as if the caller is authorized to
invoke the function and if the inputs are valid. You request this by
specifying "DryRun" as the InvocationType. This is useful
in a cross-account scenario when you want to verify access to a
function without running it.
Constraints:
Allowed Values: Event, RequestResponse, DryRun
String logType
InvocationType parameter with value
"RequestResponse". In this case, AWS Lambda returns the base64-encoded
last 4 KB of log data produced by your Lambda function in the
x-amz-log-results header.
Constraints:
Allowed Values: None, Tail
String clientContext
ClientContext you can pass client-specific
information to the Lambda function you are invoking. You can then
process the client information in your Lambda function as you choose
through the context variable. For an example of a ClientContext JSON,
go to PutEvents
in the Amazon Mobile Analytics API Reference and User Guide.
The ClientContext JSON must be base64-encoded.
ByteBuffer payload
String qualifier
If you don't provide this parameter, then the API uses unqualified function ARN which results in invocation of the $LATEST version.
Constraints:
Length: 1 - 128
Pattern: (|[a-zA-Z0-9$_]+)
Integer statusCode
String functionError
Handled or Unhandled. Handled
errors are errors that are reported by the function while the
Unhandled errors are those detected and reported by AWS
Lambda. Unhandled errors include out of memory errors and function
timeouts. For information about how to report an Handled
error, see Programming
Model.String logResult
ByteBuffer payload
In the event of a function error this field
contains a message describing the error. For the Handled
errors the Lambda function will report this message. For
Unhandled errors AWS Lambda reports the message.
String functionName
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String functionVersion
Constraints:
Length: 1 - 1024
Pattern: (\$LATEST|[0-9]+)
String marker
Integer maxItems
Constraints:
Range: 1 - 10000
String nextMarker
com.amazonaws.internal.ListWithAutoConstructFlag<T> aliases
String eventSourceArn
Constraints:
Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String marker
ListEventSourceMappings operation. If present, specifies
to continue the list from where the returning call left off.Integer maxItems
Constraints:
Range: 1 - 10000
String nextMarker
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventSourceMappings
EventSourceMappingConfiguration objects.String marker
ListFunctions operation. If present, indicates where to
continue the listing.Integer maxItems
Constraints:
Range: 1 - 10000
String nextMarker
com.amazonaws.internal.ListWithAutoConstructFlag<T> functions
String functionName
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String marker
ListVersionsByFunction operation. If present, indicates
where to continue the listing.Integer maxItems
Constraints:
Range: 1 - 10000
String nextMarker
com.amazonaws.internal.ListWithAutoConstructFlag<T> versions
String type
String functionName
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String codeSha256
String description
Constraints:
Length: 0 - 256
String functionName
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String functionArn
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?
String runtime
Constraints:
Allowed Values: nodejs, java8, python2.7
String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
String handler
Constraints:
Length: 0 - 128
Pattern: [^\s]+
Long codeSize
String description
Constraints:
Length: 0 - 256
Integer timeout
Constraints:
Range: 1 -
Integer memorySize
Constraints:
Range: 128 - 1536
String lastModified
String codeSha256
String version
Constraints:
Length: 1 - 1024
Pattern: (\$LATEST|[0-9]+)
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String statementId
Constraints:
Length: 1 - 100
Pattern: ([a-zA-Z0-9-_]+)
String qualifier
Constraints:
Length: 1 - 128
Pattern: (|[a-zA-Z0-9$_]+)
String type
String type
String type
String type
String type
String functionName
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String name
Constraints:
Length: 1 - 128
Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+)
String functionVersion
Constraints:
Length: 1 - 1024
Pattern: (\$LATEST|[0-9]+)
String description
Constraints:
Length: 0 - 256
String aliasArn
arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA.
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?
String name
Constraints:
Length: 1 - 128
Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+)
String functionVersion
Constraints:
Length: 1 - 1024
Pattern: (\$LATEST|[0-9]+)
String description
Constraints:
Length: 0 - 256
String uUID
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
Boolean enabled
Integer batchSize
Constraints:
Range: 1 - 10000
String uUID
Integer batchSize
Constraints:
Range: 1 - 10000
String eventSourceArn
Constraints:
Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)
String functionArn
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?
Date lastModified
String lastProcessingResult
String state
String stateTransitionReason
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
ByteBuffer zipFile
String s3Bucket
Constraints:
Length: 3 - 63
Pattern: ^[0-9A-Za-z\.\-_]*(?
String s3Key
Constraints:
Length: 1 - 1024
String s3ObjectVersion
Constraints:
Length: 1 - 1024
Boolean publish
String functionName
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String functionArn
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?
String runtime
Constraints:
Allowed Values: nodejs, java8, python2.7
String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
String handler
Constraints:
Length: 0 - 128
Pattern: [^\s]+
Long codeSize
String description
Constraints:
Length: 0 - 256
Integer timeout
Constraints:
Range: 1 -
Integer memorySize
Constraints:
Range: 128 - 1536
String lastModified
String codeSha256
String version
Constraints:
Length: 1 - 1024
Pattern: (\$LATEST|[0-9]+)
String functionName
You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
String handler
Constraints:
Length: 0 - 128
Pattern: [^\s]+
String description
Constraints:
Length: 0 - 256
Integer timeout
Constraints:
Range: 1 -
Integer memorySize
Constraints:
Range: 128 - 1536
String functionName
Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
String functionArn
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?
String runtime
Constraints:
Allowed Values: nodejs, java8, python2.7
String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
String handler
Constraints:
Length: 0 - 128
Pattern: [^\s]+
Long codeSize
String description
Constraints:
Length: 0 - 256
Integer timeout
Constraints:
Range: 1 -
Integer memorySize
Constraints:
Range: 128 - 1536
String lastModified
String codeSha256
String version
Constraints:
Length: 1 - 1024
Pattern: (\$LATEST|[0-9]+)
String taskId
Id of the export task to cancel.
String taskName
The name of the export task.
String logGroupName
The name of the log group to export.
String logStreamNamePrefix
Will only export log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.
Long from
A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. It indicates the start time of the range for the request. Events with a timestamp prior to this time will not be exported.
Long to
A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. It indicates the end time of the range for the request. Events with a timestamp later than this time will not be exported.
String destination
Name of Amazon S3 bucket to which the log data will be exported.
NOTE: Only buckets in the same AWS region are supported
String destinationPrefix
Prefix that will be used as the start of Amazon S3 key for every object exported. If not specified, this defaults to 'exportedlogs'.
String taskId
Id of the export task that got created.
String logGroupName
The name of the log group to create.
String expectedSequenceToken
String destinationName
The name of destination to delete.
String logGroupName
The name of the log group to delete.
String logGroupName
The name of the log group that is associated with the retention policy to delete.
com.amazonaws.internal.SdkInternalList<T> destinations
String nextToken
String taskId
Export task that matches the specified task Id will be returned. This can result in zero or one export task.
String statusCode
All export tasks that matches the specified status code will be returned. This can return zero or more export tasks.
String nextToken
A string token used for pagination that points to the next page of
results. It must be a value obtained from the response of the previous
DescribeExportTasks request.
Integer limit
The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
com.amazonaws.internal.SdkInternalList<T> exportTasks
String nextToken
String logGroupNamePrefix
Will only return log groups that match the provided logGroupNamePrefix. If you don't specify a value, no prefix filter is applied.
String nextToken
A string token used for pagination that points to the next page of
results. It must be a value obtained from the response of the previous
DescribeLogGroups request.
Integer limit
The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
com.amazonaws.internal.SdkInternalList<T> logGroups
String nextToken
String logGroupName
The log group name for which log streams are to be listed.
String logStreamNamePrefix
Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.
String orderBy
Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.
Boolean descending
If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.
String nextToken
A string token used for pagination that points to the next page of
results. It must be a value obtained from the response of the previous
DescribeLogStreams request.
Integer limit
The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
com.amazonaws.internal.SdkInternalList<T> logStreams
String nextToken
String logGroupName
The log group name for which metric filters are to be listed.
String filterNamePrefix
Will only return metric filters that match the provided filterNamePrefix. If you don't specify a value, no prefix filter is applied.
String nextToken
A string token used for pagination that points to the next page of
results. It must be a value obtained from the response of the previous
DescribeMetricFilters request.
Integer limit
The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
com.amazonaws.internal.SdkInternalList<T> metricFilters
String nextToken
String logGroupName
The log group name for which subscription filters are to be listed.
String filterNamePrefix
Will only return subscription filters that match the provided filterNamePrefix. If you don't specify a value, no prefix filter is applied.
String nextToken
Integer limit
com.amazonaws.internal.SdkInternalList<T> subscriptionFilters
String nextToken
String destinationName
Name of the destination.
String targetArn
ARN of the physical target where the log events will be delivered (eg. ARN of a Kinesis stream).
String roleArn
A role for impersonation for delivering log events to the target.
String accessPolicy
An IAM policy document that governs which AWS accounts can create subscription filters against this destination.
String arn
ARN of this destination.
Long creationTime
A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC specifying when this destination was created.
String taskId
Id of the export task.
String taskName
The name of the export task.
String logGroupName
The name of the log group from which logs data was exported.
Long from
A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp prior to this time are not exported.
Long to
A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.
String destination
Name of Amazon S3 bucket to which the log data was exported.
String destinationPrefix
Prefix that was used as the start of Amazon S3 key for every object exported.
ExportTaskStatus status
Status of the export task.
ExportTaskExecutionInfo executionInfo
Execution info about the export task.
String logGroupName
The name of the log group to query.
com.amazonaws.internal.SdkInternalList<T> logStreamNames
Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.
Long startTime
A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp prior to this time are not returned.
Long endTime
A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp later than this time are not returned.
String filterPattern
A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.
String nextToken
A pagination token obtained from a
FilterLogEvents response to continue paginating
the FilterLogEvents results. This token is omitted from the response when
there are no other events to display.
Integer limit
The maximum number of events to return in a page of results. Default is 10,000 events.
Boolean interleaved
If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.
com.amazonaws.internal.SdkInternalList<T> events
A list of FilteredLogEvent objects representing
the matched events from the request.
com.amazonaws.internal.SdkInternalList<T> searchedLogStreams
A list of SearchedLogStream objects indicating
which log streams have been searched in this request and whether each has
been searched completely or still has more to be paginated.
String nextToken
A pagination token obtained from a
FilterLogEvents response to continue paginating
the FilterLogEvents results. This token is omitted from the response when
there are no other events to display.
String logGroupName
The name of the log group to query.
String logStreamName
The name of the log stream to query.
Long startTime
Long endTime
String nextToken
A string token used for pagination that points to the next page of
results. It must be a value obtained from the
nextForwardToken or
nextBackwardToken fields in the response of the
previous GetLogEvents request.
Integer limit
The maximum number of log events returned in the response. If you don't specify a value, the request would return as many log events as can fit in a response size of 1MB, up to 10,000 log events.
Boolean startFromHead
If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).
com.amazonaws.internal.SdkInternalList<T> events
String nextForwardToken
String nextBackwardToken
String expectedSequenceToken
String filterName
String filterPattern
com.amazonaws.internal.SdkInternalList<T> metricTransformations
Long creationTime
Long eventNumber
String eventMessage
com.amazonaws.internal.SdkInternalMap<K,V> extractedValues
String destinationName
A name for the destination.
String targetArn
The ARN of an Amazon Kinesis stream to deliver matching log events to.
String roleArn
The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to do Amazon Kinesis PutRecord requests on the desitnation stream.
Destination destination
String logGroupName
The name of the log group to put log events to.
String logStreamName
The name of the log stream to put log events to.
com.amazonaws.internal.SdkInternalList<T> logEvents
String sequenceToken
A string token that must be obtained from the response of the previous
PutLogEvents request.
String nextSequenceToken
RejectedLogEventsInfo rejectedLogEventsInfo
String logGroupName
The name of the log group to associate the metric filter with.
String filterName
A name for the metric filter.
String filterPattern
A valid CloudWatch Logs filter pattern for extracting metric data out of ingested log events.
com.amazonaws.internal.SdkInternalList<T> metricTransformations
A collection of information needed to define how metric data gets emitted.
String logGroupName
The name of the log group to associate the subscription filter with.
String filterName
A name for the subscription filter.
String filterPattern
A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events.
String destinationArn
The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:
Destination)
belonging to a different account, for cross-account delivery.String roleArn
The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to
deliver ingested log events to the destination stream. You don't need to
provide the ARN when you are working with a logical destination (used via
an ARN of Destination) for cross-account delivery.
String filterPattern
com.amazonaws.internal.SdkInternalList<T> logEventMessages
A list of log event messages to test.
com.amazonaws.internal.SdkInternalList<T> matches
String batchPredictionId
The ID assigned to the BatchPrediction at creation. This
value should be identical to the value of the
BatchPredictionID in the request.
String mLModelId
The ID of the MLModel that generated predictions for the
BatchPrediction request.
String batchPredictionDataSourceId
The ID of the DataSource that points to the group of
observations to predict.
String inputDataLocationS3
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
String createdByIamUser
The AWS user account that invoked the BatchPrediction. The
account type can be either an AWS root account or an AWS Identity and
Access Management (IAM) user account.
Date createdAt
The time that the BatchPrediction was created. The time is
expressed in epoch time.
Date lastUpdatedAt
The time of the most recent edit to the BatchPrediction. The
time is expressed in epoch time.
String name
A user-supplied name or description of the BatchPrediction.
String status
The status of the BatchPrediction. This element can have one
of the following values:
PENDING - Amazon Machine Learning (Amazon ML) submitted
a request to generate predictions for a batch of observations.INPROGRESS - The process is underway.FAILED - The request to peform a batch prediction did
not run to completion. It is not usable.COMPLETED - The batch prediction process completed
successfully.DELETED - The BatchPrediction is marked as
deleted. It is not usable.String outputUri
The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the s3 key portion of the "outputURI" field: ':', '//', '/./', '/../'.
String message
A description of the most recent details about processing the batch prediction request.
String batchPredictionId
A user-supplied ID that uniquely identifies the
BatchPrediction.
String batchPredictionName
A user-supplied name or description of the BatchPrediction.
BatchPredictionName can only use the UTF-8 character set.
String mLModelId
The ID of the MLModel that will generate predictions for the
group of observations.
String batchPredictionDataSourceId
The ID of the DataSource that points to the group of
observations to predict.
String outputUri
The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the "outputURI" field: ':', '//', '/./', '/../'.
Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.
String batchPredictionId
A user-supplied ID that uniquely identifies the
BatchPrediction. This value is identical to the value of the
BatchPredictionId in the request.
String dataSourceId
A user-supplied ID that uniquely identifies the DataSource.
Typically, an Amazon Resource Number (ARN) becomes the ID for a
DataSource.
String dataSourceName
A user-supplied name or description of the DataSource.
RDSDataSpec rDSData
The data specification of an Amazon RDS DataSource:
DatabaseInformation -
DatabaseName - Name of the Amazon RDS database. InstanceIdentifier - Unique identifier for the Amazon
RDS database instance.DatabaseCredentials - AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon RDS database.
ResourceRole - Role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (EC2) instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
ServiceRole - Role (DataPipelineDefaultRole) assumed by the AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon Simple Storage Service (S3). For more information, see Role templates for data pipelines.
SecurityInfo - Security information to use to access an Amazon RDS
instance. You need to set up appropriate ingress rules for the security
entity IDs provided to allow access to the Amazon RDS instance. Specify a
[SubnetId, SecurityGroupIds] pair for a
VPC-based Amazon RDS instance.
SelectSqlQuery - Query that is used to retrieve the observation data for
the Datasource.
S3StagingLocation - Amazon S3 location for staging RDS data. The data
retrieved from Amazon RDS using SelectSqlQuery is stored in
this location.
DataSchemaUri - Amazon S3 location of the DataSchema.
DataSchema - A JSON string representing the schema. This is not required
if DataSchemaUri is specified.
DataRearrangement - A JSON string representing the splitting requirement
of a Datasource.
Sample -
"{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
String roleARN
The role that Amazon ML assumes on behalf of the user to create and
activate a data pipeline in the user’s account and copy data (using the
SelectSqlQuery) query from Amazon RDS to Amazon S3.
Boolean computeStatistics
The compute statistics for a DataSource. The statistics are
generated from the observation data referenced by a
DataSource. Amazon ML uses the statistics internally during
an MLModel training. This parameter must be set to
true if the DataSource needs to be
used for MLModel training.
String dataSourceId
A user-supplied ID that uniquely identifies the datasource. This value
should be identical to the value of the DataSourceID in the
request.
String dataSourceId
A user-supplied ID that uniquely identifies the DataSource.
String dataSourceName
A user-supplied name or description of the DataSource.
RedshiftDataSpec dataSpec
The data specification of an Amazon Redshift DataSource:
DatabaseInformation -
DatabaseName - Name of the Amazon Redshift database. ClusterIdentifier - Unique ID for the Amazon Redshift
cluster.DatabaseCredentials - AWS Identity abd Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.
SelectSqlQuery - Query that is used to retrieve the observation data for
the Datasource.
S3StagingLocation - Amazon Simple Storage Service (Amazon S3) location
for staging Amazon Redshift data. The data retrieved from Amazon
Relational Database Service (Amazon RDS) using
SelectSqlQuery is stored in this location.
DataSchemaUri - Amazon S3 location of the DataSchema.
DataSchema - A JSON string representing the schema. This is not required
if DataSchemaUri is specified.
DataRearrangement - A JSON string representing the splitting requirement
of a Datasource.
Sample -
"{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
String roleARN
A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:
A security group to allow Amazon ML to execute the
SelectSqlQuery query on an Amazon Redshift cluster
An Amazon S3 bucket policy to grant Amazon ML read/write permissions on
the S3StagingLocation
Boolean computeStatistics
The compute statistics for a DataSource. The statistics are
generated from the observation data referenced by a
DataSource. Amazon ML uses the statistics internally during
MLModel training. This parameter must be set to
true if the DataSource needs to be
used for MLModel training
String dataSourceId
A user-supplied ID that uniquely identifies the datasource. This value
should be identical to the value of the DataSourceID in the
request.
String dataSourceId
A user-supplied identifier that uniquely identifies the
DataSource.
String dataSourceName
A user-supplied name or description of the DataSource.
S3DataSpec dataSpec
The data specification of a DataSource:
DataLocationS3 - Amazon Simple Storage Service (Amazon S3) location of the observation data.
DataSchemaLocationS3 - Amazon S3 location of the DataSchema.
DataSchema - A JSON string representing the schema. This is not required
if DataSchemaUri is specified.
DataRearrangement - A JSON string representing the splitting requirement
of a Datasource.
Sample -
"{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
Boolean computeStatistics
The compute statistics for a DataSource. The statistics are
generated from the observation data referenced by a
DataSource. Amazon ML uses the statistics internally during
an MLModel training. This parameter must be set to
true if the DataSource needs to be
used for MLModel training
String dataSourceId
A user-supplied ID that uniquely identifies the datasource. This value
should be identical to the value of the DataSourceID in the
request.
String evaluationId
A user-supplied ID that uniquely identifies the Evaluation.
String evaluationName
A user-supplied name or description of the Evaluation.
String mLModelId
The ID of the MLModel to evaluate.
The schema used in creating the MLModel must match the
schema of the DataSource used in the Evaluation
.
String evaluationDataSourceId
The ID of the DataSource for the evaluation. The schema of
the DataSource must match the schema used to create the
MLModel.
String evaluationId
The user-supplied ID that uniquely identifies the Evaluation
. This value should be identical to the value of the
EvaluationId in the request.
String mLModelId
A user-supplied ID that uniquely identifies the MLModel.
String mLModelName
A user-supplied name or description of the MLModel.
String mLModelType
The category of supervised learning that this MLModel will
address. Choose from the following types:
REGRESSION if the MLModel will be
used to predict a numeric value.BINARY if the MLModel result has two
possible values.MULTICLASS if the MLModel result has
a limited number of values.For more information, see the Amazon Machine Learning Developer Guide.
com.amazonaws.internal.SdkInternalMap<K,V> parameters
A list of the training parameters in the MLModel. The list
is implemented as a map of key/value pairs.
The following is the current set of training parameters:
sgd.l1RegularizationAmount - Coefficient regularization L1
norm. It controls overfitting the data by penalizing large coefficients.
This tends to drive coefficients to zero, resulting in sparse feature
set. If you use this parameter, start by specifying a small value such as
1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is
not to use L1 normalization. The parameter cannot be used when
L2 is specified. Use this parameter sparingly.
sgd.l2RegularizationAmount - Coefficient regularization L2
norm. It controls overfitting the data by penalizing large coefficients.
This tends to drive coefficients to small, nonzero values. If you use
this parameter, start by specifying a small value such as 1.0E-08.
The valuseis a double that ranges from 0 to MAX_DOUBLE. The default is
not to use L2 normalization. This cannot be used when L1 is
specified. Use this parameter sparingly.
sgd.maxPasses - Number of times that the training process
traverses the observations to build the MLModel. The value
is an integer that ranges from 1 to 10000. The default value is 10.
sgd.maxMLModelSizeInBytes - Maximum allowed size of the
model. Depending on the input data, the size of the model might affect
its performance.
The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.
String trainingDataSourceId
The DataSource that points to the training data.
String recipe
The data recipe for creating MLModel. You must specify
either the recipe or its URI. If you don’t specify a recipe or its URI,
Amazon ML creates a default.
String recipeUri
The Amazon Simple Storage Service (Amazon S3) location and file name that
contains the MLModel recipe. You must specify either the
recipe or its URI. If you don’t specify a recipe or its URI, Amazon ML
creates a default.
String mLModelId
A user-supplied ID that uniquely identifies the MLModel.
This value should be identical to the value of the MLModelId
in the request.
String mLModelId
The ID assigned to the MLModel during creation.
String mLModelId
A user-supplied ID that uniquely identifies the MLModel.
This value should be identical to the value of the MLModelId
in the request.
RealtimeEndpointInfo realtimeEndpointInfo
The endpoint information of the MLModel
String dataSourceId
The ID that is assigned to the DataSource during creation.
String dataLocationS3
The location and name of the data in Amazon Simple Storage Service
(Amazon S3) that is used by a DataSource.
String dataRearrangement
A JSON string that represents the splitting requirement of a
Datasource.
String createdByIamUser
The AWS user account from which the DataSource was created.
The account type can be either an AWS root account or an AWS Identity and
Access Management (IAM) user account.
Date createdAt
The time that the DataSource was created. The time is
expressed in epoch time.
Date lastUpdatedAt
The time of the most recent edit to the BatchPrediction. The
time is expressed in epoch time.
Long dataSizeInBytes
The total number of observations contained in the data files that the
DataSource references.
Long numberOfFiles
The number of data files referenced by the DataSource.
String name
A user-supplied name or description of the DataSource.
String status
The current status of the DataSource. This element can have
one of the following values:
DataSource.DataSource did not run
to completion. It is not usable.DataSource is marked as deleted. It is not
usable.String message
A description of the most recent details about creating the
DataSource.
RedshiftMetadata redshiftMetadata
RDSMetadata rDSMetadata
String roleARN
Boolean computeStatistics
The parameter is true if statistics need to be generated
from the observation data.
String batchPredictionId
A user-supplied ID that uniquely identifies the
BatchPrediction.
String batchPredictionId
A user-supplied ID that uniquely identifies the
BatchPrediction. This value should be identical to the value
of the BatchPredictionID in the request.
String dataSourceId
A user-supplied ID that uniquely identifies the DataSource.
String dataSourceId
A user-supplied ID that uniquely identifies the DataSource.
This value should be identical to the value of the
DataSourceID in the request.
String evaluationId
A user-supplied ID that uniquely identifies the Evaluation
to delete.
String evaluationId
A user-supplied ID that uniquely identifies the Evaluation.
This value should be identical to the value of the
EvaluationId in the request.
String mLModelId
A user-supplied ID that uniquely identifies the MLModel.
String mLModelId
A user-supplied ID that uniquely identifies the MLModel.
This value should be identical to the value of the MLModelID
in the request.
String mLModelId
The ID assigned to the MLModel during creation.
String mLModelId
A user-supplied ID that uniquely identifies the MLModel.
This value should be identical to the value of the MLModelId
in the request.
RealtimeEndpointInfo realtimeEndpointInfo
The endpoint information of the MLModel
String filterVariable
Use one of the following variables to filter a list of
BatchPrediction:
CreatedAt - Sets the search criteria to the
BatchPrediction creation date.Status - Sets the search criteria to the
BatchPrediction status.Name - Sets the search criteria to the contents of the
BatchPrediction Name.IAMUser - Sets the search criteria to the user account
that invoked the BatchPrediction creation.MLModelId - Sets the search criteria to the
MLModel used in the BatchPrediction.DataSourceId - Sets the search criteria to the
DataSource used in the BatchPrediction.DataURI - Sets the search criteria to the data file(s)
used in the BatchPrediction. The URL can identify either a
file or an Amazon Simple Storage Solution (Amazon S3) bucket or
directory.String eQ
The equal to operator. The BatchPrediction results will have
FilterVariable values that exactly match the value specified
with EQ.
String gT
The greater than operator. The BatchPrediction results will
have FilterVariable values that are greater than the value
specified with GT.
String lT
The less than operator. The BatchPrediction results will
have FilterVariable values that are less than the value
specified with LT.
String gE
The greater than or equal to operator. The BatchPrediction
results will have FilterVariable values that are greater
than or equal to the value specified with GE.
String lE
The less than or equal to operator. The BatchPrediction
results will have FilterVariable values that are less than
or equal to the value specified with LE.
String nE
The not equal to operator. The BatchPrediction results will
have FilterVariable values not equal to the value specified
with NE.
String prefix
A string that is found at the beginning of a variable, such as
Name or Id.
For example, a Batch Prediction operation could have the
Name 2014-09-09-HolidayGiftMailer. To search
for this BatchPrediction, select Name for the
FilterVariable and any of the following strings for the
Prefix:
2014-09
2014-09-09
2014-09-09-Holiday
String sortOrder
A two-value parameter that determines the sequence of the resulting list
of MLModels.
asc - Arranges the list in ascending order (A-Z, 0-9).dsc - Arranges the list in descending order (Z-A, 9-0).
Results are sorted by FilterVariable.
String nextToken
An ID of the page in the paginated results.
Integer limit
The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.
com.amazonaws.internal.SdkInternalList<T> results
A list of BatchPrediction objects that meet the search criteria.
String nextToken
The ID of the next page in the paginated results that indicates at least one more page follows.
String filterVariable
Use one of the following variables to filter a list of
DataSource:
CreatedAt - Sets the search criteria to
DataSource creation dates.Status - Sets the search criteria to
DataSource statuses.Name - Sets the search criteria to the contents of
DataSource Name.DataUri - Sets the search criteria to the URI of data
files used to create the DataSource. The URI can identify
either a file or an Amazon Simple Storage Service (Amazon S3) bucket or
directory.IAMUser - Sets the search criteria to the user account
that invoked the DataSource creation.String eQ
The equal to operator. The DataSource results will have
FilterVariable values that exactly match the value specified
with EQ.
String gT
The greater than operator. The DataSource results will have
FilterVariable values that are greater than the value
specified with GT.
String lT
The less than operator. The DataSource results will have
FilterVariable values that are less than the value specified
with LT.
String gE
The greater than or equal to operator. The DataSource
results will have FilterVariable values that are greater
than or equal to the value specified with GE.
String lE
The less than or equal to operator. The DataSource results
will have FilterVariable values that are less than or equal
to the value specified with LE.
String nE
The not equal to operator. The DataSource results will have
FilterVariable values not equal to the value specified with
NE.
String prefix
A string that is found at the beginning of a variable, such as
Name or Id.
For example, a DataSource could have the Name
2014-09-09-HolidayGiftMailer. To search for this
DataSource, select Name for the
FilterVariable and any of the following strings for the
Prefix:
2014-09
2014-09-09
2014-09-09-Holiday
String sortOrder
A two-value parameter that determines the sequence of the resulting list
of DataSource.
asc - Arranges the list in ascending order (A-Z, 0-9).dsc - Arranges the list in descending order (Z-A, 9-0).
Results are sorted by FilterVariable.
String nextToken
The ID of the page in the paginated results.
Integer limit
The maximum number of DataSource to include in the result.
com.amazonaws.internal.SdkInternalList<T> results
A list of DataSource that meet the search criteria.
String nextToken
An ID of the next page in the paginated results that indicates at least one more page follows.
String filterVariable
Use one of the following variable to filter a list of
Evaluation objects:
CreatedAt - Sets the search criteria to the
Evaluation creation date.Status - Sets the search criteria to the
Evaluation status.Name - Sets the search criteria to the contents of
Evaluation Name.IAMUser - Sets the search criteria to the user account
that invoked an Evaluation.MLModelId - Sets the search criteria to the
MLModel that was evaluated.DataSourceId - Sets the search criteria to the
DataSource used in Evaluation.DataUri - Sets the search criteria to the data file(s)
used in Evaluation. The URL can identify either a file or an
Amazon Simple Storage Solution (Amazon S3) bucket or directory.String eQ
The equal to operator. The Evaluation results will have
FilterVariable values that exactly match the value specified
with EQ.
String gT
The greater than operator. The Evaluation results will have
FilterVariable values that are greater than the value
specified with GT.
String lT
The less than operator. The Evaluation results will have
FilterVariable values that are less than the value specified
with LT.
String gE
The greater than or equal to operator. The Evaluation
results will have FilterVariable values that are greater
than or equal to the value specified with GE.
String lE
The less than or equal to operator. The Evaluation results
will have FilterVariable values that are less than or equal
to the value specified with LE.
String nE
The not equal to operator. The Evaluation results will have
FilterVariable values not equal to the value specified with
NE.
String prefix
A string that is found at the beginning of a variable, such as
Name or Id.
For example, an Evaluation could have the Name
2014-09-09-HolidayGiftMailer. To search for this
Evaluation, select Name for the
FilterVariable and any of the following strings for the
Prefix:
2014-09
2014-09-09
2014-09-09-Holiday
String sortOrder
A two-value parameter that determines the sequence of the resulting list
of Evaluation.
asc - Arranges the list in ascending order (A-Z, 0-9).dsc - Arranges the list in descending order (Z-A, 9-0).
Results are sorted by FilterVariable.
String nextToken
The ID of the page in the paginated results.
Integer limit
The maximum number of Evaluation to include in the result.
com.amazonaws.internal.SdkInternalList<T> results
A list of Evaluation that meet the search criteria.
String nextToken
The ID of the next page in the paginated results that indicates at least one more page follows.
String filterVariable
Use one of the following variables to filter a list of
MLModel:
CreatedAt - Sets the search criteria to
MLModel creation date.Status - Sets the search criteria to
MLModel status.Name - Sets the search criteria to the contents of
MLModel Name.IAMUser - Sets the search criteria to the user account
that invoked the MLModel creation.TrainingDataSourceId - Sets the search criteria to the
DataSource used to train one or more MLModel.RealtimeEndpointStatus - Sets the search criteria to the
MLModel real-time endpoint status.MLModelType - Sets the search criteria to
MLModel type: binary, regression, or multi-class.Algorithm - Sets the search criteria to the algorithm
that the MLModel uses.TrainingDataURI - Sets the search criteria to the data
file(s) used in training a MLModel. The URL can identify
either a file or an Amazon Simple Storage Service (Amazon S3) bucket or
directory.String eQ
The equal to operator. The MLModel results will have
FilterVariable values that exactly match the value specified
with EQ.
String gT
The greater than operator. The MLModel results will have
FilterVariable values that are greater than the value
specified with GT.
String lT
The less than operator. The MLModel results will have
FilterVariable values that are less than the value specified
with LT.
String gE
The greater than or equal to operator. The MLModel results
will have FilterVariable values that are greater than or
equal to the value specified with GE.
String lE
The less than or equal to operator. The MLModel results will
have FilterVariable values that are less than or equal to
the value specified with LE.
String nE
The not equal to operator. The MLModel results will have
FilterVariable values not equal to the value specified with
NE.
String prefix
A string that is found at the beginning of a variable, such as
Name or Id.
For example, an MLModel could have the Name
2014-09-09-HolidayGiftMailer. To search for this
MLModel, select Name for the
FilterVariable and any of the following strings for the
Prefix:
2014-09
2014-09-09
2014-09-09-Holiday
String sortOrder
A two-value parameter that determines the sequence of the resulting list
of MLModel.
asc - Arranges the list in ascending order (A-Z, 0-9).dsc - Arranges the list in descending order (Z-A, 9-0).
Results are sorted by FilterVariable.
String nextToken
The ID of the page in the paginated results.
Integer limit
The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.
com.amazonaws.internal.SdkInternalList<T> results
A list of MLModel that meet the search criteria.
String nextToken
The ID of the next page in the paginated results that indicates at least one more page follows.
String evaluationId
The ID that is assigned to the Evaluation at creation.
String mLModelId
The ID of the MLModel that is the focus of the evaluation.
String evaluationDataSourceId
The ID of the DataSource that is used to evaluate the
MLModel.
String inputDataLocationS3
The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.
String createdByIamUser
The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.
Date createdAt
The time that the Evaluation was created. The time is
expressed in epoch time.
Date lastUpdatedAt
The time of the most recent edit to the Evaluation. The time
is expressed in epoch time.
String name
A user-supplied name or description of the Evaluation.
String status
The status of the evaluation. This element can have one of the following values:
PENDING - Amazon Machine Learning (Amazon ML) submitted
a request to evaluate an MLModel.INPROGRESS - The evaluation is underway.FAILED - The request to evaluate an MLModel
did not run to completion. It is not usable.COMPLETED - The evaluation process completed
successfully.DELETED - The Evaluation is marked as
deleted. It is not usable.PerformanceMetrics performanceMetrics
Measurements of how well the MLModel performed, using
observations referenced by the DataSource. One of the
following metrics is returned, based on the type of the MLModel:
BinaryAUC: A binary MLModel uses the Area Under the Curve
(AUC) technique to measure performance.
RegressionRMSE: A regression MLModel uses the Root Mean
Square Error (RMSE) technique to measure performance. RMSE measures the
difference between predicted and actual values for a single variable.
MulticlassAvgFScore: A multiclass MLModel uses the F1 score
technique to measure performance.
For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.
String message
A description of the most recent details about evaluating the
MLModel.
String batchPredictionId
An ID assigned to the BatchPrediction at creation.
String batchPredictionId
An ID assigned to the BatchPrediction at creation. This
value should be identical to the value of the
BatchPredictionID in the request.
String mLModelId
The ID of the MLModel that generated predictions for the
BatchPrediction request.
String batchPredictionDataSourceId
The ID of the DataSource that was used to create the
BatchPrediction.
String inputDataLocationS3
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
String createdByIamUser
The AWS user account that invoked the BatchPrediction. The
account type can be either an AWS root account or an AWS Identity and
Access Management (IAM) user account.
Date createdAt
The time when the BatchPrediction was created. The time is
expressed in epoch time.
Date lastUpdatedAt
The time of the most recent edit to BatchPrediction. The
time is expressed in epoch time.
String name
A user-supplied name or description of the BatchPrediction.
String status
The status of the BatchPrediction, which can be one of the
following values:
PENDING - Amazon Machine Learning (Amazon ML) submitted
a request to generate batch predictions.INPROGRESS - The batch predictions are in progress.FAILED - The request to perform a batch prediction did
not run to completion. It is not usable.COMPLETED - The batch prediction process completed
successfully.DELETED - The BatchPrediction is marked as
deleted. It is not usable.String outputUri
The location of an Amazon S3 bucket or directory to receive the operation results.
String logUri
A link to the file that contains logs of the CreateBatchPrediction operation.
String message
A description of the most recent details about processing the batch prediction request.
String dataSourceId
The ID assigned to the DataSource at creation. This value
should be identical to the value of the DataSourceId in the
request.
String dataLocationS3
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
String dataRearrangement
A JSON string that captures the splitting rearrangement requirement of
the DataSource.
String createdByIamUser
The AWS user account from which the DataSource was created.
The account type can be either an AWS root account or an AWS Identity and
Access Management (IAM) user account.
Date createdAt
The time that the DataSource was created. The time is
expressed in epoch time.
Date lastUpdatedAt
The time of the most recent edit to the DataSource. The time
is expressed in epoch time.
Long dataSizeInBytes
The total size of observations in the data files.
Long numberOfFiles
The number of data files referenced by the DataSource.
String name
A user-supplied name or description of the DataSource.
String status
The current status of the DataSource. This element can have
one of the following values:
PENDING - Amazon Machine Language (Amazon ML) submitted
a request to create a DataSource.INPROGRESS - The creation process is underway.FAILED - The request to create a DataSource
did not run to completion. It is not usable.COMPLETED - The creation process completed successfully.
DELETED - The DataSource is marked as
deleted. It is not usable.String logUri
A link to the file containining logs of either create
DataSource operation.
String message
The description of the most recent details about creating the
DataSource.
RedshiftMetadata redshiftMetadata
RDSMetadata rDSMetadata
String roleARN
Boolean computeStatistics
The parameter is true if statistics need to be generated
from the observation data.
String dataSourceSchema
The schema used by all of the data files of this DataSource.
This parameter is provided as part of the verbose format.
String evaluationId
The ID of the Evaluation to retrieve. The evaluation of each
MLModel is recorded and cataloged. The ID provides the means
to access the information.
String evaluationId
The evaluation ID which is same as the EvaluationId in the
request.
String mLModelId
The ID of the MLModel that was the focus of the evaluation.
String evaluationDataSourceId
The DataSource used for this evaluation.
String inputDataLocationS3
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
String createdByIamUser
The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.
Date createdAt
The time that the Evaluation was created. The time is
expressed in epoch time.
Date lastUpdatedAt
The time of the most recent edit to the BatchPrediction. The
time is expressed in epoch time.
String name
A user-supplied name or description of the Evaluation.
String status
The status of the evaluation. This element can have one of the following values:
PENDING - Amazon Machine Language (Amazon ML) submitted
a request to evaluate an MLModel.INPROGRESS - The evaluation is underway.FAILED - The request to evaluate an MLModel
did not run to completion. It is not usable.COMPLETED - The evaluation process completed
successfully.DELETED - The Evaluation is marked as
deleted. It is not usable.PerformanceMetrics performanceMetrics
Measurements of how well the MLModel performed using
observations referenced by the DataSource. One of the
following metric is returned based on the type of the
MLModel:
BinaryAUC: A binary MLModel uses the Area Under the Curve
(AUC) technique to measure performance.
RegressionRMSE: A regression MLModel uses the Root Mean
Square Error (RMSE) technique to measure performance. RMSE measures the
difference between predicted and actual values for a single variable.
MulticlassAvgFScore: A multiclass MLModel uses the F1 score
technique to measure performance.
For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.
String logUri
A link to the file that contains logs of the CreateEvaluation operation.
String message
A description of the most recent details about evaluating the
MLModel.
String mLModelId
The MLModel ID which is same as the MLModelId in the
request.
String trainingDataSourceId
The ID of the training DataSource.
String createdByIamUser
The AWS user account from which the MLModel was created. The
account type can be either an AWS root account or an AWS Identity and
Access Management (IAM) user account.
Date createdAt
The time that the MLModel was created. The time is expressed
in epoch time.
Date lastUpdatedAt
The time of the most recent edit to the MLModel. The time is
expressed in epoch time.
String name
A user-supplied name or description of the MLModel.
String status
The current status of the MLModel. This element can have one
of the following values:
PENDING - Amazon Machine Learning (Amazon ML) submitted
a request to describe a MLModel.INPROGRESS - The request is processing.FAILED - The request did not run to completion. It is
not usable.COMPLETED - The request completed successfully.DELETED - The MLModel is marked as deleted.
It is not usable.Long sizeInBytes
RealtimeEndpointInfo endpointInfo
The current endpoint of the MLModel
com.amazonaws.internal.SdkInternalMap<K,V> trainingParameters
A list of the training parameters in the MLModel. The list
is implemented as a map of key/value pairs.
The following is the current set of training parameters:
sgd.l1RegularizationAmount - Coefficient regularization L1
norm. It controls overfitting the data by penalizing large coefficients.
This tends to drive coefficients to zero, resulting in a sparse feature
set. If you use this parameter, specify a small value, such as 1.0E-04 or
1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is
not to use L1 normalization. The parameter cannot be used when
L2 is specified. Use this parameter sparingly.
sgd.l2RegularizationAmount - Coefficient regularization L2
norm. It controls overfitting the data by penalizing large coefficients.
This tends to drive coefficients to small, nonzero values. If you use
this parameter, specify a small value, such as 1.0E-04 or 1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is
not to use L2 normalization. This parameter cannot be used when
L1 is specified. Use this parameter sparingly.
sgd.maxPasses - The number of times that the training
process traverses the observations to build the MLModel. The
value is an integer that ranges from 1 to 10000. The default value is 10.
sgd.maxMLModelSizeInBytes - The maximum allowed size of the
model. Depending on the input data, the model size might affect
performance.
The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.
String inputDataLocationS3
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
String mLModelType
Identifies the MLModel category. The following are the
available types:
Float scoreThreshold
The scoring threshold is used in binary classification
MLModels, and marks the boundary between a positive
prediction and a negative prediction.
Output values greater than or equal to the threshold receive a positive
result from the MLModel, such as true. Output values less
than the threshold receive a negative response from the MLModel, such as
false.
Date scoreThresholdLastUpdatedAt
The time of the most recent edit to the ScoreThreshold. The
time is expressed in epoch time.
String logUri
A link to the file that contains logs of the CreateMLModel
operation.
String message
Description of the most recent details about accessing the
MLModel.
String recipe
The recipe to use when training the MLModel. The
Recipe provides detailed information about the observation
data to use during training, as well as manipulations to perform on the
observation data during training.
This parameter is provided as part of the verbose format.
String schema
The schema used by all of the data files referenced by the
DataSource.
This parameter is provided as part of the verbose format.
Integer code
Integer code
Integer code
Integer code
String mLModelId
The ID assigned to the MLModel at creation.
String trainingDataSourceId
The ID of the training DataSource. The CreateMLModel
operation uses the TrainingDataSourceId.
String createdByIamUser
The AWS user account from which the MLModel was created. The
account type can be either an AWS root account or an AWS Identity and
Access Management (IAM) user account.
Date createdAt
The time that the MLModel was created. The time is expressed
in epoch time.
Date lastUpdatedAt
The time of the most recent edit to the MLModel. The time is
expressed in epoch time.
String name
A user-supplied name or description of the MLModel.
String status
The current status of an MLModel. This element can have one
of the following values:
MLModel.MLModel did not run to
completion. It is not usable.MLModel is marked as deleted. It is not
usable.Long sizeInBytes
RealtimeEndpointInfo endpointInfo
The current endpoint of the MLModel.
com.amazonaws.internal.SdkInternalMap<K,V> trainingParameters
A list of the training parameters in the MLModel. The list
is implemented as a map of key/value pairs.
The following is the current set of training parameters:
sgd.l1RegularizationAmount - Coefficient regularization L1
norm. It controls overfitting the data by penalizing large coefficients.
This tends to drive coefficients to zero, resulting in a sparse feature
set. If you use this parameter, specify a small value, such as 1.0E-04 or
1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is
not to use L1 normalization. The parameter cannot be used when
L2 is specified. Use this parameter sparingly.
sgd.l2RegularizationAmount - Coefficient regularization L2
norm. It controls overfitting the data by penalizing large coefficients.
This tends to drive coefficients to small, nonzero values. If you use
this parameter, specify a small value, such as 1.0E-04 or 1.0E-08.
The valus is a double that ranges from 0 to MAX_DOUBLE. The default is
not to use L2 normalization. This cannot be used when L1 is
specified. Use this parameter sparingly.
sgd.maxPasses - Number of times that the training process
traverses the observations to build the MLModel. The value
is an integer that ranges from 1 to 10000. The default value is 10.
sgd.maxMLModelSizeInBytes - Maximum allowed size of the
model. Depending on the input data, the model size might affect
performance.
The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.
String inputDataLocationS3
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
String algorithm
The algorithm used to train the MLModel. The following
algorithm is supported:
String mLModelType
Identifies the MLModel category. The following are the
available types:
Float scoreThreshold
Date scoreThresholdLastUpdatedAt
The time of the most recent edit to the ScoreThreshold. The
time is expressed in epoch time.
String message
A description of the most recent details about accessing the
MLModel.
com.amazonaws.internal.SdkInternalMap<K,V> properties
String predictedLabel
MLModel.Float predictedValue
MLModel.com.amazonaws.internal.SdkInternalMap<K,V> predictedScores
com.amazonaws.internal.SdkInternalMap<K,V> details
String mLModelId
A unique identifier of the MLModel.
com.amazonaws.internal.SdkInternalMap<K,V> record
String predictEndpoint
Prediction prediction
RDSDatabase databaseInformation
Describes the DatabaseName and
InstanceIdentifier of an an Amazon RDS database.
String selectSqlQuery
The query that is used to retrieve the observation data for the
DataSource.
RDSDatabaseCredentials databaseCredentials
The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.
String s3StagingLocation
The Amazon S3 location for staging Amazon RDS data. The data retrieved
from Amazon RDS using SelectSqlQuery is stored in this
location.
String dataRearrangement
DataRearrangement - A JSON string that represents the splitting
requirement of a DataSource.
Sample -
"{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
String dataSchema
A JSON string that represents the schema for an Amazon RDS
DataSource. The DataSchema defines the
structure of the observation data in the data file(s) referenced in the
DataSource.
A DataSchema is not required if you specify a
DataSchemaUri
Define your DataSchema as a series of key-value pairs.
attributes and excludedVariableNames have an
array of key-value pairs for their value. Use the following format to
define your DataSchema.
{ "version": "1.0",
"recordAnnotationFieldName": "F1",
"recordWeightFieldName": "F2",
"targetFieldName": "F3",
"dataFormat": "CSV",
"dataFileContainsHeader": true,
"attributes": [
{ "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],
"excludedVariableNames": [ "F6" ] }
String dataSchemaUri
The Amazon S3 location of the DataSchema.
String resourceRole
The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.
String serviceRole
The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
String subnetId
The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.
com.amazonaws.internal.SdkInternalList<T> securityGroupIds
The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.
RDSDatabase database
The database details required to connect to an Amazon RDS.
String databaseUserName
String selectSqlQuery
The SQL query that is supplied during CreateDataSourceFromRDS.
Returns only if Verbose is true in
GetDataSourceInput.
String resourceRole
The role (DataPipelineDefaultResourceRole) assumed by an Amazon EC2 instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
String serviceRole
The role (DataPipelineDefaultRole) assumed by the Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
String dataPipelineId
The ID of the Data Pipeline instance that is used to carry to copy data from Amazon RDS to Amazon S3. You can use the ID to find details about the instance in the Data Pipeline console.
Integer peakRequestsPerSecond
The maximum processing rate for the real-time endpoint for
MLModel, measured in incoming requests per second.
Date createdAt
The time that the request to create the real-time endpoint for the
MLModel was received. The time is expressed in epoch time.
String endpointUrl
The URI that specifies where to send real-time prediction requests for
the MLModel.
The application must wait until the real-time endpoint is ready before using this URI.
String endpointStatus
The current status of the real-time endpoint for the MLModel
. This element can have one of the following values:
RedshiftDatabase databaseInformation
Describes the DatabaseName and
ClusterIdentifier for an Amazon Redshift
DataSource.
String selectSqlQuery
Describes the SQL Query to execute on an Amazon Redshift database for an
Amazon Redshift DataSource.
RedshiftDatabaseCredentials databaseCredentials
Describes AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon Redshift database.
String s3StagingLocation
Describes an Amazon S3 location to store the result set of the
SelectSqlQuery query.
String dataRearrangement
Describes the splitting specifications for a DataSource.
String dataSchema
A JSON string that represents the schema for an Amazon Redshift
DataSource. The DataSchema defines the
structure of the observation data in the data file(s) referenced in the
DataSource.
A DataSchema is not required if you specify a
DataSchemaUri.
Define your DataSchema as a series of key-value pairs.
attributes and excludedVariableNames have an
array of key-value pairs for their value. Use the following format to
define your DataSchema.
{ "version": "1.0",
"recordAnnotationFieldName": "F1",
"recordWeightFieldName": "F2",
"targetFieldName": "F3",
"dataFormat": "CSV",
"dataFileContainsHeader": true,
"attributes": [
{ "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],
"excludedVariableNames": [ "F6" ] }
String dataSchemaUri
Describes the schema location for an Amazon Redshift
DataSource.
RedshiftDatabase redshiftDatabase
String databaseUserName
String selectSqlQuery
The SQL query that is specified during
CreateDataSourceFromRedshift. Returns only if Verbose
is true in GetDataSourceInput.
Integer code
String dataLocationS3
The location of the data file(s) used by a DataSource. The
URI specifies a data file or an Amazon Simple Storage Service (Amazon S3)
directory or bucket containing data files.
String dataRearrangement
Describes the splitting requirement of a Datasource.
String dataSchema
A JSON string that represents the schema for an Amazon S3
DataSource. The DataSchema defines the
structure of the observation data in the data file(s) referenced in the
DataSource.
Define your DataSchema as a series of key-value pairs.
attributes and excludedVariableNames have an
array of key-value pairs for their value. Use the following format to
define your DataSchema.
{ "version": "1.0",
"recordAnnotationFieldName": "F1",
"recordWeightFieldName": "F2",
"targetFieldName": "F3",
"dataFormat": "CSV",
"dataFileContainsHeader": true,
"attributes": [
{ "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],
"excludedVariableNames": [ "F6" ] }
String dataSchemaLocationS3
Describes the schema Location in Amazon S3.
String batchPredictionId
The ID assigned to the BatchPrediction during creation. This
value should be identical to the value of the
BatchPredictionId in the request.
String dataSourceId
The ID assigned to the DataSource during creation. This
value should be identical to the value of the DataSourceID
in the request.
String evaluationId
The ID assigned to the Evaluation during creation. This
value should be identical to the value of the Evaluation in
the request.
String mLModelId
The ID assigned to the MLModel during creation.
String mLModelName
A user-supplied name or description of the MLModel.
Float scoreThreshold
The ScoreThreshold used in binary classification
MLModel that marks the boundary between a positive
prediction and a negative prediction.
Output values greater than or equal to the ScoreThreshold
receive a positive result from the MLModel, such as
true. Output values less than the
ScoreThreshold receive a negative response from the
MLModel, such as false.
String mLModelId
The ID assigned to the MLModel during creation. This value
should be identical to the value of the MLModelID in the
request.
String dataSetRequestId
String version
The agent version.
StackConfigurationManager configurationManager
The configuration manager.
String appId
The app ID.
String stackId
The app stack ID.
String shortname
The app's short name.
String name
The app name.
String description
A description of the app.
com.amazonaws.internal.SdkInternalList<T> dataSources
The app's data sources.
String type
The app type.
Source appSource
A Source object that describes the app repository.
com.amazonaws.internal.SdkInternalList<T> domains
The app vhost settings with multiple domains separated by commas. For
example: 'www.example.com, example.com'
Boolean enableSsl
Whether to enable SSL for the app.
SslConfiguration sslConfiguration
An SslConfiguration object with the SSL configuration.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
The stack attributes.
String createdAt
When the app was created.
com.amazonaws.internal.SdkInternalList<T> environment
An array of EnvironmentVariable objects that specify
environment variables to be associated with the app. After you deploy the
app, these variables are defined on the associated app server instances.
For more information, see Environment Variables.
String instanceId
The instance ID.
com.amazonaws.internal.SdkInternalList<T> layerIds
The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in layer.
Integer instanceCount
The number of instances to add or remove when the load exceeds a threshold.
Integer thresholdsWaitTime
The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
Integer ignoreMetricsTime
The amount of time (in minutes) after a scaling event occurs that AWS
OpsWorks should ignore metrics and suppress additional scaling events.
For example, AWS OpsWorks adds new instances following an upscaling event
but the instances won't start reducing the load until they have been
booted and configured. There is no point in raising additional scaling
events during that operation, which typically takes several minutes.
IgnoreMetricsTime allows you to direct AWS OpsWorks to
suppress scaling events long enough to get the new instances online.
Double cpuThreshold
The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.
Double memoryThreshold
The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.
Double loadThreshold
The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).
com.amazonaws.internal.SdkInternalList<T> alarms
Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.
cloudwatch:DescribeAlarms. You can either have AWS OpsWorks
update the role for you when you first use this feature or you can edit
the role manually. For more information, see Allowing AWS OpsWorks to Act on Your Behalf.String deviceName
The device name that is exposed to the instance, such as
/dev/sdh. For the root device, you can use the explicit
device name or you can set this parameter to ROOT_DEVICE and
AWS OpsWorks will provide the correct device name.
String noDevice
Suppresses the specified device included in the AMI's block device mapping.
String virtualName
The virtual device name. For more information, see BlockDeviceMapping.
EbsBlockDevice ebs
An EBSBlockDevice that defines how to configure an Amazon
EBS volume when the instance is launched.
String sourceStackId
The source stack ID.
String name
The cloned stack name.
String region
The cloned stack AWS region, such as "us-east-1". For more information about AWS regions, see Regions and Endpoints.
String vpcId
The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later.
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.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
A list of stack attributes and values as key/value pairs to be added to the cloned stack.
String serviceRoleArn
The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you create a stack by using the AWS OpsWorks console, it creates the role for you. You can obtain an existing stack's IAM ARN programmatically by calling DescribePermissions. For more information about IAM ARNs, see Using Identifiers.
You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.
String defaultInstanceProfileArn
The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
String defaultOs
The stack's operating system, which must be set to one of the following.
Amazon Linux 2015.03,
Red Hat Enterprise Linux 7, Ubuntu 12.04 LTS,
or Ubuntu 14.04 LTS.Microsoft Windows Server 2012 R2 Base.Custom. You specify the custom AMI you
want to use when you create instances. For more information on how to use
custom AMIs with OpsWorks, see Using Custom AMIs.The default option is the parent stack's operating system. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
String hostnameTheme
The stack's host name theme, with spaces are replaced by underscores. The
theme is used to generate host names for the stack's instances. By
default, HostnameTheme is set to
Layer_Dependent, which creates host names by appending
integers to the layer's short name. The other themes are:
Baked_GoodsCloudsEurope_CitiesFruitsGreek_DeitiesLegendary_creatures_from_JapanPlanets_and_MoonsRoman_DeitiesScottish_IslandsUS_CitiesWild_Cats
To obtain a generated host name, call GetHostNameSuggestion,
which returns a host name based on the current theme.
String defaultAvailabilityZone
The cloned stack's default Availability Zone, which must be in the
specified region. For more information, see Regions
and Endpoints. If you also specify a value for
DefaultSubnetId, the subnet must be in the same zone. For
more information, see the VpcId parameter description.
String defaultSubnetId
The stack's default VPC subnet ID. This parameter is required if you
specify a value for the VpcId parameter. All instances are
launched into this subnet unless you specify otherwise when you create
the instance. If you also specify a value for
DefaultAvailabilityZone, the subnet must be in that zone.
For information on default values and when this parameter is required,
see the VpcId parameter description.
String customJson
A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '"':
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes
StackConfigurationManager configurationManager
The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 11.4.
ChefConfiguration chefConfiguration
A ChefConfiguration object that specifies whether to enable
Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more
information, see Create a New Stack.
Boolean useCustomCookbooks
Whether to use custom cookbooks.
Boolean useOpsworksSecurityGroups
Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.
AWS OpsWorks provides a standard set of built-in security groups, one for
each layer, which are associated with layers by default. With
UseOpsworksSecurityGroups you can instead provide your own
custom security groups. UseOpsworksSecurityGroups has the
following settings:
For more information, see Create a New Stack.
Source customCookbooksSource
String defaultSshKeyName
A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.
Boolean clonePermissions
Whether to clone the source stack's permissions.
com.amazonaws.internal.SdkInternalList<T> cloneAppIds
A list of source stack app IDs to be included in the cloned stack.
String defaultRootDeviceType
The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
String agentVersion
The default AWS OpsWorks agent version. You have the following options:
LATEST. AWS OpsWorks
automatically installs new agent versions on the stack's instances as
soon as they are available.
The default setting is LATEST. To specify an agent version,
you must use the complete version number, not the abbreviated number
shown on the console. For a list of available agent version numbers, call
DescribeAgentVersions.
String stackId
The cloned stack ID.
String commandId
The command ID.
String instanceId
The ID of the instance where the command was executed.
String deploymentId
The command deployment ID.
String createdAt
Date and time when the command was run.
String acknowledgedAt
Date and time when the command was acknowledged.
String completedAt
Date when the command completed.
String status
The command status:
Integer exitCode
The command exit code.
String logUrl
The URL of the command log.
String type
The command type:
deployrollbackstartstoprestartundeployupdate_dependenciesinstall_dependenciesupdate_custom_cookbooksexecute_recipesString stackId
The stack ID.
String shortname
The app's short name.
String name
The app name.
String description
A description of the app.
com.amazonaws.internal.SdkInternalList<T> dataSources
The app's data source.
String type
The app type. Each supported type is associated with a particular layer.
For example, PHP applications are associated with a PHP layer. AWS
OpsWorks deploys an application to those instances that are members of
the corresponding layer. If your app isn't one of the standard types, or
you prefer to implement your own Deploy recipes, specify
other.
Source appSource
A Source object that specifies the app repository.
com.amazonaws.internal.SdkInternalList<T> domains
The app virtual host settings, with multiple domains separated by commas.
For example: 'www.example.com, example.com'
Boolean enableSsl
Whether to enable SSL for the app.
SslConfiguration sslConfiguration
An SslConfiguration object with the SSL configuration.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
One or more user-defined key/value pairs to be added to the stack attributes.
com.amazonaws.internal.SdkInternalList<T> environment
An array of EnvironmentVariable objects that specify
environment variables to be associated with the app. After you deploy the
app, these variables are defined on the associated app server instance.
For more information, see Environment Variables.
There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 10KB)."
String appId
The app ID.
String stackId
The stack ID.
String appId
The app ID. This parameter is required for app deployments, but not for other deployment commands.
com.amazonaws.internal.SdkInternalList<T> instanceIds
The instance IDs for the deployment targets.
DeploymentCommand command
A DeploymentCommand object that specifies the deployment
command and any associated arguments.
String comment
A user-defined comment.
String customJson
A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '"':
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
String deploymentId
The deployment ID, which can be used with other requests to identify the deployment.
String stackId
The stack ID.
com.amazonaws.internal.SdkInternalList<T> layerIds
An array that contains the instance's layer IDs.
String instanceType
The instance type, such as t2.micro. For a list of supported
instance types, open the stack in the console, choose Instances,
and choose + Instance. The Size list contains the currently
supported types. For more information, see Instance Families and Types. The parameter values that you use to
specify the various types are in the API Name column of the
Available Instance Types table.
String autoScalingType
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
String hostname
The instance host name.
String os
The instance's operating system, which must be set to one of the following.
Amazon Linux 2015.03,
Red Hat Enterprise Linux 7, Ubuntu 12.04 LTS,
or Ubuntu 14.04 LTS.Microsoft Windows Server 2012 R2 Base.Custom.For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
The default option is the current Amazon Linux version. If you set this
parameter to Custom, you must use the CreateInstance
action's AmiId parameter to specify the custom AMI that you want to use.
Block device mappings are not supported if the value is
Custom. For more information on the supported operating
systems, see Operating SystemsFor more information on how to use custom AMIs with
AWS OpsWorks, see Using Custom AMIs.
String amiId
A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.
Os to
Custom.String sshKeyName
The instance's Amazon EC2 key-pair name.
String availabilityZone
The instance Availability Zone. For more information, see Regions and Endpoints.
String virtualizationType
The instance's virtualization type, paravirtual or
hvm.
String subnetId
The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks to launch the instance in a different subnet.
String architecture
The instance architecture. The default option is x86_64.
Instance types do not necessarily support both architectures. For a list
of the architectures that are supported by the different instance types,
see Instance Families and Types.
String rootDeviceType
The instance root device type. For more information, see Storage for the Root Device.
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
An array of BlockDeviceMapping objects that specify the
instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not
supported for custom AMIs.
Boolean installUpdatesOnBoot
Whether to install operating system and package updates when the instance
boots. The default value is true. To control when updates
are installed, set this value to false. You must then update
your instances manually by using CreateDeployment to run the
update_dependencies stack command or by manually running
yum (Amazon Linux) or apt-get (Ubuntu) on the
instances.
We strongly recommend using the default value of true to
ensure that your instances have the latest security updates.
Boolean ebsOptimized
Whether to create an Amazon EBS-optimized instance.
String agentVersion
The default AWS OpsWorks agent version. You have the following options:
INHERIT - Use the stack's default agent version setting.
The default setting is INHERIT. To specify an agent version,
you must use the complete version number, not the abbreviated number
shown on the console. For a list of available agent version numbers, call
DescribeAgentVersions.
String instanceId
The instance ID.
String stackId
The layer stack ID.
String type
The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers.
String name
The layer name, which is used by the console.
String shortname
For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.
The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
One or more user-defined key-value pairs to be added to the stack attributes.
To create a cluster layer, set the EcsClusterArn attribute
to the cluster's ARN.
String customInstanceProfileArn
The ARN of an IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
String customJson
A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON. This feature is supported as of version 1.7.42 of the AWS CLI.
com.amazonaws.internal.SdkInternalList<T> customSecurityGroupIds
An array containing the layer custom security group IDs.
com.amazonaws.internal.SdkInternalList<T> packages
An array of Package objects that describes the layer
packages.
com.amazonaws.internal.SdkInternalList<T> volumeConfigurations
A VolumeConfigurations object that describes the layer's
Amazon EBS volumes.
Boolean enableAutoHealing
Whether to disable auto healing for the layer.
Boolean autoAssignElasticIps
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
Boolean autoAssignPublicIps
For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.
Recipes customRecipes
A LayerCustomRecipes object that specifies the layer custom
recipes.
Boolean installUpdatesOnBoot
Whether to install operating system and package updates when the instance
boots. The default value is true. To control when updates
are installed, set this value to false. You must then update
your instances manually by using CreateDeployment to run the
update_dependencies stack command or by manually running
yum (Amazon Linux) or apt-get (Ubuntu) on the
instances.
To ensure that your instances have the latest security updates, we
strongly recommend using the default value of true.
Boolean useEbsOptimizedInstances
Whether to use Amazon EBS-optimized instances.
LifecycleEventConfiguration lifecycleEventConfiguration
A LifeCycleEventConfiguration object that you can use to
configure the Shutdown event to specify an execution timeout and enable
or disable Elastic Load Balancer connection draining.
String layerId
The layer ID.
String name
The stack name.
String region
The stack's AWS region, such as "us-east-1". For more information about Amazon regions, see Regions and Endpoints.
String vpcId
The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.
no VPC.
If the VPC ID corresponds to a default VPC and you have specified either
the DefaultAvailabilityZone or the
DefaultSubnetId parameter only, AWS OpsWorks infers the
value of the other parameter. If you specify neither parameter, AWS
OpsWorks sets these parameters to the first valid Availability Zone for
the specified region and the corresponding default VPC subnet ID,
respectively.
If you specify a nondefault VPC ID, note the following:
DefaultSubnetId.For more information on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2-Classic, see Supported Platforms.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
One or more user-defined key-value pairs to be added to the stack attributes.
String serviceRoleArn
The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.
String defaultInstanceProfileArn
The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
String defaultOs
The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.
Amazon Linux 2015.03,
Red Hat Enterprise Linux 7, Ubuntu 12.04 LTS,
or Ubuntu 14.04 LTS.Microsoft Windows Server 2012 R2 Base.Custom. You specify the custom AMI you
want to use when you create instances. For more information, see Using Custom AMIs.The default option is the current Amazon Linux version. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
String hostnameTheme
The stack's host name theme, with spaces replaced by underscores. The
theme is used to generate host names for the stack's instances. By
default, HostnameTheme is set to
Layer_Dependent, which creates host names by appending
integers to the layer's short name. The other themes are:
Baked_GoodsCloudsEurope_CitiesFruitsGreek_DeitiesLegendary_creatures_from_JapanPlanets_and_MoonsRoman_DeitiesScottish_IslandsUS_CitiesWild_Cats
To obtain a generated host name, call GetHostNameSuggestion,
which returns a host name based on the current theme.
String defaultAvailabilityZone
The stack's default Availability Zone, which must be in the specified
region. For more information, see Regions
and Endpoints. If you also specify a value for
DefaultSubnetId, the subnet must be in the same zone. For
more information, see the VpcId parameter description.
String defaultSubnetId
The stack's default VPC subnet ID. This parameter is required if you
specify a value for the VpcId parameter. All instances are
launched into this subnet unless you specify otherwise when you create
the instance. If you also specify a value for
DefaultAvailabilityZone, the subnet must be in that zone.
For information on default values and when this parameter is required,
see the VpcId parameter description.
String customJson
A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following escape characters such as '"':
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
StackConfigurationManager configurationManager
The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 11.4.
ChefConfiguration chefConfiguration
A ChefConfiguration object that specifies whether to enable
Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more
information, see Create a New Stack.
Boolean useCustomCookbooks
Whether the stack uses custom cookbooks.
Boolean useOpsworksSecurityGroups
Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.
AWS OpsWorks provides a standard set of built-in security groups, one for
each layer, which are associated with layers by default. With
UseOpsworksSecurityGroups you can instead provide your own
custom security groups. UseOpsworksSecurityGroups has the
following settings:
For more information, see Create a New Stack.
Source customCookbooksSource
String defaultSshKeyName
A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.
String defaultRootDeviceType
The default root device type. This value is the default for all instances
in the stack, but you can override it when you create an instance. The
default option is instance-store. For more information, see
Storage for the Root Device.
String agentVersion
The default AWS OpsWorks agent version. You have the following options:
LATEST. AWS OpsWorks
automatically installs new agent versions on the stack's instances as
soon as they are available.The default setting is the most recent release of the agent. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions.
String stackId
The stack ID, which is an opaque string that you use to identify the
stack when performing actions such as DescribeStacks.
String iamUserArn
The user's IAM ARN.
String sshUsername
The user's SSH user name. The allowable characters are [a-z], [A-Z],
[0-9], '-', and '_'. If the specified name includes other punctuation
marks, AWS OpsWorks removes them. For example, my.name will
be changed to myname. If you do not specify an SSH user
name, AWS OpsWorks generates one from the IAM user name.
String sshPublicKey
The user's public SSH key.
Boolean allowSelfManagement
Whether users can specify their own SSH public key through the My Settings page. For more information, see Setting an IAM User's Public SSH Key.
String iamUserArn
The user's IAM ARN.
String appId
The app ID.
String layerId
The layer ID.
String stackId
The stack ID.
String iamUserArn
The user's IAM ARN.
String deploymentId
The deployment ID.
String stackId
The stack ID.
String appId
The app ID.
String createdAt
Date when the deployment was created.
String completedAt
Date when the deployment completed.
Integer duration
The deployment duration.
String iamUserArn
The user's IAM ARN.
String comment
A user-defined comment.
DeploymentCommand command
String status
The deployment status:
String customJson
A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format and must escape characters such as '"':
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
com.amazonaws.internal.SdkInternalList<T> instanceIds
The IDs of the target instances.
String name
Specifies the operation. You can specify only one command.
For stacks, the following commands are available:
execute_recipes: Execute one or more recipes. To specify
the recipes, set an Args parameter named
recipes to the list of recipes to be executed. For example,
to execute phpapp::appsetup, set Args to
{"recipes":["phpapp::appsetup"]}.install_dependencies: Install the stack's dependencies.update_custom_cookbooks: Update the stack's custom
cookbooks.update_dependencies: Update the stack's dependencies.For apps, the following commands are available:
deploy: Deploy an app. Ruby on Rails apps have an
optional Args parameter named migrate. Set
Args to {"migrate":["true"]} to migrate the database. The
default setting is {"migrate":["false"]}.rollback Roll the app back to the previous version. When
you update an app, AWS OpsWorks stores the previous version, up to a
maximum of five versions. You can use this command to roll an app back as
many as four versions.start: Start the app's web or application server.stop: Stop the app's web or application server.restart: Restart the app's web or application server.undeploy: Undeploy the app.com.amazonaws.internal.SdkInternalMap<K,V> args
The arguments of those commands that take arguments. It should be set to a JSON object with the following format:
{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}
The update_dependencies command takes two arguments:
upgrade_os_to - Specifies the desired Amazon Linux
version for instances whose OS you want to upgrade, such as
Amazon Linux 2014.09. You must also set the
allow_reboot argument to true.allow_reboot - Specifies whether to allow AWS OpsWorks
to reboot the instances if necessary, after installing the updates. This
argument can be set to either true or false.
The default value is false.
For example, to upgrade an instance to Amazon Linux 2014.09, set
Args to the following.
{ "upgrade_os_to":["Amazon Linux 2014.09"], "allow_reboot":["true"] } String ecsClusterArn
The cluster's ARN.
String elasticIp
The Elastic IP address.
String instanceId
The instance ID.
String rdsDbInstanceArn
The Amazon RDS instance's ARN.
String volumeId
The AWS OpsWorks volume ID, which is the GUID that AWS OpsWorks assigned to the instance when you registered the volume with the stack, not the Amazon EC2 volume ID.
String stackId
The stack ID.
StackConfigurationManager configurationManager
The configuration manager.
com.amazonaws.internal.SdkInternalList<T> agentVersions
The agent versions for the specified stack or configuration manager. Note that this value is the complete version number, not the abbreviated number used by the console.
String stackId
The app stack ID. If you use this parameter, DescribeApps
returns a description of the apps in the specified stack.
com.amazonaws.internal.SdkInternalList<T> appIds
An array of app IDs for the apps to be described. If you use this
parameter, DescribeApps returns a description of the
specified apps. Otherwise, it returns a description of every app.
com.amazonaws.internal.SdkInternalList<T> apps
An array of App objects that describe the specified apps.
String deploymentId
The deployment ID. If you include this parameter,
DescribeCommands returns a description of the commands
associated with the specified deployment.
String instanceId
The instance ID. If you include this parameter,
DescribeCommands returns a description of the commands
associated with the specified instance.
com.amazonaws.internal.SdkInternalList<T> commandIds
An array of command IDs. If you include this parameter,
DescribeCommands returns a description of the specified
commands. Otherwise, it returns a description of every command.
com.amazonaws.internal.SdkInternalList<T> commands
An array of Command objects that describe each of the
specified commands.
String stackId
The stack ID. If you include this parameter,
DescribeDeployments returns a description of the commands
associated with the specified stack.
String appId
The app ID. If you include this parameter,
DescribeDeployments returns a description of the commands
associated with the specified app.
com.amazonaws.internal.SdkInternalList<T> deploymentIds
An array of deployment IDs to be described. If you include this
parameter, DescribeDeployments returns a description of the
specified deployments. Otherwise, it returns a description of every
deployment.
com.amazonaws.internal.SdkInternalList<T> deployments
An array of Deployment objects that describe the
deployments.
com.amazonaws.internal.SdkInternalList<T> ecsClusterArns
A list of ARNs, one for each cluster to be described.
String stackId
A stack ID. DescribeEcsClusters returns a description of the
cluster that is registered with the stack.
String nextToken
If the previous paginated request did not return all of the remaining
results, the response object'sNextToken parameter value is
set to a token. To retrieve the next set of results, call
DescribeEcsClusters again and assign that token to the
request object's NextToken parameter. If there are no
remaining results, the previous response object's NextToken
parameter is set to null.
Integer maxResults
To receive a paginated response, use this parameter to specify the
maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes a
NextToken value that you can assign to the
NextToken request parameter to get the next set of results.
com.amazonaws.internal.SdkInternalList<T> ecsClusters
A list of EcsCluster objects containing the cluster
descriptions.
String nextToken
If a paginated request does not return all of the remaining results, this
parameter is set to a token that you can assign to the request object's
NextToken parameter to retrieve the next set of results. If
the previous paginated request returned all of the remaining results,
this parameter is set to null.
String instanceId
The instance ID. If you include this parameter,
DescribeElasticIps returns a description of the Elastic IP
addresses associated with the specified instance.
String stackId
A stack ID. If you include this parameter,
DescribeElasticIps returns a description of the Elastic IP
addresses that are registered with the specified stack.
com.amazonaws.internal.SdkInternalList<T> ips
An array of Elastic IP addresses to be described. If you include this
parameter, DescribeElasticIps returns a description of the
specified Elastic IP addresses. Otherwise, it returns a description of
every Elastic IP address.
com.amazonaws.internal.SdkInternalList<T> elasticIps
An ElasticIps object that describes the specified Elastic IP
addresses.
String stackId
A stack ID. The action describes the stack's Elastic Load Balancing instances.
com.amazonaws.internal.SdkInternalList<T> layerIds
A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.
com.amazonaws.internal.SdkInternalList<T> elasticLoadBalancers
A list of ElasticLoadBalancer objects that describe the
specified Elastic Load Balancing instances.
String stackId
A stack ID. If you use this parameter, DescribeInstances
returns descriptions of the instances associated with the specified
stack.
String layerId
A layer ID. If you use this parameter, DescribeInstances
returns descriptions of the instances associated with the specified
layer.
com.amazonaws.internal.SdkInternalList<T> instanceIds
An array of instance IDs to be described. If you use this parameter,
DescribeInstances returns a description of the specified
instances. Otherwise, it returns a description of every instance.
com.amazonaws.internal.SdkInternalList<T> instances
An array of Instance objects that describe the instances.
String stackId
The stack ID.
com.amazonaws.internal.SdkInternalList<T> layerIds
An array of layer IDs that specify the layers to be described. If you
omit this parameter, DescribeLayers returns a description of
every layer in the specified stack.
com.amazonaws.internal.SdkInternalList<T> layers
An array of Layer objects that describe the layers.
com.amazonaws.internal.SdkInternalList<T> layerIds
An array of layer IDs.
com.amazonaws.internal.SdkInternalList<T> loadBasedAutoScalingConfigurations
An array of LoadBasedAutoScalingConfiguration objects that
describe each layer's configuration.
SelfUserProfile userProfile
A UserProfile object that describes the user's SSH
information.
String iamUserArn
The user's IAM ARN. For more information about IAM ARNs, see Using Identifiers.
String stackId
The stack ID.
com.amazonaws.internal.SdkInternalList<T> permissions
An array of 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
The instance ID. If you use this parameter,
DescribeRaidArrays returns descriptions of the RAID arrays
associated with the specified instance.
String stackId
The stack ID.
com.amazonaws.internal.SdkInternalList<T> raidArrayIds
An array of RAID array IDs. If you use this parameter,
DescribeRaidArrays returns descriptions of the specified
arrays. Otherwise, it returns a description of every array.
com.amazonaws.internal.SdkInternalList<T> raidArrays
A RaidArrays object that describes the specified RAID
arrays.
String stackId
The stack ID that the instances are registered with. The operation returns descriptions of all registered Amazon RDS instances.
com.amazonaws.internal.SdkInternalList<T> rdsDbInstanceArns
An array containing the ARNs of the instances to be described.
com.amazonaws.internal.SdkInternalList<T> rdsDbInstances
An a array of RdsDbInstance objects that describe the
instances.
String stackId
The stack ID. If you use this parameter,
DescribeServiceErrors returns descriptions of the errors
associated with the specified stack.
String instanceId
The instance ID. If you use this parameter,
DescribeServiceErrors returns descriptions of the errors
associated with the specified instance.
com.amazonaws.internal.SdkInternalList<T> serviceErrorIds
An array of service error IDs. If you use this parameter,
DescribeServiceErrors returns descriptions of the specified
errors. Otherwise, it returns a description of every error.
com.amazonaws.internal.SdkInternalList<T> serviceErrors
An array of ServiceError objects that describe the specified
service errors.
String stackId
The stack ID
String agentInstallerUrl
The AWS OpsWorks agent installer's URL.
com.amazonaws.internal.SdkInternalMap<K,V> parameters
An embedded object that contains the provisioning parameters.
com.amazonaws.internal.SdkInternalList<T> stackIds
An array of stack IDs that specify the stacks to be described. If you
omit this parameter, DescribeStacks returns a description of
every stack.
com.amazonaws.internal.SdkInternalList<T> stacks
An array of Stack objects that describe the stacks.
String stackId
The stack ID.
StackSummary stackSummary
A StackSummary object that contains the results.
com.amazonaws.internal.SdkInternalList<T> instanceIds
An array of instance IDs.
com.amazonaws.internal.SdkInternalList<T> timeBasedAutoScalingConfigurations
An array of TimeBasedAutoScalingConfiguration objects that
describe the configuration for the specified instances.
com.amazonaws.internal.SdkInternalList<T> iamUserArns
An array of IAM user ARNs that identify the users to be described.
com.amazonaws.internal.SdkInternalList<T> userProfiles
A Users object that describes the specified users.
String instanceId
The instance ID. If you use this parameter, DescribeVolumes
returns descriptions of the volumes associated with the specified
instance.
String stackId
A stack ID. The action describes the stack's registered Amazon EBS volumes.
String raidArrayId
The RAID array ID. If you use this parameter,
DescribeVolumes returns descriptions of the volumes
associated with the specified RAID array.
com.amazonaws.internal.SdkInternalList<T> volumeIds
Am array of volume IDs. If you use this parameter,
DescribeVolumes returns descriptions of the specified
volumes. Otherwise, it returns a description of every volume.
com.amazonaws.internal.SdkInternalList<T> volumes
An array of volume IDs.
String elasticIp
The Elastic IP address.
String snapshotId
The snapshot ID.
Integer iops
The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice.
Integer volumeSize
The volume size, in GiB. For more information, see EbsBlockDevice.
String volumeType
The volume type. gp2 for General Purpose (SSD) volumes,
io1 for Provisioned IOPS (SSD) volumes, and
standard for Magnetic volumes.
Boolean deleteOnTermination
Whether the volume is deleted on instance termination.
String elasticLoadBalancerName
The Elastic Load Balancing instance's name.
String region
The instance's AWS region.
String dnsName
The instance's public DNS name.
String stackId
The ID of the stack that the instance is associated with.
String layerId
The ID of the layer that the instance is attached to.
String vpcId
The VPC ID.
com.amazonaws.internal.SdkInternalList<T> availabilityZones
A list of Availability Zones.
com.amazonaws.internal.SdkInternalList<T> subnetIds
A list of subnet IDs, if the stack is running in a VPC.
com.amazonaws.internal.SdkInternalList<T> ec2InstanceIds
A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.
String key
(Required) The environment variable's name, which can consist of up to 64 characters and must be specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.
String value
(Optional) The environment variable's value, which can be left empty. If you specify a value, it can contain up to 256 characters, which must all be printable.
Boolean secure
(Optional) Whether the variable's value will be returned by the
DescribeApps action. To conceal an environment variable's value,
set Secure to true. DescribeApps
then returns *****FILTERED***** instead of the actual value.
The default value for Secure is false.
String layerId
The layer ID.
String instanceId
The instance's AWS OpsWorks ID.
Integer validForInMinutes
The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, the user will no longer be able to use the credentials to log in. If the user is logged in at the time, he or she automatically will be logged out.
TemporaryCredential temporaryCredential
A TemporaryCredential object that contains the data needed
to log in to the instance by RDP clients, such as the Microsoft Remote
Desktop Connection.
String agentVersion
The agent version. This parameter is set to INHERIT if the
instance inherits the default stack setting or to a a version number for
a fixed agent version.
String amiId
A custom AMI ID to be used to create the instance. For more information, see Instances
String architecture
The instance architecture: "i386" or "x86_64".
String autoScalingType
For load-based or time-based instances, the type.
String availabilityZone
The instance Availability Zone. For more information, see Regions and Endpoints.
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
An array of BlockDeviceMapping objects that specify the
instance's block device mappings.
String createdAt
The time that the instance was created.
Boolean ebsOptimized
Whether this is an Amazon EBS-optimized instance.
String ec2InstanceId
The ID of the associated Amazon EC2 instance.
String ecsClusterArn
For container instances, the Amazon ECS cluster's ARN.
String ecsContainerInstanceArn
For container instances, the instance's ARN.
String elasticIp
The instance Elastic IP address .
String hostname
The instance host name.
String infrastructureClass
For registered instances, the infrastructure class: ec2 or
on-premises.
Boolean installUpdatesOnBoot
Whether to install operating system and package updates when the instance
boots. The default value is true. If this value is set to
false, you must then update your instances manually by using
CreateDeployment to run the update_dependencies stack
command or by manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of true, to
ensure that your instances have the latest security updates.
String instanceId
The instance ID.
String instanceProfileArn
The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.
String instanceType
The instance type, such as t2.micro.
String lastServiceErrorId
The ID of the last service error. For more information, call DescribeServiceErrors.
com.amazonaws.internal.SdkInternalList<T> layerIds
An array containing the instance layer IDs.
String os
The instance's operating system.
String platform
The instance's platform.
String privateDns
The The instance's private DNS name.
String privateIp
The instance's private IP address.
String publicDns
The instance public DNS name.
String publicIp
The instance public IP address.
String registeredBy
For registered instances, who performed the registration.
String reportedAgentVersion
The instance's reported AWS OpsWorks agent version.
ReportedOs reportedOs
For registered instances, the reported operating system.
String rootDeviceType
The instance's root device type. For more information, see Storage for the Root Device.
String rootDeviceVolumeId
The root device volume ID.
com.amazonaws.internal.SdkInternalList<T> securityGroupIds
An array containing the instance security group IDs.
String sshHostDsaKeyFingerprint
The SSH key's Deep Security Agent (DSA) fingerprint.
String sshHostRsaKeyFingerprint
The SSH key's RSA fingerprint.
String sshKeyName
The instance's Amazon EC2 key-pair name.
String stackId
The stack ID.
String status
The instance status:
bootingconnection_lostonlinependingrebootingrequestedrunning_setupsetup_failedshutting_downstart_failedstoppedstoppingterminatedterminatingString subnetId
The instance's subnet ID; applicable only if the stack is running in a VPC.
String virtualizationType
The instance's virtualization type: paravirtual or
hvm.
Integer assigning
The number of instances in the Assigning state.
Integer booting
The number of instances with booting status.
Integer connectionLost
The number of instances with connection_lost status.
Integer deregistering
The number of instances in the Deregistering state.
Integer online
The number of instances with online status.
Integer pending
The number of instances with pending status.
Integer rebooting
The number of instances with rebooting status.
Integer registered
The number of instances in the Registered state.
Integer registering
The number of instances in the Registering state.
Integer requested
The number of instances with requested status.
Integer runningSetup
The number of instances with running_setup status.
Integer setupFailed
The number of instances with setup_failed status.
Integer shuttingDown
The number of instances with shutting_down status.
Integer startFailed
The number of instances with start_failed status.
Integer stopped
The number of instances with stopped status.
Integer stopping
The number of instances with stopping status.
Integer terminated
The number of instances with terminated status.
Integer terminating
The number of instances with terminating status.
Integer unassigning
The number of instances in the Unassigning state.
String stackId
The layer stack ID.
String layerId
The layer ID.
String type
The layer type.
String name
The layer name.
String shortname
The layer short name.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
The layer attributes.
For the HaproxyStatsPassword, MysqlRootPassword
, and GangliaPassword attributes, AWS OpsWorks returns
*****FILTERED***** instead of the actual value
For an ECS Cluster layer, AWS OpsWorks the EcsClusterArn
attribute is set to the cluster's ARN.
String customInstanceProfileArn
The ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
String customJson
A JSON formatted string containing the layer's custom stack configuration and deployment attributes.
com.amazonaws.internal.SdkInternalList<T> customSecurityGroupIds
An array containing the layer's custom security group IDs.
com.amazonaws.internal.SdkInternalList<T> defaultSecurityGroupNames
An array containing the layer's security group names.
com.amazonaws.internal.SdkInternalList<T> packages
An array of Package objects that describe the layer's
packages.
com.amazonaws.internal.SdkInternalList<T> volumeConfigurations
A VolumeConfigurations object that describes the layer's
Amazon EBS volumes.
Boolean enableAutoHealing
Whether auto healing is disabled for the layer.
Boolean autoAssignElasticIps
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
Boolean autoAssignPublicIps
For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.
Recipes defaultRecipes
Recipes customRecipes
A LayerCustomRecipes object that specifies the layer's
custom recipes.
String createdAt
Date when the layer was created.
Boolean installUpdatesOnBoot
Whether to install operating system and package updates when the instance
boots. The default value is true. If this value is set to
false, you must then update your instances manually by using
CreateDeployment to run the update_dependencies stack
command or manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of true, to
ensure that your instances have the latest security updates.
Boolean useEbsOptimizedInstances
Whether the layer uses Amazon EBS-optimized instances.
LifecycleEventConfiguration lifecycleEventConfiguration
A LifeCycleEventConfiguration object that specifies the
Shutdown event configuration.
ShutdownEventConfiguration shutdown
A ShutdownEventConfiguration object that specifies the
Shutdown event configuration.
String layerId
The layer ID.
Boolean enable
Whether load-based auto scaling is enabled for the layer.
AutoScalingThresholds upScaling
An AutoScalingThresholds object that describes the upscaling
configuration, which defines how and when AWS OpsWorks increases the
number of instances.
AutoScalingThresholds downScaling
An AutoScalingThresholds object that describes the
downscaling configuration, which defines how and when AWS OpsWorks
reduces the number of instances.
String stackId
A stack ID.
String iamUserArn
The Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) role. For more information about IAM ARNs, see Using Identifiers.
Boolean allowSsh
Whether the user can use SSH.
Boolean allowSudo
Whether the user can use sudo.
String level
The user's permission level, which must be the following:
denyshowdeploymanageiam_onlyFor more information on the permissions associated with these levels, see Managing User Permissions
String raidArrayId
The array ID.
String instanceId
The instance ID.
String name
The array name.
Integer raidLevel
The RAID level.
Integer numberOfDisks
The number of disks in the array.
Integer size
The array's size.
String device
The array's Linux device. For example /dev/mdadm0.
String mountPoint
The array's mount point.
String availabilityZone
The array's Availability Zone. For more information, see Regions and Endpoints.
String createdAt
When the RAID array was created.
String stackId
The stack ID.
String volumeType
The volume type, standard or PIOPS.
Integer iops
For PIOPS volumes, the IOPS per disk.
String rdsDbInstanceArn
The instance's ARN.
String dbInstanceIdentifier
The DB instance identifier.
String dbUser
The master user name.
String dbPassword
AWS OpsWorks returns *****FILTERED***** instead of the
actual value.
String region
The instance's AWS region.
String address
The instance's address.
String engine
The instance's database engine.
String stackId
The ID of the stack that the instance is registered with.
Boolean missingOnRds
Set to true if AWS OpsWorks was unable to discover the
Amazon RDS instance. AWS OpsWorks attempts to discover the instance only
once. If this value is set to true, you must deregister the
instance and then register it again.
String instanceId
The instance ID.
com.amazonaws.internal.SdkInternalList<T> setup
An array of custom recipe names to be run following a setup
event.
com.amazonaws.internal.SdkInternalList<T> configure
An array of custom recipe names to be run following a
configure event.
com.amazonaws.internal.SdkInternalList<T> deploy
An array of custom recipe names to be run following a deploy
event.
com.amazonaws.internal.SdkInternalList<T> undeploy
An array of custom recipe names to be run following a
undeploy event.
com.amazonaws.internal.SdkInternalList<T> shutdown
An array of custom recipe names to be run following a
shutdown event.
String ecsClusterArn
The cluster's ARN.
String elasticIp
The Elastic IP address.
String stackId
The ID of the stack that the instance is to be registered with.
String hostname
The instance's hostname.
String publicIp
The instance's public IP address.
String privateIp
The instance's private IP address.
String rsaPublicKey
The instances public RSA key. This key is used to encrypt communication between the instance and the service.
String rsaPublicKeyFingerprint
The instances public RSA key fingerprint.
InstanceIdentity instanceIdentity
An InstanceIdentity object that contains the instance's identity.
String instanceId
The registered instance's AWS OpsWorks ID.
String volumeId
The volume ID.
String layerId
The layer ID.
Boolean enable
Enables load-based auto scaling for the layer.
AutoScalingThresholds upScaling
An 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
An AutoScalingThresholds object with the downscaling
threshold configuration. If the load falls below these thresholds for a
specified amount of time, AWS OpsWorks stops a specified number of
instances.
String stackId
The stack ID.
String iamUserArn
The user's IAM ARN.
Boolean allowSsh
The user is allowed to use SSH to communicate with the instance.
Boolean allowSudo
The user is allowed to use sudo to elevate privileges.
String level
The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.
denyshowdeploymanageiam_onlyFor more information on the permissions associated with these levels, see Managing User Permissions.
String instanceId
The instance ID.
WeeklyAutoScalingSchedule autoScalingSchedule
An AutoScalingSchedule with the instance schedule.
Integer executionTimeout
The time, in seconds, that AWS OpsWorks will wait after triggering a Shutdown event before shutting down an instance.
Boolean delayUntilElbConnectionsDrained
Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining
String type
The repository type.
String url
The source URL.
String username
This parameter depends on the repository type.
Username to the appropriate
IAM access key ID.Username to the user name.String password
When included in a request, the parameter depends on the repository type.
Password to the appropriate
IAM secret access key.Password to the password.For more information on how to safely handle IAM credentials, see .
In responses, AWS OpsWorks returns *****FILTERED*****
instead of the actual value.
String sshKey
In requests, the repository's SSH key.
In responses, AWS OpsWorks returns *****FILTERED*****
instead of the actual value.
String revision
The application's version. AWS OpsWorks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.
String stackId
The stack ID.
String name
The stack name.
String arn
The stack's ARN.
String region
The stack AWS region, such as "us-east-1". For more information about AWS regions, see Regions and Endpoints.
String vpcId
The VPC ID; applicable only if the stack is running in a VPC.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
The stack's attributes.
String serviceRoleArn
The stack AWS Identity and Access Management (IAM) role.
String defaultInstanceProfileArn
The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
String defaultOs
The stack's default operating system.
String hostnameTheme
The stack host name theme, with spaces replaced by underscores.
String defaultAvailabilityZone
The stack's default Availability Zone. For more information, see Regions and Endpoints.
String defaultSubnetId
The default subnet ID; applicable only if the stack is running in a VPC.
String customJson
A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format and must escape characters such as '"':
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
StackConfigurationManager configurationManager
The configuration manager.
ChefConfiguration chefConfiguration
A ChefConfiguration object that specifies whether to enable
Berkshelf and the Berkshelf version. For more information, see Create a New Stack.
Boolean useCustomCookbooks
Whether the stack uses custom cookbooks.
Boolean useOpsworksSecurityGroups
Whether the stack automatically associates the AWS OpsWorks built-in security groups with the stack's layers.
Source customCookbooksSource
String defaultSshKeyName
A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.
String createdAt
The date when the stack was created.
String defaultRootDeviceType
The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
String agentVersion
The agent version. This parameter is set to LATEST for
auto-update. or a version number for a fixed agent version.
String stackId
The stack ID.
String name
The stack name.
String arn
The stack's ARN.
Integer layersCount
The number of layers.
Integer appsCount
The number of apps.
InstancesCount instancesCount
An InstancesCount object with the number of instances in
each status.
String instanceId
The instance ID.
String stackId
The stack ID.
String instanceId
The instance ID.
String stackId
The stack ID.
String username
The user name.
String password
The password.
Integer validForInMinutes
The length of time (in minutes) that the grant is valid. When the grant expires, at the end of this period, the user will no longer be able to use the credentials to log in. If they are logged in at the time, they will be automatically logged out.
String instanceId
The instance's AWS OpsWorks ID.
String instanceId
The instance ID.
WeeklyAutoScalingSchedule autoScalingSchedule
A WeeklyAutoScalingSchedule object with the instance
schedule.
String instanceId
The instance ID.
String volumeId
The volume ID.
String appId
The app ID.
String name
The app name.
String description
A description of the app.
com.amazonaws.internal.SdkInternalList<T> dataSources
The app's data sources.
String type
The app type.
Source appSource
A Source object that specifies the app repository.
com.amazonaws.internal.SdkInternalList<T> domains
The app's virtual host settings, with multiple domains separated by
commas. For example: 'www.example.com, example.com'
Boolean enableSsl
Whether SSL is enabled for the app.
SslConfiguration sslConfiguration
An SslConfiguration object with the SSL configuration.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
One or more user-defined key/value pairs to be added to the stack attributes.
com.amazonaws.internal.SdkInternalList<T> environment
An array of EnvironmentVariable objects that specify
environment variables to be associated with the app. After you deploy the
app, these variables are defined on the associated app server
instances.For more information, see Environment Variables.
There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 10KB)."
String instanceId
The instance ID.
com.amazonaws.internal.SdkInternalList<T> layerIds
The instance's layer IDs.
String instanceType
The instance type, such as t2.micro. For a list of supported
instance types, open the stack in the console, choose Instances,
and choose + Instance. The Size list contains the currently
supported types. For more information, see Instance Families and Types. The parameter values that you use to
specify the various types are in the API Name column of the
Available Instance Types table.
String autoScalingType
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
String hostname
The instance host name.
String os
The instance's operating system, which must be set to one of the following.
Amazon Linux 2015.03,
Red Hat Enterprise Linux 7, Ubuntu 12.04 LTS,
or Ubuntu 14.04 LTS.Microsoft Windows Server 2012 R2 Base.Custom.For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
The default option is the current Amazon Linux version. If you set this
parameter to Custom, you must use the AmiId parameter to
specify the custom AMI that you want to use. For more information on the
supported operating systems, see Operating Systems. For more information on how to use custom AMIs
with OpsWorks, see Using Custom AMIs.
String amiId
A custom AMI ID to be used to create the instance. The AMI must be based on one of the supported operating systems. For more information, see Instances
Os to
Custom.String sshKeyName
The instance's Amazon EC2 key name.
String architecture
The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.
Boolean installUpdatesOnBoot
Whether to install operating system and package updates when the instance
boots. The default value is true. To control when updates
are installed, set this value to false. You must then update
your instances manually by using CreateDeployment to run the
update_dependencies stack command or by manually running
yum (Amazon Linux) or apt-get (Ubuntu) on the
instances.
We strongly recommend using the default value of true, to
ensure that your instances have the latest security updates.
Boolean ebsOptimized
This property cannot be updated.
String agentVersion
The default AWS OpsWorks agent version. You have the following options:
INHERIT - Use the stack's default agent version setting.
The default setting is INHERIT. To specify an agent version,
you must use the complete version number, not the abbreviated number
shown on the console. For a list of available agent version numbers, call
DescribeAgentVersions.
String layerId
The layer ID.
String name
The layer name, which is used by the console.
String shortname
For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorksand by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\A[a-z0-9\-\_\.]+\Z/.
The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference
com.amazonaws.internal.SdkInternalMap<K,V> attributes
One or more user-defined key/value pairs to be added to the stack attributes.
String customInstanceProfileArn
The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
String customJson
A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON.
com.amazonaws.internal.SdkInternalList<T> customSecurityGroupIds
An array containing the layer's custom security group IDs.
com.amazonaws.internal.SdkInternalList<T> packages
An array of Package objects that describe the layer's
packages.
com.amazonaws.internal.SdkInternalList<T> volumeConfigurations
A VolumeConfigurations object that describes the layer's
Amazon EBS volumes.
Boolean enableAutoHealing
Whether to disable auto healing for the layer.
Boolean autoAssignElasticIps
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
Boolean autoAssignPublicIps
For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.
Recipes customRecipes
A LayerCustomRecipes object that specifies the layer's
custom recipes.
Boolean installUpdatesOnBoot
Whether to install operating system and package updates when the instance
boots. The default value is true. To control when updates
are installed, set this value to false. You must then update
your instances manually by using CreateDeployment to run the
update_dependencies stack command or manually running
yum (Amazon Linux) or apt-get (Ubuntu) on the
instances.
We strongly recommend using the default value of true, to
ensure that your instances have the latest security updates.
Boolean useEbsOptimizedInstances
Whether to use Amazon EBS-optimized instances.
LifecycleEventConfiguration lifecycleEventConfiguration
String sshPublicKey
The user's SSH public key.
String stackId
The stack ID.
String name
The stack's new name.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
One or more user-defined key-value pairs to be added to the stack attributes.
String serviceRoleArn
Do not use this parameter. You cannot update a stack's service role.
String defaultInstanceProfileArn
The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
String defaultOs
The stack's operating system, which must be set to one of the following:
Amazon Linux 2015.03,
Red Hat Enterprise Linux 7, Ubuntu 12.04 LTS,
or Ubuntu 14.04 LTS.Microsoft Windows Server 2012 R2 Base.Custom. You specify the custom AMI you
want to use when you create instances. For more information on how to use
custom AMIs with OpsWorks, see Using Custom AMIs.The default option is the stack's current operating system. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
String hostnameTheme
The stack's new host name theme, with spaces replaced by underscores. The
theme is used to generate host names for the stack's instances. By
default, HostnameTheme is set to
Layer_Dependent, which creates host names by appending
integers to the layer's short name. The other themes are:
Baked_GoodsCloudsEurope_CitiesFruitsGreek_DeitiesLegendary_creatures_from_JapanPlanets_and_MoonsRoman_DeitiesScottish_IslandsUS_CitiesWild_Cats
To obtain a generated host name, call GetHostNameSuggestion,
which returns a host name based on the current theme.
String defaultAvailabilityZone
The stack's default Availability Zone, which must be in the stack's
region. For more information, see Regions
and Endpoints. If you also specify a value for
DefaultSubnetId, the subnet must be in the same zone. For
more information, see CreateStack.
String defaultSubnetId
The stack's default VPC subnet ID. This parameter is required if you
specify a value for the VpcId parameter. All instances are
launched into this subnet unless you specify otherwise when you create
the instance. If you also specify a value for
DefaultAvailabilityZone, the subnet must be in that zone.
For information on default values and when this parameter is required,
see the VpcId parameter description.
String customJson
A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format and escape characters such as '"':
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
StackConfigurationManager configurationManager
The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 11.4.
ChefConfiguration chefConfiguration
A ChefConfiguration object that specifies whether to enable
Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more
information, see Create a New Stack.
Boolean useCustomCookbooks
Whether the stack uses custom cookbooks.
Source customCookbooksSource
String defaultSshKeyName
A default Amazon EC2 key-pair name. The default value is
none. If you specify a key-pair name, AWS OpsWorks installs
the public key on the instance and you can use the private key with an
SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a
different key pair, or no key pair, when you create an instance.
String defaultRootDeviceType
The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
Boolean useOpsworksSecurityGroups
Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.
AWS OpsWorks provides a standard set of built-in security groups, one for
each layer, which are associated with layers by default.
UseOpsworksSecurityGroups allows you to provide your own
custom security groups instead of using the built-in groups.
UseOpsworksSecurityGroups has the following settings:
For more information, see Create a New Stack.
String agentVersion
The default AWS OpsWorks agent version. You have the following options:
LATEST. AWS OpsWorks
automatically installs new agent versions on the stack's instances as
soon as they are available.
The default setting is LATEST. To specify an agent version,
you must use the complete version number, not the abbreviated number
shown on the console. For a list of available agent version numbers, call
DescribeAgentVersions.
String iamUserArn
The user IAM ARN.
String sshUsername
The user's SSH user name. The allowable characters are [a-z], [A-Z],
[0-9], '-', and '_'. If the specified name includes other punctuation
marks, AWS OpsWorks removes them. For example, my.name will
be changed to myname. If you do not specify an SSH user
name, AWS OpsWorks generates one from the IAM user name.
String sshPublicKey
The user's new SSH public key.
Boolean allowSelfManagement
Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.
String iamUserArn
The user's IAM ARN.
String name
The user's name.
String sshUsername
The user's SSH user name.
String sshPublicKey
The user's SSH public key.
Boolean allowSelfManagement
Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.
String volumeId
The volume ID.
String ec2VolumeId
The Amazon EC2 volume ID.
String name
The volume name.
String raidArrayId
The RAID array ID.
String instanceId
The instance ID.
String status
The value returned by DescribeVolumes.
Integer size
The volume size.
String device
The device name.
String mountPoint
The volume mount point. For example "/dev/sdh".
String region
The AWS region. For more information about AWS regions, see Regions and Endpoints.
String availabilityZone
The volume Availability Zone. For more information, see Regions and Endpoints.
String volumeType
The volume type, standard or PIOPS.
Integer iops
For PIOPS volumes, the IOPS per disk.
String mountPoint
The volume mount point. For example "/dev/sdh".
Integer raidLevel
The volume RAID level.
Integer numberOfDisks
The number of disks in the volume.
Integer size
The volume size.
String volumeType
The volume type:
standard - Magneticio1 - Provisioned IOPS (SSD)gp2 - General Purpose (SSD)Integer iops
For PIOPS volumes, the IOPS per disk.
com.amazonaws.internal.SdkInternalMap<K,V> monday
The schedule for Monday.
com.amazonaws.internal.SdkInternalMap<K,V> tuesday
The schedule for Tuesday.
com.amazonaws.internal.SdkInternalMap<K,V> wednesday
The schedule for Wednesday.
com.amazonaws.internal.SdkInternalMap<K,V> thursday
The schedule for Thursday.
com.amazonaws.internal.SdkInternalMap<K,V> friday
The schedule for Friday.
com.amazonaws.internal.SdkInternalMap<K,V> saturday
The schedule for Saturday.
com.amazonaws.internal.SdkInternalMap<K,V> sunday
The schedule for Sunday.
String subscriptionName
String sourceIdentifier
Constraints:
DBInstanceIdentifier must be supplied.DBSecurityGroupName must be supplied.DBParameterGroupName must be supplied.DBSnapshotIdentifier must
be supplied.String resourceName
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String resourceIdentifier
String applyAction
String optInType
immediate cannot be
undone. Valid values:
immediate - Apply the
maintenance action immediately.next-maintenance - Apply the maintenance action during
the next maintenance window for the resource.undo-opt-in - Cancel any existing
next-maintenance opt-in requests.String dBSecurityGroupName
String cIDRIP
String eC2SecurityGroupName
EC2SecurityGroupId must be provided. Otherwise,
EC2SecurityGroupOwnerId and either
EC2SecurityGroupName or EC2SecurityGroupId
must be provided.String eC2SecurityGroupId
EC2SecurityGroupId must be provided. Otherwise,
EC2SecurityGroupOwnerId and either
EC2SecurityGroupName or EC2SecurityGroupId
must be provided.String eC2SecurityGroupOwnerId
EC2SecurityGroupName parameter. The AWS Access Key ID
is not an acceptable value. For VPC DB security groups,
EC2SecurityGroupId must be provided. Otherwise,
EC2SecurityGroupOwnerId and either
EC2SecurityGroupName or EC2SecurityGroupId
must be provided.String name
String certificateIdentifier
String certificateType
String thumbprint
Date validFrom
Date validTill
String sourceDBClusterSnapshotIdentifier
Constraints:
Example: my-cluster-snapshot1
String targetDBClusterSnapshotIdentifier
Constraints:
Example: my-cluster-snapshot2
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String sourceDBParameterGroupIdentifier
Constraints:
my-db-param-group, or a valid ARN.arn:aws:rds:us-west-2:123456789012:pg:special-parameters.String targetDBParameterGroupIdentifier
Constraints:
Example:
my-db-parameter-group
String targetDBParameterGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String sourceDBSnapshotIdentifier
If you are copying from a shared manual DB snapshot, this must be the ARN of the shared DB snapshot.
Constraints:
Example:
rds:mydb-2012-04-02-00-01
Example:
arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805
String targetDBSnapshotIdentifier
Constraints:
Example: my-db-snapshot
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Boolean copyTags
String sourceOptionGroupIdentifier
Constraints:
my-option-group, or a valid
ARN.arn:aws:rds:us-west-2:123456789012:og:special-options.String targetOptionGroupIdentifier
Constraints:
Example:
my-option-group
String targetOptionGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBClusterParameterGroupName
Constraints:
String dBParameterGroupFamily
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Integer backupRetentionPeriod
Default: 1
Constraints:
String characterSetName
String databaseName
String dBClusterIdentifier
Constraints:
Example: my-cluster1
String dBClusterParameterGroupName
default.aurora5.6
for the specified engine will be used. Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
String dBSubnetGroupName
String engine
Valid Values: aurora
String engineVersion
Aurora
Example: 5.6.10a
Integer port
Default: 3306
String masterUsername
Constraints:
String masterUserPassword
Constraints: Must contain from 8 to 41 characters.
String optionGroupName
Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.
String preferredBackupWindow
BackupRetentionPeriod parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
hh24:mi-hh24:mi.String preferredMaintenanceWindow
Format:
ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Boolean storageEncrypted
String kmsKeyId
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted parameter is true, and
you do not specify a value for the KmsKeyId parameter,
then Amazon RDS will use your default encryption key. AWS KMS creates
the default encryption key for your AWS account. Your AWS account has
a different default encryption key for each AWS region.
String dBClusterSnapshotIdentifier
Constraints:
Example: my-cluster1-snapshot1
String dBClusterIdentifier
Constraints:
Example:
my-cluster1
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBInstanceIdentifier
String sourceDBInstanceIdentifier
Constraints:
String dBInstanceClass
Valid Values:
db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge |
db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium |
db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large |
db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge |
db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge |
db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium |
db.t2.large
Default: Inherits from the source DB instance.
String availabilityZone
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
Integer port
Default: Inherits from the source DB instance
Valid Values:
1150-65535
Boolean autoMinorVersionUpgrade
Default: Inherits from the source DB instance
Integer iops
String optionGroupName
Boolean publiclyAccessible
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBSubnetGroupName
Constraints:
String storageType
Valid values: standard | gp2 | io1
If you specify
io1, you must also include a value for the
Iops parameter.
Default: io1 if the
Iops parameter is specified; otherwise
standard
Boolean copyTagsToSnapshot
Integer monitoringInterval
If
MonitoringRoleArn is specified, then you must also set
MonitoringInterval to a value other than 0.
Valid
Values: 0, 1, 5, 10, 15, 30, 60
String monitoringRoleArn
arn:aws:iam:123456789012:role/emaccess. For information
on creating a monitoring role, go to To
create an IAM role for Amazon RDS Enhanced Monitoring. If
MonitoringInterval is set to a value other than 0, then
you must supply a MonitoringRoleArn value.
String dBName
Type: String
MySQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
MariaDB
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter is not specified, the default "postgres" database is created in the DB instance.
Constraints:
Oracle
The Oracle System ID (SID) of the created DB instance.
Default: ORCL
Constraints:
SQL Server
Not applicable. Must be null.
Amazon Aurora
The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
String dBInstanceIdentifier
Constraints:
Example:
mydbinstance
Integer allocatedStorage
Type: Integer
MySQL
Constraints: Must be an integer from 5 to 6144.
MariaDB
Constraints: Must be an integer from 5 to 6144.
PostgreSQL
Constraints: Must be an integer from 5 to 6144.
Oracle
Constraints: Must be an integer from 10 to 6144.
SQL Server
Constraints: Must be an integer from 200 to 4096 (Standard Edition and Enterprise Edition) or from 20 to 4096 (Express Edition and Web Edition)
String dBInstanceClass
Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large |
db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge |
db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge |
db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge |
db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge |
db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small |
db.t2.medium | db.t2.large
String engine
Valid Values: MySQL | mariadb |
oracle-se1 | oracle-se |
oracle-ee | sqlserver-ee |
sqlserver-se | sqlserver-ex |
sqlserver-web | postgres |
aurora
Not every database engine is available for every AWS region.
String masterUsername
MySQL
Constraints:
MariaDB
Constraints:
Type: String
Oracle
Constraints:
SQL Server
Constraints:
PostgreSQL
Constraints:
String masterUserPassword
Type: String
MySQL
Constraints: Must contain from 8 to 41 characters.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
SQL Server
Constraints: Must contain from 8 to 128 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon Aurora
Constraints: Must contain from 8 to 41 characters.
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
Default: The default DB security group for the database engine.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Default: The default EC2 VPC security group for the DB subnet group's VPC.
String availabilityZone
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example:
us-east-1d
Constraint: The AvailabilityZone parameter
cannot be specified if the MultiAZ parameter is set to
true. The specified Availability Zone must be in the same
region as the current endpoint.
String dBSubnetGroupName
If there is no DB subnet group, then it is a non-VPC DB instance.
String preferredMaintenanceWindow
Format:
ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
String dBParameterGroupName
Constraints:
Integer backupRetentionPeriod
Default: 1
Constraints:
String preferredBackupWindow
BackupRetentionPeriod parameter. For more information,
see DB
Instance Backups. Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
hh24:mi-hh24:mi.Integer port
MySQL
Default: 3306
Valid Values:
1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values:
1150-65535
SQL Server
Default:
1433
Valid Values: 1150-65535 except for
1434, 3389, 47001,
49152, and 49152 through 49156.
Amazon Aurora
Default: 3306
Valid
Values: 1150-65535
Type: Integer
Boolean multiAZ
String engineVersion
The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS region.
MySQL
5.1.73a | 5.1.73b 5.5.40 | 5.5.40a 5.5.40b | 5.5.41 | 5.5.42 5.6.19a |
5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23MariaDB
10.0.17
Oracle Database Enterprise Edition (oracle-ee)
11.2.0.2.v3 |
11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7 11.2.0.3.v1
| 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 |
11.2.0.4.v412.1.0.1.v1 | 12.1.0.1.v2 | 12.1.0.2.v1
Oracle Database Standard Edition (oracle-se)
11.2.0.2.v3 | 11.2.0.2.v4 |
11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 |
11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v412.1.0.1.v1 | 12.1.0.1.v2Oracle Database Standard Edition One (oracle-se1)
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 |
11.2.0.2.v6 | 11.2.0.2.v7 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 |
11.2.0.4.v3 | 11.2.0.4.v4 12.1.0.1.v1 | 12.1.0.1.v2PostgreSQL
9.3.1 |
9.3.2 9.3.3 | 9.3.5 | 9.3.6 | 9.3.9 | 9.3.10 9.4.1 |
9.4.4 | 9.4.5Microsoft SQL Server Enterprise Edition (sqlserver-ee)
10.50.2789.0.v1 10.50.6000.34.v1
11.00.2100.60.v1 11.00.5058.0.v1Microsoft SQL Server Express Edition (sqlserver-ex)
10.50.2789.0.v1 10.50.6000.34.v1 11.00.2100.60.v1
11.00.5058.0.v1 12.00.4422.0.v1Microsoft SQL Server Standard Edition (sqlserver-se)
10.50.2789.0.v1 10.50.6000.34.v1 11.00.2100.60.v1
11.00.5058.0.v1 12.00.4422.0.v1Microsoft SQL Server Web Edition (sqlserver-web)
10.50.2789.0.v1
10.50.6000.34.v1 11.00.2100.60.v1 11.00.5058.0.v1
12.00.4422.0.v1Boolean autoMinorVersionUpgrade
Default:
true
String licenseModel
Valid values:
license-included | bring-your-own-license |
general-public-license
Integer iops
Constraints: To use PIOPS, this value must be an integer greater than 1000.
String optionGroupName
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
String characterSetName
Boolean publiclyAccessible
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBClusterIdentifier
For information on creating a DB cluster, see CreateDBCluster.
Type: String
String storageType
Valid values: standard | gp2 | io1
If you specify
io1, you must also include a value for the
Iops parameter.
Default: io1 if the
Iops parameter is specified; otherwise
standard
String tdeCredentialArn
String tdeCredentialPassword
Boolean storageEncrypted
Default: false
String kmsKeyId
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted parameter is true, and
you do not specify a value for the KmsKeyId parameter,
then Amazon RDS will use your default encryption key. AWS KMS creates
the default encryption key for your AWS account. Your AWS account has
a different default encryption key for each AWS region.
Boolean copyTagsToSnapshot
Integer monitoringInterval
If
MonitoringRoleArn is specified, then you must also set
MonitoringInterval to a value other than 0.
Valid
Values: 0, 1, 5, 10, 15, 30, 60
String monitoringRoleArn
arn:aws:iam:123456789012:role/emaccess. For information
on creating a monitoring role, go to To
create an IAM role for Amazon RDS Enhanced Monitoring. If
MonitoringInterval is set to a value other than 0, then
you must supply a MonitoringRoleArn value.
String dBParameterGroupName
Constraints:
String dBParameterGroupFamily
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBSecurityGroupName
Constraints:
Example: mysecuritygroup
String dBSecurityGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBSnapshotIdentifier
Constraints:
Example: my-snapshot-id
String dBInstanceIdentifier
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, or hyphens. Must not be default.
Example: mySubnetgroup
String dBSubnetGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String subscriptionName
Constraints: The name must be less than 255 characters.
String snsTopicArn
String sourceType
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceIds
Constraints:
DBInstanceIdentifier must
be supplied.DBSecurityGroupName must be supplied.DBParameterGroupName must be supplied.DBSnapshotIdentifier must
be supplied.Boolean enabled
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String optionGroupName
Constraints:
Example:
myoptiongroup
String engineName
String majorEngineVersion
String optionGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Integer allocatedStorage
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Integer backupRetentionPeriod
String characterSetName
String databaseName
String dBClusterIdentifier
String dBClusterParameterGroup
String dBSubnetGroup
String status
String percentProgress
Date earliestRestorableTime
String endpoint
String engine
String engineVersion
Date latestRestorableTime
Integer port
String masterUsername
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBClusterOptionGroupMemberships
String preferredBackupWindow
BackupRetentionPeriod.String preferredMaintenanceWindow
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBClusterMembers
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroups
String hostedZoneId
Boolean storageEncrypted
String kmsKeyId
StorageEncrypted is true, the KMS key identifier for
the encrypted DB cluster.String dbClusterResourceId
StorageEncrypted is true, the region-unique, immutable
identifier for the encrypted DB cluster. This identifier is found in
AWS CloudTrail log entries whenever the KMS key for the DB cluster is
accessed.String dBInstanceIdentifier
Boolean isClusterWriter
true if the cluster member is the primary
instance for the DB cluster and false otherwise.String dBClusterParameterGroupStatus
String dBClusterParameterGroupName
String dBParameterGroupFamily
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
String dBClusterSnapshotIdentifier
String dBClusterIdentifier
Date snapshotCreateTime
String engine
Integer allocatedStorage
String status
Integer port
String vpcId
Date clusterCreateTime
String masterUsername
String engineVersion
String licenseModel
String snapshotType
Integer percentProgress
Boolean storageEncrypted
String kmsKeyId
StorageEncrypted is true, the KMS key identifier for
the encrypted DB cluster snapshot.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.com.amazonaws.internal.ListWithAutoConstructFlag<T> validUpgradeTarget
String dBInstanceIdentifier
String dBInstanceClass
String engine
String dBInstanceStatus
String masterUsername
String dBName
MySQL, MariaDB, SQL Server, PostgreSQL, Amazon Aurora
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
Endpoint endpoint
Integer allocatedStorage
Date instanceCreateTime
String preferredBackupWindow
BackupRetentionPeriod.Integer backupRetentionPeriod
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
DBSecurityGroup.Name and
DBSecurityGroup.Status subelements.com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBParameterGroups
String availabilityZone
DBSubnetGroup dBSubnetGroup
String preferredMaintenanceWindow
PendingModifiedValues pendingModifiedValues
Date latestRestorableTime
Boolean multiAZ
String engineVersion
Boolean autoMinorVersionUpgrade
String readReplicaSourceDBInstanceIdentifier
com.amazonaws.internal.ListWithAutoConstructFlag<T> readReplicaDBInstanceIdentifiers
String licenseModel
Integer iops
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupMemberships
String characterSetName
String secondaryAvailabilityZone
Boolean publiclyAccessible
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
com.amazonaws.internal.ListWithAutoConstructFlag<T> statusInfos
String storageType
String tdeCredentialArn
Integer dbInstancePort
String dBClusterIdentifier
Boolean storageEncrypted
String kmsKeyId
StorageEncrypted is true, the KMS key identifier for
the encrypted DB instance.String dbiResourceId
StorageEncrypted is true, the region-unique, immutable
identifier for the encrypted DB instance. This identifier is found in
AWS CloudTrail log entries whenever the KMS key for the DB instance is
accessed.String cACertificateIdentifier
Boolean copyTagsToSnapshot
Integer monitoringInterval
String enhancedMonitoringResourceArn
String monitoringRoleArn
String statusType
Boolean normal
String status
String message
String dBParameterGroupName
String dBParameterGroupFamily
String description
String ownerId
String dBSecurityGroupName
String dBSecurityGroupDescription
String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> eC2SecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> iPRanges
String dBSnapshotIdentifier
String dBInstanceIdentifier
Date snapshotCreateTime
String engine
Integer allocatedStorage
String status
Integer port
String availabilityZone
String vpcId
Date instanceCreateTime
String masterUsername
String engineVersion
String licenseModel
String snapshotType
Integer iops
String optionGroupName
Integer percentProgress
String sourceRegion
String sourceDBSnapshotIdentifier
String storageType
String tdeCredentialArn
Boolean encrypted
String kmsKeyId
Encrypted is true, the KMS key identifier for the
encrypted DB snapshot.String attributeName
An attribute name of
restore applies to the list of AWS accounts that have
permission to copy or restore the manual DB snapshot.
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeValues
If the
AttributeName field is restore, then this
field returns a list of AWS account ids that are authorized to copy or
restore the manual DB snapshot. If a value of all is in
the list, then the manual DB snapshot is public and available for any
AWS account to copy or restore.
String dBSnapshotIdentifier
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSnapshotAttributes
String dBSubnetGroupName
String dBSubnetGroupDescription
String vpcId
String subnetGroupStatus
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
String dBClusterParameterGroupName
Constraints:
String dBClusterIdentifier
Constraints:
Boolean skipFinalSnapshot
true is specified, no DB
cluster snapshot is created. If false is specified, a DB
cluster snapshot is created before the DB cluster is deleted.
FinalDBSnapshotIdentifier
parameter if SkipFinalSnapshot is
false.Default: false
String finalDBSnapshotIdentifier
SkipFinalSnapshot is set to
false. SkipFinalShapshot parameter to true results in an
error. Constraints:
String dBClusterSnapshotIdentifier
Constraints:
Must be the name of an existing DB cluster snapshot in the
available state.
String dBInstanceIdentifier
Constraints:
Boolean skipFinalSnapshot
true is specified, no DBSnapshot
is created. If false is specified, a DB snapshot is
created before the DB instance is deleted. Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true".
Specify true when deleting a Read Replica. false.
Default:
false
String finalDBSnapshotIdentifier
false. Constraints:
String dBParameterGroupName
Constraints:
String dBSecurityGroupName
Constraints:
String dBSnapshotIdentifier
Constraints: Must be the name of an
existing DB snapshot in the available state.
String dBSubnetGroupName
Constraints:
String subscriptionName
String optionGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> accountQuotas
String certificateIdentifier
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> certificates
String marker
MaxRecords .String dBClusterParameterGroupName
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
DescribeDBClusterParameterGroups request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.String marker
DescribeDBClusterParameterGroups request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBClusterParameterGroups
String dBClusterParameterGroupName
Constraints:
String source
engine,
service, or customer.com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
DescribeDBClusterParameters request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
String marker
MaxRecords .String dBClusterIdentifier
DBClusterSnapshotIdentifier parameter. This parameter is
not case-sensitive. Constraints:
String dBClusterSnapshotIdentifier
DBClusterIdentifier parameter. This value is stored as a
lowercase string. Constraints:
SnapshotType parameter must also be specified.String snapshotType
automated or manual. If this parameter is
not specified, the returned results will include all snapshot types.com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
DescribeDBClusterSnapshots request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBClusterSnapshots
String dBClusterIdentifier
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
MaxRecords.String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBClusters
String engine
String engineVersion
Example: 5.1.49
String dBParameterGroupFamily
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value is available, a pagination token
called a marker is included in the response so that the following
results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
MaxRecords.Boolean defaultOnly
Boolean listSupportedCharacterSets
String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBEngineVersions
DBEngineVersion elements.String dBInstanceIdentifier
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
DescribeDBInstances request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.String marker
MaxRecords .com.amazonaws.internal.ListWithAutoConstructFlag<T> dBInstances
String dBInstanceIdentifier
Constraints:
String filenameContains
Long fileLastWritten
Long fileSize
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> describeDBLogFiles
String marker
String dBParameterGroupName
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
DescribeDBParameterGroups request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBParameterGroups
String dBParameterGroupName
Constraints:
String source
Default: All parameter types returned
Valid Values: user | system | engine-default
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
DescribeDBParameters request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
String marker
MaxRecords.String dBSecurityGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
DescribeDBSecurityGroups request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
String dBSnapshotIdentifier
String dBInstanceIdentifier
DBSnapshotIdentifier. This parameter is not
case-sensitive. Constraints:
String dBSnapshotIdentifier
DBInstanceIdentifier. This
value is stored as a lowercase string. Constraints:
SnapshotType parameter must also be specified.String snapshotType
automated - Return all DB
snapshots that have been automatically taken by Amazon RDS for my AWS
account.manual - Return all DB snapshots that
have been taken by my AWS account.shared -
Return all manual DB snapshots that have been shared to my AWS
account.public - Return all DB snapshots that
have been marked as public.If you do not specify a
SnapshotType, then both automated and manual snapshots
are returned. You can include shared snapshots with these results by
setting the IncludeShared parameter to true.
You can include public snapshots with these results by setting the
IncludePublic parameter to true.
The
IncludeShared and IncludePublic parameters
do not apply for SnapshotType values of
manual or automated. The
IncludePublic parameter does not apply when
SnapshotType is set to shared. the
IncludeShared parameter does not apply when
SnapshotType is set to public.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
DescribeDBSnapshots request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.Boolean includeShared
An AWS account is given permission to restore a manual DB snapshot from another AWS account by the ModifyDBSnapshotAttribute API.
Boolean includePublic
An manual DB snapshot is shared as public by the ModifyDBSnapshotAttribute API.
String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSnapshots
String dBSubnetGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
MaxRecords.String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSubnetGroups
String dBParameterGroupFamily
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
DescribeEngineDefaultClusterParameters request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.String dBParameterGroupFamily
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
DescribeEngineDefaultParameters request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.String sourceType
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategoriesMapList
String sourceIdentifier
Constraints:
DBInstance, then a DBInstanceIdentifier must
be supplied.DBSecurityGroup, a DBSecurityGroupName must
be supplied.DBParameterGroup, a DBParameterGroupName
must be supplied.DBSnapshot, a DBSnapshotIdentifier must be
supplied.String sourceType
Constraints:
Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot
Date startTime
Example: 2009-07-08T18:00Z
Date endTime
Example: 2009-07-08T18:00Z
Integer duration
Default: 60
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
MaxRecords.String marker
MaxRecords .com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String subscriptionName
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
MaxRecords .String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> eventSubscriptionsList
String engineName
String majorEngineVersion
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupOptions
String marker
MaxRecords.String optionGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
String marker
MaxRecords.Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String engineName
String majorEngineVersion
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupsList
String marker
MaxRecords.String engine
String engineVersion
String dBInstanceClass
String licenseModel
Boolean vpc
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
MaxRecords .com.amazonaws.internal.ListWithAutoConstructFlag<T> orderableDBInstanceOptions
String marker
MaxRecords .String resourceIdentifier
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Supported filters:
db-instance-id - Accepts DB instance identifiers and DB
instance Amazon Resource Names (ARNs). The results list will only
include pending maintenance actions for the DB instances identified by
these ARNs.String marker
DescribePendingMaintenanceActions request. If this
parameter is specified, the response includes only records beyond the
marker, up to a number of records specified by
MaxRecords.Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
com.amazonaws.internal.ListWithAutoConstructFlag<T> pendingMaintenanceActions
String marker
DescribePendingMaintenanceActions request. If this
parameter is specified, the response includes only records beyond the
marker, up to a number of records specified by
MaxRecords.String reservedDBInstancesOfferingId
Example:
438012d3-4052-4cc7-b2e3-8d3372e0e706
String dBInstanceClass
String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
String productDescription
String offeringType
Valid
Values: "Partial Upfront" | "All Upfront" | "No Upfront"
Boolean multiAZ
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value is available, a pagination token
called a marker is included in the response so that the following
results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
MaxRecords.String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedDBInstancesOfferings
String reservedDBInstanceId
String reservedDBInstancesOfferingId
String dBInstanceClass
String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
String productDescription
String offeringType
Valid
Values: "Partial Upfront" | "All Upfront" | "No Upfront"
Boolean multiAZ
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value is available, a pagination token
called a marker is included in the response so that the following
results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
String marker
MaxRecords.String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedDBInstances
String dBInstanceIdentifier
Constraints:
String logFileName
String marker
Integer numberOfLines
If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.
If neither Marker or NumberOfLines are specified, the entire log file is returned.
If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned.
If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.
You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
String logFileData
String marker
Boolean additionalDataPending
String status
String eC2SecurityGroupName
String eC2SecurityGroupId
String eC2SecurityGroupOwnerId
EC2SecurityGroupName field.String dBParameterGroupFamily
String marker
MaxRecords .com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
String sourceIdentifier
String sourceType
Constraints:
Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot
String message
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
Date date
String sourceType
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
String customerAwsId
String custSubscriptionId
String snsTopicArn
String status
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
String subscriptionCreationTime
String sourceType
com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceIdsList
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategoriesList
Boolean enabled
String dBClusterIdentifier
Constraints:
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
String resourceName
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
String dBClusterParameterGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
String dBClusterParameterGroupName
Constraints:
String dBClusterIdentifier
Constraints:
String newDBClusterIdentifier
Constraints:
Example: my-cluster2
Boolean applyImmediately
PreferredMaintenanceWindow
setting for the DB cluster. If this parameter is set to
false, changes to the DB cluster are applied during the
next maintenance window.
Default: false
Integer backupRetentionPeriod
Default: 1
Constraints:
String dBClusterParameterGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Integer port
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
String masterUserPassword
Constraints: Must contain from 8 to 41 characters.
String optionGroupName
ApplyImmediately parameter is set to true
for this request. If the parameter change results in an option group
that enables OEM, this change can cause a brief (sub-second) period
during which new connections are rejected but existing connections are
not interrupted. Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.
String preferredBackupWindow
BackupRetentionPeriod parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
hh24:mi-hh24:mi.String preferredMaintenanceWindow
Format:
ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
String dBInstanceIdentifier
Constraints:
Integer allocatedStorage
ApplyImmediately is set to
true for this request. MySQL
Default: Uses existing setting
Valid Values: 5-6144
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
MariaDB
Default: Uses existing setting
Valid Values: 5-6144
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
PostgreSQL
Default: Uses existing setting
Valid Values: 5-6144
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
Oracle
Default: Uses existing setting
Valid Values: 10-6144
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
SQL Server
Cannot be modified.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.
String dBInstanceClass
Passing
a value for this setting causes an outage during the change and is
applied during the next maintenance window, unless
ApplyImmediately is specified as true for
this request.
Default: Uses existing setting
Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large |
db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge |
db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge |
db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge |
db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge |
db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small |
db.t2.medium | db.t2.large
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Constraints:
Boolean applyImmediately
PreferredMaintenanceWindow setting for
the DB instance. If this parameter is set to false,
changes to the DB instance are applied during the next maintenance
window. Some parameter changes can cause an outage and will be applied
on the next call to RebootDBInstance, or the next failure
reboot. Review the table of parameters in Modifying
a DB Instance and Using the Apply Immediately Parameter to see the
impact that setting ApplyImmediately to true
or false has for each modified parameter and to determine
when the changes will be applied.
Default: false
String masterUserPassword
Changing this parameter
does not result in an outage and the change is asynchronously applied
as soon as possible. Between the time of the request and the
completion of the request, the MasterUserPassword element
exists in the PendingModifiedValues element of the
operation response.
Default: Uses existing setting
Constraints:
Must be 8 to 41 alphanumeric characters (MySQL, MariaDB, and Amazon
Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128
alphanumeric characters (SQL Server).
String dBParameterGroupName
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
Integer backupRetentionPeriod
Changing this parameter can result in
an outage if you change from 0 to a non-zero value or from a non-zero
value to 0. These changes are applied during the next maintenance
window unless the ApplyImmediately parameter is set to
true for this request. If you change the parameter from
one non-zero value to another non-zero value, the change is
asynchronously applied as soon as possible.
Default: Uses existing setting
Constraints:
String preferredBackupWindow
BackupRetentionPeriod parameter. Changing this parameter
does not result in an outage and the change is asynchronously applied
as soon as possible. Constraints:
String preferredMaintenanceWindow
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
Boolean multiAZ
ApplyImmediately parameter is set to true
for this request. Constraints: Cannot be specified if the DB instance is a Read Replica. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.
String engineVersion
ApplyImmediately
parameter is set to true for this request. For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
For a list of valid engine versions, see CreateDBInstance.
Boolean allowMajorVersionUpgrade
Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
Boolean autoMinorVersionUpgrade
true during the
maintenance window, and a newer minor version is available, and RDS
has enabled auto patching for that engine version.Integer iops
ApplyImmediately parameter is set to true
for this request. Default: Uses existing setting
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
Type: Integer
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.
String optionGroupName
ApplyImmediately parameter
is set to true for this request. If the parameter change
results in an option group that enables OEM, this change can cause a
brief (sub-second) period during which new connections are rejected
but existing connections are not interrupted. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
String newDBInstanceIdentifier
Apply
Immediately to true, or will occur during the next maintenance
window if Apply Immediately to false. This value is
stored as a lowercase string. Constraints:
String storageType
Valid values: standard | gp2 | io1
If you specify
io1, you must also include a value for the
Iops parameter.
Default: io1 if the
Iops parameter is specified; otherwise
standard
String tdeCredentialArn
String tdeCredentialPassword
String cACertificateIdentifier
Boolean copyTagsToSnapshot
Integer monitoringInterval
If
MonitoringRoleArn is specified, then you must also set
MonitoringInterval to a value other than 0.
Valid
Values: 0, 1, 5, 10, 15, 30, 60
Integer dBPortNumber
The
value of the DBPortNumber parameter must not match any of
the port values specified for options in the option group for the DB
instance.
Your database will restart when you change the
DBPortNumber value regardless of the value of the
ApplyImmediately parameter.
MySQL
Default:
3306
Valid Values: 1150-65535
MariaDB
Default: 3306
Valid Values:
1150-65535
PostgreSQL
Default:
5432
Valid Values: 1150-65535
Oracle
Default: 1521
Valid Values:
1150-65535
SQL Server
Default:
1433
Valid Values: 1150-65535 except for
1434, 3389, 47001,
49152, and 49152 through 49156.
Amazon Aurora
Default: 3306
Valid
Values: 1150-65535
Boolean publiclyAccessible
PubliclyAccessible only applies to
DB instances in a VPC. The DB instance must be part of a public subnet
and PubliclyAccessible must be true in order for it to be
publicly accessible.
Changes to the PubliclyAccessible
parameter are applied immediately regardless of the value of the
ApplyImmediately parameter.
Default: false
String monitoringRoleArn
arn:aws:iam:123456789012:role/emaccess. For information
on creating a monitoring role, go to To
create an IAM role for Amazon RDS Enhanced Monitoring. If
MonitoringInterval is set to a value other than 0, then
you must supply a MonitoringRoleArn value.
String dBParameterGroupName
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
Valid Values (for
the application method): immediate | pending-reboot
String dBParameterGroupName
String dBSnapshotIdentifier
String attributeName
To manage
authorization for other AWS accounts to copy or restore a manual DB
snapshot, this value is restore.
com.amazonaws.internal.ListWithAutoConstructFlag<T> valuesToAdd
AttributeName. To authorize other AWS Accounts to copy
or restore a manual snapshot, this is one or more AWS account
identifiers, or all to make the manual DB snapshot
restorable by any AWS account. Do not add the all value
for any manual DB snapshots that contain private information that you
do not want to be available to all AWS accounts.
com.amazonaws.internal.ListWithAutoConstructFlag<T> valuesToRemove
AttributeName. To remove authorization
for other AWS Accounts to copy or restore a manual snapshot, this is
one or more AWS account identifiers, or all to remove
authorization for any AWS account to copy or restore the DB snapshot.
If you specify all, AWS accounts that have their account
identifier explicitly added to the restore attribute can
still copy or restore the manual DB snapshot.
String dBSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".
Example:
mySubnetgroup
String dBSubnetGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
String subscriptionName
String snsTopicArn
String sourceType
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
Boolean enabled
String optionGroupName
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsToInclude
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsToRemove
Boolean applyImmediately
String optionName
String optionDescription
Boolean persistent
Boolean permanent
Integer port
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroupMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupMemberships
String optionName
Integer port
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroupMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
String optionGroupName
String optionGroupDescription
String engineName
String majorEngineVersion
com.amazonaws.internal.ListWithAutoConstructFlag<T> options
Boolean allowsVpcAndNonVpcInstanceMemberships
true indicates the option
group can be applied to both VPC and non-VPC instances.String vpcId
false,
this field is blank. If AllowsVpcAndNonVpcInstanceMemberships
is true and this field is blank, then this option group
can be applied to both VPC and non-VPC instances. If this field
contains a value, then this option group can only be applied to
instances that are in the VPC indicated by this field.String name
String description
String engineName
String majorEngineVersion
String minimumRequiredMinorEngineVersion
Boolean portRequired
Integer defaultPort
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsDependedOn
Boolean persistent
Boolean permanent
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupOptionSettings
String settingName
String settingDescription
String defaultValue
String applyType
String allowedValues
Boolean isModifiable
String name
String value
String defaultValue
String description
String applyType
String dataType
String allowedValues
Boolean isModifiable
Boolean isCollection
String engine
String engineVersion
String dBInstanceClass
String licenseModel
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Boolean multiAZCapable
Boolean readReplicaCapable
Boolean vpc
Boolean supportsStorageEncryption
String storageType
Boolean supportsIops
Boolean supportsEnhancedMonitoring
String parameterName
String parameterValue
String description
String source
String applyType
String dataType
String allowedValues
Boolean isModifiable
true) or not (false) the
parameter can be modified. Some parameters have security or
operational implications that prevent them from being changed.String minimumEngineVersion
String applyMethod
Constraints:
Allowed Values: immediate, pending-reboot
String action
Date autoAppliedAfterDate
next-maintenance opt-in requests are ignored.Date forcedApplyDate
immediate opt-in requests are ignored.String optInStatus
Date currentApplyDate
AutoAppliedAfterDate, and the
ForcedApplyDate. This value is blank if an opt-in request
has not been received and nothing has been specified as
AutoAppliedAfterDate or ForcedApplyDate.String description
String dBInstanceClass
DBInstanceClass for the DB instance that
will be applied or is in progress.Integer allocatedStorage
AllocatedStorage size for the DB
instance that will be applied or is in progress.String masterUserPassword
Integer port
Integer backupRetentionPeriod
Boolean multiAZ
String engineVersion
Integer iops
String dBInstanceIdentifier
DBInstanceIdentifier for the DB instance
that will be applied or is in progress.String storageType
String cACertificateIdentifier
String dBInstanceIdentifier
Constraints:
Example: mydbinstance
Integer backupRetentionPeriod
Default: 1
Constraints:
String preferredBackupWindow
BackupRetentionPeriod parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
hh24:mi-hh24:mi.String reservedDBInstancesOfferingId
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
String reservedDBInstanceId
Example: myreservationID
Integer dBInstanceCount
Default: 1
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBInstanceIdentifier
Constraints:
Boolean forceFailover
true, the reboot will be conducted through a MultiAZ
failover. Constraint: You cannot specify true if the
instance is not configured for MultiAZ.
String subscriptionName
String sourceIdentifier
String resourceName
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
String reservedDBInstanceId
String reservedDBInstancesOfferingId
String dBInstanceClass
Date startTime
Integer duration
Double fixedPrice
Double usagePrice
String currencyCode
Integer dBInstanceCount
String productDescription
String offeringType
Boolean multiAZ
String state
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String reservedDBInstancesOfferingId
String dBInstanceClass
Integer duration
Double fixedPrice
Double usagePrice
String currencyCode
String productDescription
String offeringType
Boolean multiAZ
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String dBClusterParameterGroupName
Boolean resetAllParameters
true to reset all parameters in
the DB cluster parameter group to their default values, and
false otherwise. You cannot use this parameter if there
is a list of parameter names specified for the Parameters
parameter.com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
ResetAllParameters parameter is set to true.String dBClusterParameterGroupName
Constraints:
String dBParameterGroupName
Constraints:
Boolean resetAllParameters
true) or not (false) to
reset all parameters in the DB parameter group to default values.
Default: true
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
MySQL
Valid Values (for Apply method): immediate |
pending-reboot
You can use the immediate value with
dynamic parameters only. You can use the pending-reboot
value for both dynamic and static parameters, and changes are applied
when DB instance reboots.
MariaDB
Valid Values (for
Apply method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You
can use the pending-reboot value for both dynamic and
static parameters, and changes are applied when DB instance reboots.
Oracle
Valid Values (for Apply method):
pending-reboot
String dBParameterGroupName
String resourceIdentifier
com.amazonaws.internal.ListWithAutoConstructFlag<T> pendingMaintenanceActionDetails
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
String dBClusterIdentifier
Constraints:
Example:
my-snapshot-id
String snapshotIdentifier
Constraints:
String engine
Default: The same as source
Constraint: Must be compatible with the engine of the source
String engineVersion
Integer port
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
String dBSubnetGroupName
String databaseName
String optionGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String kmsKeyId
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If
you do not specify a value for the KmsKeyId parameter,
then the following will occur:
If SnapshotIdentifier refers to
a DB cluster snapshot that is not encrypted, and you specify a value
for the KmsKeyId parameter, then the restore request is
rejected.
String dBClusterIdentifier
Constraints:
String sourceDBClusterIdentifier
Constraints:
Date restoreToTime
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
UseLatestRestorableTime parameter is trueExample: 2015-03-07T23:45:00Z
Boolean useLatestRestorableTime
true to restore the DB cluster to
the latest restorable backup time, and false otherwise.
Default: false
Constraints: Cannot be specified if
RestoreToTime parameter is provided.
Integer port
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
String dBSubnetGroupName
String optionGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String kmsKeyId
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
You can restore to a
new DB cluster and encrypt the new DB cluster with a KMS key that is
different than the KMS key used to encrypt the source DB cluster. The
new DB cluster will be encrypted with the KMS key identified by the
KmsKeyId parameter.
If you do not specify a value for
the KmsKeyId parameter, then the following will occur:
If
DBClusterIdentifier refers to a DB cluster that is note
encrypted, then the restore request is rejected.
String dBInstanceIdentifier
Constraints:
Example:
my-snapshot-id
String dBSnapshotIdentifier
Constraints:
If you
are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier must be the ARN of the shared DB
snapshot.
String dBInstanceClass
Valid Values: db.t1.micro | db.m1.small | db.m1.medium |
db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge |
db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge |
db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge |
db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge |
db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small |
db.t2.medium | db.t2.large
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 or MariaDB engines.
String engine
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values: MySQL | mariadb |
oracle-se1 | oracle-se |
oracle-ee | sqlserver-ee |
sqlserver-se | sqlserver-ex |
sqlserver-web | postgres |
aurora
Integer iops
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
String optionGroupName
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String storageType
Valid values: standard | gp2 | io1
If you specify
io1, you must also include a value for the
Iops parameter.
Default: io1 if the
Iops parameter is specified; otherwise
standard
String tdeCredentialArn
String tdeCredentialPassword
Boolean copyTagsToSnapshot
String sourceDBInstanceIdentifier
Constraints:
String targetDBInstanceIdentifier
Constraints:
Date restoreTime
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Example: 2009-09-07T23:45:00Z
Boolean useLatestRestorableTime
true) or not (false) the
DB instance is restored from the latest backup time. Default:
false
Constraints: Cannot be specified if RestoreTime parameter is provided.
String dBInstanceClass
Valid Values: db.t1.micro | db.m1.small | db.m1.medium |
db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge |
db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge |
db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge |
db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge |
db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small |
db.t2.medium | db.t2.large
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 or MariaDB engines.
String engine
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values: MySQL | mariadb |
oracle-se1 | oracle-se |
oracle-ee | sqlserver-ee |
sqlserver-se | sqlserver-ex |
sqlserver-web | postgres|
aurora
Integer iops
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
String optionGroupName
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
Boolean copyTagsToSnapshot
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String storageType
Valid values: standard | gp2 | io1
If you specify
io1, you must also include a value for the
Iops parameter.
Default: io1 if the
Iops parameter is specified; otherwise
standard
String tdeCredentialArn
String tdeCredentialPassword
String dBSecurityGroupName
String cIDRIP
CIDRIP is specified, EC2SecurityGroupName,
EC2SecurityGroupId and
EC2SecurityGroupOwnerId cannot be provided.String eC2SecurityGroupName
EC2SecurityGroupId must be provided.
Otherwise, EC2SecurityGroupOwnerId and either
EC2SecurityGroupName or EC2SecurityGroupId
must be provided.String eC2SecurityGroupId
EC2SecurityGroupId must be provided.
Otherwise, EC2SecurityGroupOwnerId and either
EC2SecurityGroupName or EC2SecurityGroupId
must be provided.String eC2SecurityGroupOwnerId
EC2SecurityGroupName parameter. The AWS
Access Key ID is not an acceptable value. For VPC DB security groups,
EC2SecurityGroupId must be provided. Otherwise,
EC2SecurityGroupOwnerId and either EC2SecurityGroupName
or EC2SecurityGroupId must be provided.String subnetIdentifier
AvailabilityZone subnetAvailabilityZone
This data type is used as an element in the following data type:
String subnetStatus
String key
String value
String engine
String engineVersion
String description
Boolean autoUpgrade
Boolean isMajorVersionUpgrade
String accountId
String clusterSecurityGroupName
String cIDRIP
String eC2SecurityGroupName
String eC2SecurityGroupOwnerId
Example: 111122223333
String snapshotIdentifier
String snapshotClusterIdentifier
String accountWithRestoreAccess
String name
String clusterIdentifier
String nodeType
String clusterStatus
available, creating, deleting,
rebooting, renaming, and
resizing.String modifyStatus
String masterUsername
String dBName
Endpoint endpoint
Date clusterCreateTime
Integer automatedSnapshotRetentionPeriod
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterSecurityGroups
ClusterSecurityGroup.Name and
ClusterSecurityGroup.Status subelements. Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterParameterGroups
String clusterSubnetGroupName
String vpcId
String availabilityZone
String preferredMaintenanceWindow
PendingModifiedValues pendingModifiedValues
String clusterVersion
Boolean allowVersionUpgrade
true, major version upgrades will be applied
automatically to the cluster during the maintenance window.Integer numberOfNodes
Boolean publiclyAccessible
true, the cluster can be accessed from a public
network.Boolean encrypted
true, data in the cluster is encrypted at rest.RestoreStatus restoreStatus
HsmStatus hsmStatus
Values: active, applying
ClusterSnapshotCopyStatus clusterSnapshotCopyStatus
String clusterPublicKey
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterNodes
ElasticIpStatus elasticIpStatus
String clusterRevisionNumber
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String kmsKeyId
String parameterGroupName
String parameterGroupFamily
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String parameterGroupName
String parameterApplyStatus
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterParameterStatusList
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
String parameterName
String parameterApplyStatus
The following are possible statuses and descriptions.
in-sync: The parameter value is
in sync with the database.pending-reboot: The
parameter value will be applied after the cluster reboots.applying: The parameter value is being applied to the
database.invalid-parameter: Cannot apply the
parameter value because it has an invalid value or syntax.apply-deferred: The parameter contains static
property changes. The changes are deferred until the cluster
reboots.apply-error: Cannot connect to the
cluster. The parameter change will be applied after the cluster
reboots.unknown-error: Cannot apply the
parameter change right now. The change will be applied after the
cluster reboots.String parameterApplyErrorDescription
String clusterSecurityGroupName
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> eC2SecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> iPRanges
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String destinationRegion
Long retentionPeriod
String snapshotCopyGrantName
String clusterSubnetGroupName
String description
String vpcId
String subnetGroupStatus
Complete, Incomplete and
Invalid.com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String sourceSnapshotIdentifier
Constraints:
available.String sourceSnapshotClusterIdentifier
Constraints:
String targetSnapshotIdentifier
Constraints:
String parameterGroupName
Constraints:
String parameterGroupFamily
To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift-1.0".
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBName
To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.
Default: dev
Constraints:
String clusterIdentifier
Constraints:
Example: myexamplecluster
String clusterType
single-node, the NumberOfNodes parameter is
not required.multi-node, the
NumberOfNodes parameter is required. Valid
Values: multi-node | single-node
Default:
multi-node
String nodeType
Valid Values: ds1.xlarge |
ds1.8xlarge | ds2.xlarge |
ds2.8xlarge | dc1.large |
dc1.8xlarge.
String masterUsername
Constraints:
String masterUserPassword
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterSecurityGroups
Default: The default cluster security group for Amazon Redshift.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Default: The default VPC security group is associated with the cluster.
String clusterSubnetGroupName
If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
String availabilityZone
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example:
us-east-1d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
String preferredMaintenanceWindow
Format:
ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
String clusterParameterGroupName
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
Integer automatedSnapshotRetentionPeriod
Default: 1
Constraints: Must be a value from 0 to 35.
Integer port
The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.
Default:
5439
Valid Values: 1150-65535
String clusterVersion
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
Boolean allowVersionUpgrade
true, major version upgrades can be applied during the
maintenance window to the Amazon Redshift engine that is running on
the cluster. When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.
Default: true
Integer numberOfNodes
multi-node. For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.
Default:
1
Constraints: Value must be at least 1 and no more than 100.
Boolean publiclyAccessible
true, the cluster can be accessed from a public
network.Boolean encrypted
true, the data in the cluster is encrypted at rest.
Default: false
String hsmClientCertificateIdentifier
String hsmConfigurationIdentifier
String elasticIp
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String kmsKeyId
String clusterSecurityGroupName
Constraints:
Example:
examplesecuritygroup
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String snapshotIdentifier
Constraints:
Example:
my-snapshot-id
String clusterIdentifier
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String clusterSubnetGroupName
Constraints:
Example:
examplesubnetgroup
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String subscriptionName
Constraints:
String snsTopicArn
String sourceType
Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.
com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceIds
Example: my-cluster-1, my-cluster-2
Example: my-snapshot-20131010
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
Values: Configuration, Management, Monitoring, Security
String severity
Values: ERROR, INFO
Boolean enabled
true to activate the
subscription, set to false to create the subscription but
not active it.com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String hsmClientCertificateIdentifier
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String hsmConfigurationIdentifier
String description
String hsmIpAddress
String hsmPartitionName
String hsmPartitionPassword
String hsmServerPublicCertificate
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String snapshotCopyGrantName
Constraints:
String kmsKeyId
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String resourceName
arn:aws:redshift:us-east-1:123456789:cluster:t1.com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Key and the
corresponding value is passed in with the parameter
Value. The Key and Value
parameters are separated by a comma (,). Separate multiple tags with a
space. For example, --tags "Key"="owner","Value"="admin"
"Key"="environment","Value"="test"
"Key"="version","Value"="1.0".String parameterGroupFamily
String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
String parameterGroupName
Constraints:
String clusterIdentifier
Constraints:
Boolean skipFinalClusterSnapshot
true, a final
cluster snapshot is not created. If false, a final
cluster snapshot is created before the cluster is deleted. false.Default: false
String finalClusterSnapshotIdentifier
false.
Constraints:
String clusterSecurityGroupName
String snapshotIdentifier
Constraints: Must be the name of an existing snapshot that is in
the available state.
String snapshotClusterIdentifier
Constraints: Must be the name of valid cluster.
String clusterSubnetGroupName
String subscriptionName
String hsmClientCertificateIdentifier
String hsmConfigurationIdentifier
String snapshotCopyGrantName
String resourceName
arn:aws:redshift:us-east-1:123456789:cluster:t1.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
String parameterGroupName
Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner and environment. If
you specify both of these tag keys in the request, Amazon Redshift
returns a response with the parameter groups that have either or both
of these tag keys associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin and
test. If you specify both of these tag values in the
request, Amazon Redshift returns a response with the parameter groups
that have either or both of these tag values associated with them.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterGroups
String parameterGroupName
String source
user to show
parameters that are different form the default. Similarly, specify
engine-default to show parameters that are the same as
the default parameter group. Default: All parameter types returned.
Valid Values: user | engine-default
Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.String clusterSecurityGroupName
Example:
securitygroup1
Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request. Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner and environment. If
you specify both of these tag keys in the request, Amazon Redshift
returns a response with the security groups that have either or both
of these tag keys associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin and
test. If you specify both of these tag values in the
request, Amazon Redshift returns a response with the security groups
that have either or both of these tag values associated with them.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterSecurityGroups
String clusterIdentifier
String snapshotIdentifier
String snapshotType
Valid Values:
automated | manual
Date startTime
Example: 2012-07-16T18:00:00Z
Date endTime
Example: 2012-07-16T18:00:00Z
Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.String ownerAccount
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner and environment. If you specify
both of these tag keys in the request, Amazon Redshift returns a
response with the snapshots that have either or both of these tag keys
associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin and test. If you
specify both of these tag values in the request, Amazon Redshift
returns a response with the snapshots that have either or both of
these tag values associated with them.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshots
String clusterIdentifier
The default is that all clusters defined for an account are returned.
Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords, AWS
returns a value in the Marker field of the response. You
can retrieve the next set of response records by providing the
returned marker value in the Marker parameter and
retrying the request. Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner and environment. If you specify both
of these tag keys in the request, Amazon Redshift returns a response
with the clusters that have either or both of these tag keys
associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin and test. If you specify
both of these tag values in the request, Amazon Redshift returns a
response with the clusters that have either or both of these tag
values associated with them.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> clusters
String clusterSubnetGroupName
Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner and environment. If you specify
both of these tag keys in the request, Amazon Redshift returns a
response with the subnet groups that have either or both of these tag
keys associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin and test. If
you specify both of these tag values in the request, Amazon Redshift
returns a response with the subnet groups that have either or both of
these tag values associated with them.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterSubnetGroups
String clusterVersion
Example: 1.0
String clusterParameterGroupFamily
Constraints:
Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterVersions
Version elements.String parameterGroupFamily
Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.String sourceType
Valid values: cluster, snapshot, parameter group, and security group.
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategoriesMapList
String sourceIdentifier
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
cluster.cluster-security-group.cluster-parameter-group.cluster-snapshot.String sourceType
Constraints:
If SourceType is supplied, SourceIdentifier must also be provided.
cluster when SourceIdentifier is a
cluster identifier.cluster-security-group when SourceIdentifier is a
cluster security group name.cluster-parameter-group when SourceIdentifier is a
cluster parameter group name.cluster-snapshot when SourceIdentifier is a
cluster snapshot identifier.
Constraints:
Allowed Values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot
Date startTime
Example: 2009-07-08T18:00Z
Date endTime
Example: 2009-07-08T18:00Z
Integer duration
Default: 60
Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords, AWS
returns a value in the Marker field of the response. You
can retrieve the next set of response records by providing the
returned marker value in the Marker parameter and
retrying the request.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String subscriptionName
Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> eventSubscriptionsList
String hsmClientCertificateIdentifier
Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner and environment. If
you specify both of these tag keys in the request, Amazon Redshift
returns a response with the HSM client certificates that have either
or both of these tag keys associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin and
test. If you specify both of these tag values in the
request, Amazon Redshift returns a response with the HSM client
certificates that have either or both of these tag values associated
with them.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> hsmClientCertificates
String hsmConfigurationIdentifier
Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner and environment. If you
specify both of these tag keys in the request, Amazon Redshift returns
a response with the HSM configurations that have either or both of
these tag keys associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin and test. If
you specify both of these tag values in the request, Amazon Redshift
returns a response with the HSM configurations that have either or
both of these tag values associated with them.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> hsmConfigurations
String clusterIdentifier
Example: examplecluster
Boolean loggingEnabled
true if logging is on, false if logging is
off.String bucketName
String s3KeyPrefix
Date lastSuccessfulDeliveryTime
Date lastFailureTime
String lastFailureMessage
String clusterVersion
Default: All versions.
Constraints: Must be one of the version returned from DescribeClusterVersions.
String nodeType
Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> orderableClusterOptions
String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.String reservedNodeOfferingId
Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedNodeOfferings
String reservedNodeId
Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedNodes
String clusterIdentifier
By default, resize operations for all clusters defined for an AWS account are returned.
String targetNodeType
Integer targetNumberOfNodes
String targetClusterType
Valid
Values: multi-node | single-node
String status
Valid Values: NONE
| IN_PROGRESS | FAILED |
SUCCEEDED
com.amazonaws.internal.ListWithAutoConstructFlag<T> importTablesCompleted
Valid Values: List of table names.
com.amazonaws.internal.ListWithAutoConstructFlag<T> importTablesInProgress
Valid Values: List of table names.
com.amazonaws.internal.ListWithAutoConstructFlag<T> importTablesNotStarted
Valid Values: List of table names
Double avgResizeRateInMegaBytesPerSecond
Long totalResizeDataInMegaBytes
Long progressInMegaBytes
Long elapsedTimeInSeconds
Long estimatedTimeToCompletionInSeconds
String snapshotCopyGrantName
Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
DescribeSnapshotCopyGrant request exceed the value
specified in MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request. Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner and environment. If you specify both
of these tag keys in the request, Amazon Redshift returns a response
with all resources that have either or both of these tag keys
associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin and test. If you specify both of these
tag values in the request, Amazon Redshift returns a response with all
resources that have either or both of these tag values associated with
them.String marker
DescribeSnapshotCopyGrant request exceed the value
specified in MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request. Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotCopyGrants
String resourceName
arn:aws:redshift:us-east-1:123456789:cluster:t1.String resourceType
For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.
Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned
marker value.String marker
marker parameter and retrying the
command. If the marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner and environment. If you specify both
of these tag keys in the request, Amazon Redshift returns a response
with all resources that have either or both of these tag keys
associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin and test. If you specify both of these
tag values in the request, Amazon Redshift returns a response with all
resources that have either or both of these tag values associated with
them.com.amazonaws.internal.ListWithAutoConstructFlag<T> taggedResources
String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.String clusterIdentifier
Example: examplecluster
Boolean loggingEnabled
true if logging is on, false if logging is
off.String bucketName
String s3KeyPrefix
Date lastSuccessfulDeliveryTime
Date lastFailureTime
String lastFailureMessage
String clusterIdentifier
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
String status
String eC2SecurityGroupName
String eC2SecurityGroupOwnerId
EC2SecurityGroupName field.com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String clusterIdentifier
Example: examplecluster
String bucketName
Constraints:
String s3KeyPrefix
Constraints:
Boolean loggingEnabled
true if logging is on, false if logging is
off.String bucketName
String s3KeyPrefix
Date lastSuccessfulDeliveryTime
Date lastFailureTime
String lastFailureMessage
String clusterIdentifier
Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.
String destinationRegion
Constraints: Must be the name of a valid region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
Integer retentionPeriod
Default: 7.
Constraints: Must be at least 1 and no more than 35.
String snapshotCopyGrantName
String sourceIdentifier
String sourceType
Constraints:
Allowed Values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot
String message
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
Values: Configuration, Management, Monitoring, Security
String severity
Values: ERROR, INFO
Date date
String eventId
String sourceType
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String eventId
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
String eventDescription
String severity
Values: ERROR, INFO
String customerAwsId
String custSubscriptionId
String snsTopicArn
String status
Constraints:
Date subscriptionCreationTime
String sourceType
com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceIdsList
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategoriesList
Values: Configuration, Management, Monitoring, Security
String severity
Values: ERROR, INFO
Boolean enabled
true indicates the subscription is enabled.com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String hsmClientCertificateIdentifier
String hsmClientCertificatePublicKey
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String hsmConfigurationIdentifier
String description
String hsmIpAddress
String hsmPartitionName
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String hsmClientCertificateIdentifier
String hsmConfigurationIdentifier
String status
Values: active, applying
String status
String cIDRIP
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String parameterGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
String parameterGroupName
String parameterGroupStatus
String clusterIdentifier
Example:
examplecluster
String clusterType
When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.
Valid Values: multi-node | single-node
String nodeType
When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.
Valid Values: ds1.xlarge |
ds1.8xlarge | ds2.xlarge |
ds2.8xlarge | dc1.large |
dc1.8xlarge.
Integer numberOfNodes
When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.
Valid Values: Integer greater than
0.
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterSecurityGroups
Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
String masterUserPassword
MasterUserPassword element exists in the
PendingModifiedValues element of the operation response.
Default: Uses existing setting.
Constraints:
String clusterParameterGroupName
Default: Uses existing setting.
Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.
Integer automatedSnapshotRetentionPeriod
If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.
Default: Uses existing setting.
Constraints: Must be a value from 0 to 35.
String preferredMaintenanceWindow
This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.
Default: Uses existing setting.
Format:
ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes.
String clusterVersion
For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Example: 1.0
Boolean allowVersionUpgrade
true, major version upgrades will be applied
automatically to the cluster during the maintenance window.
Default: false
String hsmClientCertificateIdentifier
String hsmConfigurationIdentifier
String newClusterIdentifier
Constraints:
Example: examplecluster
String clusterSubnetGroupName
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
String subscriptionName
String snsTopicArn
String sourceType
Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.
com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceIds
Example: my-cluster-1, my-cluster-2
Example: my-snapshot-20131010
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
Values: Configuration, Management, Monitoring, Security
String severity
Values: ERROR, INFO
Boolean enabled
true indicates the subscription is enabledString clusterIdentifier
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
Integer retentionPeriod
If you decrease the retention period for automated snapshots that are copied to a destination region, Amazon Redshift will delete any existing automated snapshots that were copied to the destination region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35.
String clusterVersion
String clusterType
multi-node.String nodeType
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
String parameterName
String parameterValue
String description
String source
String dataType
String allowedValues
String applyType
static.
Constraints:
Allowed Values: static, dynamic
Boolean isModifiable
true, the parameter can be modified. Some parameters
have security or operational implications that prevent them from being
changed.String minimumEngineVersion
String masterUserPassword
String nodeType
Integer numberOfNodes
String clusterType
String clusterVersion
Integer automatedSnapshotRetentionPeriod
String clusterIdentifier
String clusterIdentifier
String reservedNodeId
String reservedNodeOfferingId
String nodeType
Date startTime
Integer duration
Double fixedPrice
Double usagePrice
String currencyCode
Integer nodeCount
String state
Possible Values:
String offeringType
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String reservedNodeOfferingId
String nodeType
Integer duration
Double fixedPrice
Double usagePrice
String currencyCode
String offeringType
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String parameterGroupName
Boolean resetAllParameters
true, all parameters in the specified parameter group
will be reset to their default values. Default: true
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
Constraints: A maximum of 20 parameters can be reset in a single request.
String parameterGroupName
String parameterGroupStatus
String clusterIdentifier
Constraints:
String snapshotIdentifier
Example:
my-snapshot-id
String snapshotClusterIdentifier
Integer port
Default: The same port as the original cluster.
Constraints: Must be between
1115 and 65535.
String availabilityZone
Default: A random, system-chosen Availability Zone.
Example:
us-east-1a
Boolean allowVersionUpgrade
true, major version upgrades can be applied during the
maintenance window to the Amazon Redshift engine that is running on
the cluster. Default: true
String clusterSubnetGroupName
A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.
Boolean publiclyAccessible
true, the cluster can be accessed from a public
network.String ownerAccount
String hsmClientCertificateIdentifier
String hsmConfigurationIdentifier
String elasticIp
String clusterParameterGroupName
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups.
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterSecurityGroups
Default: The default cluster security group for Amazon Redshift.
Cluster security groups only apply to clusters outside of VPCs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Default: The default VPC security group is associated with the cluster.
VPC security groups only apply to clusters in VPCs.
String preferredMaintenanceWindow
Format:
ddd:hh24:mi-ddd:hh24:mi
Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
Integer automatedSnapshotRetentionPeriod
Default: The value selected for the cluster from which the snapshot was taken.
Constraints: Must be a value from 0 to 35.
String kmsKeyId
String nodeType
Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds2.xlarge into ds1.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide
String status
Double currentRestoreRateInMegaBytesPerSecond
Long snapshotSizeInMegaBytes
Long progressInMegaBytes
Long elapsedTimeInSeconds
Long estimatedTimeToCompletionInSeconds
String clusterSecurityGroupName
String cIDRIP
CIDRIP is specified, EC2SecurityGroupName
and EC2SecurityGroupOwnerId cannot be provided.String eC2SecurityGroupName
EC2SecurityGroupName is specified,
EC2SecurityGroupOwnerId must also be provided and
CIDRIP cannot be provided.String eC2SecurityGroupOwnerId
EC2SecurityGroupName parameter. The AWS access key ID
is not an acceptable value. If EC2SecurityGroupOwnerId is
specified, EC2SecurityGroupName must also be provided.
and CIDRIP cannot be provided. Example:
111122223333
String snapshotIdentifier
String snapshotClusterIdentifier
String accountWithRestoreAccess
String clusterIdentifier
Constraints: Must be the name of valid cluster that has encryption enabled.
String snapshotIdentifier
String clusterIdentifier
Date snapshotCreateTime
String status
Integer port
String availabilityZone
Date clusterCreateTime
String masterUsername
String clusterVersion
String snapshotType
String nodeType
Integer numberOfNodes
String dBName
String vpcId
Boolean encrypted
true, the data in the snapshot is encrypted at rest.String kmsKeyId
Boolean encryptedWithHSM
true indicates that
the data is encrypted using HSM keys.com.amazonaws.internal.ListWithAutoConstructFlag<T> accountsWithRestoreAccess
null if no accounts are authorized.
Visible only to the snapshot owner.String ownerAccount
Double totalBackupSizeInMegaBytes
Double actualIncrementalBackupSizeInMegaBytes
Double backupProgressInMegaBytes
Double currentBackupRateInMegaBytesPerSecond
0 for a completed backup.Long estimatedSecondsToCompletion
0 for a completed backup.Long elapsedTimeInSeconds
String sourceRegion
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> restorableNodeTypes
String snapshotCopyGrantName
String kmsKeyId
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String subnetIdentifier
AvailabilityZone subnetAvailabilityZone
String subnetStatus
Tag tag
String resourceName
arn:aws:redshift:us-east-1:123456789:cluster:t1.String resourceType
For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.
String hostedZoneId
Alias resource record sets only: The value you use depends on where you want to route queries:
Z2FDTNDATAQYW2
.HostedZoneId and DNSName. If you get one
value from the console and the other value from the API or the CLI,
creating the resource record set will fail.For more information and an example, see Example: Creating Alias Resource Record Sets in the Amazon Route 53 API Reference.
String dNSName
Alias resource record sets only: The external DNS name associated with the AWS Resource. The value that you specify depends on where you want to route queries:
acme.example.com, your CloudFront distribution
must include acme.example.com as one of the alternate domain
names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront
Developer Guide.HostedZoneId and DNSName. If you get one
value from the console and the other value from the API or the CLI,
creating the resource record set will fail.s3-website-us-east-1.amazonaws.com. For more information
about valid values, see the table Amazon Simple Storage Service (S3) Website Endpoints in the
Amazon Web Services General Reference. For more information about
using Amazon S3 buckets for websites, see Hosting a Static Website on Amazon S3 in the Amazon Simple
Storage Service Developer Guide.For more information and an example, see Example: Creating Alias Resource Record Sets in the Amazon Route 53 API Reference.
Boolean evaluateTargetHealth
Alias resource record sets only: If you set the value of
EvaluateTargetHealth to true for the resource
record set or sets in an alias, weighted alias, latency alias, or
failover alias resource record set, and if you specify a value for
HealthCheckId for every resource record set that is
referenced by these alias resource record sets, the alias resource record
sets inherit the health of the referenced resource record sets.
In this configuration, when Amazon Route 53 receives a DNS query for an alias resource record set:
Note the following:
AliasTarget is a
resource record set or a group of resource record sets (for example, a
group of weighted resource record sets), but it is not another alias
resource record set, we recommend that you associate a health check with
all of the resource record sets in the alias target. For more
information, see What Happens When You Omit Health Checks? in the Amazon Route 53
Developer Guide.AliasTarget,
Elastic Load Balancing routes queries only to the healthy Amazon EC2
instances that are registered with the load balancer. If no Amazon EC2
instances are healthy or if the load balancer itself is unhealthy, and if
EvaluateTargetHealth is true for the
corresponding alias resource record set, Amazon Route 53 routes queries
to other resources.
We recommend that you set EvaluateTargetHealth to
true only when you have enough idle capacity to handle the
failure of one or more endpoints.
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
String hostedZoneId
The ID of the hosted zone you want to associate your VPC with.
Note that you cannot associate a VPC with a hosted zone that doesn't have an existing VPC association.
VPC vPC
The VPC that you want your hosted zone to be associated with.
String comment
Optional: Any comments you want to include about a
AssociateVPCWithHostedZoneRequest.
ChangeInfo changeInfo
A complex type that contains the ID, the status, and the date and time of
your AssociateVPCWithHostedZoneRequest.
String action
The action to perform:
CREATE: Creates a resource record set that has the
specified values.DELETE: Deletes a existing resource record set that has
the specified values for Name, Type,
SetIdentifier (for latency, weighted, geolocation, and
failover resource record sets), and TTL (except alias
resource record sets, for which the TTL is determined by the AWS resource
that you're routing DNS queries to).UPSERT: If a resource record set does not already exist,
Amazon Route 53 creates it. If a resource record set does exist, Amazon
Route 53 updates it with the values in the request. Amazon Route 53 can
update an existing resource record set only when all of the following
values match: Name, Type, and
SetIdentifier (for weighted, latency, geolocation, and
failover resource record sets).ResourceRecordSet resourceRecordSet
Information about the resource record set to create or delete.
String comment
Optional: Any comments you want to include about a change batch request.
com.amazonaws.internal.SdkInternalList<T> changes
A complex type that contains one Change element for each
resource record set that you want to create or delete.
String id
The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
Date submittedAt
The date and time the change was submitted, in the format
YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard
(for example, 2009-11-19T19:37:58Z). The Z after the time
indicates that the time is listed in Coordinated Universal Time (UTC).
String status
The current state of the request. PENDING indicates that
this request has not yet been applied to all Amazon Route 53 DNS servers.
Valid Values: PENDING | INSYNC
String comment
A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
String submitter
The AWS account ID attached to the changes.
com.amazonaws.internal.SdkInternalList<T> changes
A list of changes made in the ChangeBatch.
String id
The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
String status
The current state of the request. PENDING indicates that
this request has not yet been applied to all Amazon Route 53 DNS servers.
Valid Values: PENDING | INSYNC
Date submittedAt
The date and time the change was submitted, in the format
YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard
(for example, 2009-11-19T19:37:58Z). The Z after the time
indicates that the time is listed in Coordinated Universal Time (UTC).
String comment
A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
String hostedZoneId
The ID of the hosted zone that contains the resource record sets that you want to change.
ChangeBatch changeBatch
A complex type that contains an optional comment and the
Changes element.
ChangeInfo changeInfo
A complex type that contains information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
String resourceType
The type of the resource.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
String resourceId
The ID of the resource for which you want to add, change, or delete tags.
com.amazonaws.internal.SdkInternalList<T> addTags
A complex type that contains a list of Tag elements. Each
Tag element identifies a tag that you want to add or update
for the specified resource.
com.amazonaws.internal.SdkInternalList<T> removeTagKeys
A list of Tag keys that you want to remove from the
specified resource.
String callerReference
A unique string that identifies the request and that allows failed
CreateHealthCheck requests to be retried without the risk of
executing the operation twice. You must use a unique
CallerReference string every time you create a health check.
CallerReference can be any unique string; you might choose
to use a string that identifies your project.
Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
HealthCheckConfig healthCheckConfig
A complex type that contains health check configuration.
HealthCheck healthCheck
A complex type that contains identifying information about the health check.
String location
The unique URL representing the new health check.
String name
The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
This is the name you have registered with your DNS registrar. You should
ask your registrar to change the authoritative name servers for your
domain to the set of NameServers elements returned in
DelegationSet.
VPC vPC
The VPC that you want your hosted zone to be associated with. By providing this parameter, your newly created hosted cannot be resolved anywhere other than the given VPC.
String callerReference
A unique string that identifies the request and that allows failed
CreateHostedZone requests to be retried without the risk of
executing the operation twice. You must use a unique
CallerReference string every time you create a hosted zone.
CallerReference can be any unique string; you might choose
to use a string that identifies your project, such as
DNSMigration_01.
Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
HostedZoneConfig hostedZoneConfig
A complex type that contains an optional comment about your hosted zone.
String delegationSetId
The delegation set id of the reusable delgation set whose NS records you want to assign to the new hosted zone.
HostedZone hostedZone
A complex type that contains identifying information about the hosted zone.
ChangeInfo changeInfo
A complex type that contains information about the request to create a hosted zone. This includes an ID that you use when you call the GetChange action to get the current status of the change request.
DelegationSet delegationSet
A complex type that contains name server information.
VPC vPC
String location
The unique URL representing the new hosted zone.
String callerReference
A unique string that identifies the request and that allows failed
CreateReusableDelegationSet requests to be retried without
the risk of executing the operation twice. You must use a unique
CallerReference string every time you create a reusable
delegation set. CallerReference can be any unique string;
you might choose to use a string that identifies your project, such as
DNSMigration_01.
Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
String hostedZoneId
The ID of the hosted zone whose delegation set you want to mark as reusable. It is an optional parameter.
DelegationSet delegationSet
A complex type that contains name server information.
String location
The unique URL representing the new reusbale delegation set.
String hostedZoneId
The ID of the hosted zone in which you want Amazon Route 53 to create resource record sets by using the configuration in a traffic policy.
String name
The domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using the resource record sets that Amazon Route 53 creates for this traffic policy instance.
Long tTL
The TTL that you want Amazon Route 53 to assign to all of the resource record sets that it creates in the specified hosted zone.
String trafficPolicyId
The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone.
Integer trafficPolicyVersion
The version of the traffic policy that you want to use to create resource record sets in the specified hosted zone.
TrafficPolicyInstance trafficPolicyInstance
A complex type that contains settings for the new traffic policy instance.
String location
A unique URL that represents a new traffic policy instance.
TrafficPolicy trafficPolicy
A complex type that contains settings for the new traffic policy.
String location
String id
The ID of the traffic policy for which you want to create a new version.
String document
The definition of a new traffic policy version, in JSON format. You must specify the full definition of the new traffic policy. You cannot specify just the differences between the new version and a previous version.
String comment
Any comments that you want to include about the new traffic policy version.
TrafficPolicy trafficPolicy
A complex type that contains settings for the new version of the traffic policy.
String location
String id
String callerReference
com.amazonaws.internal.SdkInternalList<T> nameServers
A complex type that contains the authoritative name servers for the
hosted zone. Use the method provided by your domain registrar to add an
NS record to your domain for each NameServer that is
assigned to your hosted zone.
String healthCheckId
The ID of the health check to delete.
String id
The ID of the hosted zone you want to delete.
ChangeInfo changeInfo
A complex type that contains the ID, the status, and the date and time of your delete request.
String id
The ID of the reusable delegation set you want to delete.
String id
The ID of the traffic policy instance that you want to delete.
String hostedZoneId
The ID of the hosted zone you want to disassociate your VPC from.
Note that you cannot disassociate the last VPC from a hosted zone.
VPC vPC
The VPC that you want your hosted zone to be disassociated from.
String comment
Optional: Any comments you want to include about a
DisassociateVPCFromHostedZoneRequest.
ChangeInfo changeInfo
A complex type that contains the ID, the status, and the date and time of
your DisassociateVPCFromHostedZoneRequest.
String continentCode
The code for a continent geo location. Note: only continent locations have a continent code.
Valid values: AF | AN | AS |
EU | OC | NA | SA
Constraint: Specifying ContinentCode with either
CountryCode or SubdivisionCode returns an
InvalidInput error.
String countryCode
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All
other country codes follow the ISO 3166 two-character code.
String subdivisionCode
The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
Constraint: Specifying SubdivisionCode without
CountryCode returns an InvalidInput error.
String continentCode
The code for a continent geo location. Note: only continent locations have a continent code.
String continentName
The name of the continent. This element is only present if
ContinentCode is also present.
String countryCode
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All
other country codes follow the ISO 3166 two-character code.
String countryName
The name of the country. This element is only present if
CountryCode is also present.
String subdivisionCode
The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
String subdivisionName
The name of the subdivision. This element is only present if
SubdivisionCode is also present.
String id
The ID of the change batch request. The value that you specify here is
the value that ChangeResourceRecordSets returned in the Id
element when you submitted the request.
ChangeBatchRecord changeBatchRecord
A complex type that contains information about the specified change batch, including the change batch ID, the status of the change, and the contained changes.
String id
The ID of the change batch request. The value that you specify here is
the value that ChangeResourceRecordSets returned in the Id
element when you submitted the request.
ChangeInfo changeInfo
A complex type that contains information about the specified change batch, including the change batch ID, the status of the change, and the date and time of the request.
com.amazonaws.internal.SdkInternalList<T> checkerIpRanges
A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health checkers.
String continentCode
The code for a continent geo location. Note: only continent locations have a continent code.
Valid values: AF | AN | AS |
EU | OC | NA | SA
Constraint: Specifying ContinentCode with either
CountryCode or SubdivisionCode returns an
InvalidInput error.
String countryCode
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All
other country codes follow the ISO 3166 two-character code.
String subdivisionCode
The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
Constraint: Specifying SubdivisionCode without
CountryCode returns an InvalidInput error.
GeoLocationDetails geoLocationDetails
A complex type that contains the information about the specified geo location.
Long healthCheckCount
The number of health checks associated with the current AWS account.
String healthCheckId
The ID of the health check for which you want to retrieve the reason for the most recent failure.
com.amazonaws.internal.SdkInternalList<T> healthCheckObservations
A list that contains one HealthCheckObservation element for
each Amazon Route 53 health checker.
String healthCheckId
The ID of the health check to retrieve.
HealthCheck healthCheck
A complex type that contains the information about the specified health check.
String healthCheckId
If you want Amazon Route 53 to return this resource record set in
response to a DNS query only when a health check is passing, include the
HealthCheckId element and specify the ID of the applicable
health check.
Amazon Route 53 determines whether a resource record set is healthy by periodically sending a request to the endpoint that is specified in the health check. If that endpoint returns an HTTP status code of 2xx or 3xx, the endpoint is healthy. If the endpoint returns an HTTP status code of 400 or greater, or if the endpoint doesn't respond for a certain amount of time, Amazon Route 53 considers the endpoint unhealthy and also considers the resource record set unhealthy.
The HealthCheckId element is only useful when Amazon Route
53 is choosing between two or more resource record sets to respond to a
DNS query, and you want Amazon Route 53 to base the choice in part on the
status of a health check. Configuring health checks only makes sense in
the following configurations:
You set EvaluateTargetHealth to true for the
resource record sets in an alias, weighted alias, latency alias,
geolocation alias, or failover alias resource record set, and you specify
health check IDs for all of the resource record sets that are referenced
by the alias resource record sets. For more information about this
configuration, see EvaluateTargetHealth.
Amazon Route 53 doesn't check the health of the endpoint specified in the
resource record set, for example, the endpoint specified by the IP
address in the Value element. When you add a
HealthCheckId element to a resource record set, Amazon Route
53 checks the health of the endpoint that you specified in the health
check.
For geolocation resource record sets, if an endpoint is unhealthy, Amazon
Route 53 looks for a resource record set for the larger, associated
geographic region. For example, suppose you have resource record sets for
a state in the United States, for the United States, for North America,
and for all locations. If the endpoint for the state resource record set
is unhealthy, Amazon Route 53 checks the resource record sets for the
United States, for North America, and for all locations (a resource
record set for which the value of CountryCode is *), in that
order, until it finds a resource record set for which the endpoint is
healthy.
If your health checks specify the endpoint only by domain name, we
recommend that you create a separate health check for each endpoint. For
example, create a health check for each HTTP server that is serving
content for www.example.com. For the value of
FullyQualifiedDomainName, specify the domain name of the
server (such as us-east-1-www.example.com), not the name of
the resource record sets (example.com).
FullyQualifiedDomainName matches the name of
the resource record sets and then associate the health check with those
resource record sets, health check results will be
unpredictable.com.amazonaws.internal.SdkInternalList<T> healthCheckObservations
A list that contains one HealthCheckObservation element for
each Amazon Route 53 health checker.
Long hostedZoneCount
The number of hosted zones associated with the current AWS account.
String id
The ID of the hosted zone for which you want to get a list of the name servers in the delegation set.
HostedZone hostedZone
A complex type that contains the information about the specified hosted zone.
DelegationSet delegationSet
A complex type that contains information about the name servers for the specified hosted zone.
com.amazonaws.internal.SdkInternalList<T> vPCs
A complex type that contains information about VPCs associated with the specified hosted zone.
String id
The ID of the reusable delegation set for which you want to get a list of the name server.
DelegationSet delegationSet
A complex type that contains the information about the nameservers for the specified delegation set ID.
Integer trafficPolicyInstanceCount
The number of traffic policy instances that are associated with the current AWS account.
String id
The ID of the traffic policy instance that you want to get information about.
TrafficPolicyInstance trafficPolicyInstance
A complex type that contains settings for the traffic policy instance.
TrafficPolicy trafficPolicy
A complex type that contains settings for the specified traffic policy.
String id
The ID of the specified health check.
String callerReference
A unique string that identifies the request to create the health check.
HealthCheckConfig healthCheckConfig
A complex type that contains the health check configuration.
Long healthCheckVersion
The version of the health check. You can optionally pass this value in a
call to UpdateHealthCheck to prevent overwriting another
change to the health check.
String iPAddress
IP Address of the instance being checked.
Integer port
Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
String type
The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
String resourcePath
Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks. The HTTP request is issued to the instance on the given port and path.
String fullyQualifiedDomainName
Fully qualified domain name of the instance to be health checked.
String searchString
A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
Integer requestInterval
The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each Amazon Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
Integer failureThreshold
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Boolean measureLatency
A Boolean value that indicates whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Amazon Route 53 console.
Boolean inverted
A boolean value that indicates whether the status of health check should
be inverted. For example, if a health check is healthy but
Inverted is True, then Amazon Route 53
considers the health check to be unhealthy.
Integer healthThreshold
The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.
com.amazonaws.internal.SdkInternalList<T> childHealthChecks
For a specified parent health check, a list of HealthCheckId
values for the associated child health checks.
String iPAddress
The IP address of the Amazon Route 53 health checker that performed the health check.
StatusReport statusReport
A complex type that contains information about the health check status for the current observation.
String id
The ID of the specified hosted zone.
String name
The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
This is the name you have registered with your DNS registrar. You should
ask your registrar to change the authoritative name servers for your
domain to the set of NameServers elements returned in
DelegationSet.
String callerReference
A unique string that identifies the request to create the hosted zone.
HostedZoneConfig config
A complex type that contains the Comment element.
Long resourceRecordSetCount
Total number of resource record sets in the hosted zone.
com.amazonaws.internal.SdkInternalList<T> messages
Descriptive message for the error response.
String hostedZoneId
The ID of the hosted zone that you want to see changes for.
String startDate
The start of the time period you want to see changes for.
String endDate
The end of the time period you want to see changes for.
String maxItems
The maximum number of items on a page.
String marker
The page marker.
String maxItems
The maximum number of items on a page.
String marker
The page marker.
Boolean isTruncated
A flag that indicates if there are more change batches to list.
com.amazonaws.internal.SdkInternalList<T> changeBatchRecords
The change batches within the given hosted zone and time period.
String nextMarker
The next page marker.
String hostedZoneId
The ID of the hosted zone that you want to see changes for.
String name
The name of the RRSet that you want to see changes for.
String type
The type of the RRSet that you want to see changes for.
String setIdentifier
The identifier of the RRSet that you want to see changes for.
String startDate
The start of the time period you want to see changes for.
String endDate
The end of the time period you want to see changes for.
String maxItems
The maximum number of items on a page.
String marker
The page marker.
String maxItems
The maximum number of items on a page.
String marker
The page marker.
Boolean isTruncated
A flag that indicates if there are more change batches to list.
com.amazonaws.internal.SdkInternalList<T> changeBatchRecords
The change batches within the given hosted zone and time period.
String nextMarker
The next page marker.
String startContinentCode
The first continent code in the lexicographic ordering of geo locations
that you want the ListGeoLocations request to list. For
non-continent geo locations, this should be null.
Valid values: AF | AN | AS |
EU | OC | NA | SA
Constraint: Specifying ContinentCode with either
CountryCode or SubdivisionCode returns an
InvalidInput error.
String startCountryCode
The first country code in the lexicographic ordering of geo locations
that you want the ListGeoLocations request to list.
The default geo location uses a * for the country code. All
other country codes follow the ISO 3166 two-character code.
String startSubdivisionCode
The first subdivision code in the lexicographic ordering of geo locations
that you want the ListGeoLocations request to list.
Constraint: Specifying SubdivisionCode without
CountryCode returns an InvalidInput error.
String maxItems
The maximum number of geo locations you want in the response body.
com.amazonaws.internal.SdkInternalList<T> geoLocationDetailsList
A complex type that contains information about the geo locations that are returned by the request.
Boolean isTruncated
A flag that indicates whether there are more geo locations to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the values included in the ListGeoLocationsResponse$NextContinentCode, ListGeoLocationsResponse$NextCountryCode and ListGeoLocationsResponse$NextSubdivisionCode elements.
Valid Values: true | false
String nextContinentCode
If the results were truncated, the continent code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location to list is a continent location.
String nextCountryCode
If the results were truncated, the country code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location to list is not a continent location.
String nextSubdivisionCode
If the results were truncated, the subdivision code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location has a subdivision.
String maxItems
The maximum number of records you requested. The maximum value of
MaxItems is 100.
String marker
If the request returned more than one page of results, submit another
request and specify the value of NextMarker from the last
response in the marker parameter to get the next page of
results.
String maxItems
Specify the maximum number of health checks to return per page of results.
com.amazonaws.internal.SdkInternalList<T> healthChecks
A complex type that contains information about the health checks associated with the current AWS account.
String marker
If the request returned more than one page of results, submit another
request and specify the value of NextMarker from the last
response in the marker parameter to get the next page of
results.
Boolean isTruncated
A flag indicating whether there are more health checks to be listed. If
your results were truncated, you can make a follow-up request for the
next page of results by using the Marker element.
Valid Values: true | false
String nextMarker
Indicates where to continue listing health checks. If
ListHealthChecksResponse$IsTruncated is true, make
another request to ListHealthChecks and include the value of
the NextMarker element in the Marker element to
get the next page of results.
String maxItems
The maximum number of health checks to be included in the response body.
If the number of health checks associated with this AWS account exceeds
MaxItems, the value of
ListHealthChecksResponse$IsTruncated in the response is
true. Call ListHealthChecks again and specify
the value of ListHealthChecksResponse$NextMarker in the
ListHostedZonesRequest$Marker element to get the next page of
results.
String dNSName
The first name in the lexicographic ordering of domain names that you
want the ListHostedZonesByNameRequest request to list.
If the request returned more than one page of results, submit another
request and specify the value of NextDNSName and
NextHostedZoneId from the last response in the
DNSName and HostedZoneId parameters to get the
next page of results.
String hostedZoneId
If the request returned more than one page of results, submit another
request and specify the value of NextDNSName and
NextHostedZoneId from the last response in the
DNSName and HostedZoneId parameters to get the
next page of results.
String maxItems
Specify the maximum number of hosted zones to return per page of results.
com.amazonaws.internal.SdkInternalList<T> hostedZones
A complex type that contains information about the hosted zones associated with the current AWS account.
String dNSName
The DNSName value sent in the request.
String hostedZoneId
The HostedZoneId value sent in the request.
Boolean isTruncated
A flag indicating whether there are more hosted zones to be listed. If
your results were truncated, you can make a follow-up request for the
next page of results by using the NextDNSName and
NextHostedZoneId elements.
Valid Values: true | false
String nextDNSName
If ListHostedZonesByNameResponse$IsTruncated is true,
there are more hosted zones associated with the current AWS account. To
get the next page of results, make another request to
ListHostedZonesByName. Specify the value of
ListHostedZonesByNameResponse$NextDNSName in the
ListHostedZonesByNameRequest$DNSName element and
ListHostedZonesByNameResponse$NextHostedZoneId in the
ListHostedZonesByNameRequest$HostedZoneId element.
String nextHostedZoneId
If ListHostedZonesByNameResponse$IsTruncated is true,
there are more hosted zones associated with the current AWS account. To
get the next page of results, make another request to
ListHostedZonesByName. Specify the value of
ListHostedZonesByNameResponse$NextDNSName in the
ListHostedZonesByNameRequest$DNSName element and
ListHostedZonesByNameResponse$NextHostedZoneId in the
ListHostedZonesByNameRequest$HostedZoneId element.
String maxItems
The maximum number of hosted zones to be included in the response body.
If the number of hosted zones associated with this AWS account exceeds
MaxItems, the value of
ListHostedZonesByNameResponse$IsTruncated in the response is
true. Call ListHostedZonesByName again and
specify the value of ListHostedZonesByNameResponse$NextDNSName and
ListHostedZonesByNameResponse$NextHostedZoneId elements
respectively to get the next page of results.
String marker
If the request returned more than one page of results, submit another
request and specify the value of NextMarker from the last
response in the marker parameter to get the next page of
results.
String maxItems
Specify the maximum number of hosted zones to return per page of results.
String delegationSetId
com.amazonaws.internal.SdkInternalList<T> hostedZones
A complex type that contains information about the hosted zones associated with the current AWS account.
String marker
If the request returned more than one page of results, submit another
request and specify the value of NextMarker from the last
response in the marker parameter to get the next page of
results.
Boolean isTruncated
A flag indicating whether there are more hosted zones to be listed. If
your results were truncated, you can make a follow-up request for the
next page of results by using the Marker element.
Valid Values: true | false
String nextMarker
Indicates where to continue listing hosted zones. If
ListHostedZonesResponse$IsTruncated is true, make
another request to ListHostedZones and include the value of
the NextMarker element in the Marker element to
get the next page of results.
String maxItems
The maximum number of hosted zones to be included in the response body.
If the number of hosted zones associated with this AWS account exceeds
MaxItems, the value of
ListHostedZonesResponse$IsTruncated in the response is
true. Call ListHostedZones again and specify
the value of ListHostedZonesResponse$NextMarker in the
ListHostedZonesRequest$Marker element to get the next page of
results.
String hostedZoneId
The ID of the hosted zone that contains the resource record sets that you want to get.
String startRecordName
The first name in the lexicographic ordering of domain names that you
want the ListResourceRecordSets request to list.
String startRecordType
The DNS type at which to begin the listing of resource record sets.
Valid values: A | AAAA | CNAME |
MX | NS | PTR | SOA |
SPF | SRV | TXT
Values for Weighted Resource Record Sets: A |
AAAA | CNAME | TXT
Values for Regional Resource Record Sets: A |
AAAA | CNAME | TXT
Values for Alias Resource Record Sets: A | AAAA
Constraint: Specifying type without specifying
name returns an InvalidInput error.
String startRecordIdentifier
Weighted resource record sets only: If results were truncated for
a given DNS name and type, specify the value of
ListResourceRecordSetsResponse$NextRecordIdentifier from the
previous response to get the next resource record set that has the
current DNS name and type.
String maxItems
The maximum number of records you want in the response body.
com.amazonaws.internal.SdkInternalList<T> resourceRecordSets
A complex type that contains information about the resource record sets that are returned by the request.
Boolean isTruncated
A flag that indicates whether there are more resource record sets to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the ListResourceRecordSetsResponse$NextRecordName element.
Valid Values: true | false
String nextRecordName
If the results were truncated, the name of the next record in the list. This element is present only if ListResourceRecordSetsResponse$IsTruncated is true.
String nextRecordType
If the results were truncated, the type of the next record in the list. This element is present only if ListResourceRecordSetsResponse$IsTruncated is true.
String nextRecordIdentifier
Weighted resource record sets only: If results were truncated for
a given DNS name and type, the value of SetIdentifier for
the next resource record set that has the current DNS name and type.
String maxItems
The maximum number of records you requested. The maximum value of
MaxItems is 100.
String marker
If the request returned more than one page of results, submit another
request and specify the value of NextMarker from the last
response in the marker parameter to get the next page of
results.
String maxItems
Specify the maximum number of reusable delegation sets to return per page of results.
com.amazonaws.internal.SdkInternalList<T> delegationSets
A complex type that contains information about the reusable delegation sets associated with the current AWS account.
String marker
If the request returned more than one page of results, submit another
request and specify the value of NextMarker from the last
response in the marker parameter to get the next page of
results.
Boolean isTruncated
A flag indicating whether there are more reusable delegation sets to be
listed. If your results were truncated, you can make a follow-up request
for the next page of results by using the Marker element.
Valid Values: true | false
String nextMarker
Indicates where to continue listing reusable delegation sets. If
ListReusableDelegationSetsResponse$IsTruncated is
true, make another request to
ListReusableDelegationSets and include the value of the
NextMarker element in the Marker element to get
the next page of results.
String maxItems
The maximum number of reusable delegation sets to be included in the
response body. If the number of reusable delegation sets associated with
this AWS account exceeds MaxItems, the value of
ListReusablDelegationSetsResponse$IsTruncated in the response is
true. Call ListReusableDelegationSets again and
specify the value of ListReusableDelegationSetsResponse$NextMarker
in the ListReusableDelegationSetsRequest$Marker element to get the
next page of results.
ResourceTagSet resourceTagSet
A ResourceTagSet containing tags associated with the
specified resource.
String resourceType
The type of the resources.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
com.amazonaws.internal.SdkInternalList<T> resourceIds
A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.
com.amazonaws.internal.SdkInternalList<T> resourceTagSets
A list of ResourceTagSets containing tags associated with
the specified resources.
String trafficPolicyIdMarker
For your first request to ListTrafficPolicies, do not
include the TrafficPolicyIdMarker parameter.
If you have more traffic policies than the value of MaxItems, ListTrafficPolicies returns only the first
MaxItems traffic policies. To get the next group of
MaxItems policies, submit another request to
ListTrafficPolicies. For the value of
TrafficPolicyIdMarker, specify the value of the
TrafficPolicyIdMarker element that was returned in the
previous response.
Policies are listed in the order in which they were created.
String maxItems
The maximum number of traffic policies to be included in the response
body for this request. If you have more than MaxItems
traffic policies, the value of the IsTruncated element in
the response is true, and the value of the
TrafficPolicyIdMarker element is the ID of the first traffic
policy in the next group of MaxItems traffic policies.
com.amazonaws.internal.SdkInternalList<T> trafficPolicySummaries
A list that contains one TrafficPolicySummary element for
each traffic policy that was created by the current AWS account.
Boolean isTruncated
A flag that indicates whether there are more traffic policies to be
listed. If the response was truncated, you can get the next group of
MaxItems traffic policies by calling
ListTrafficPolicies again and specifying the value of the
TrafficPolicyIdMarker element in the
TrafficPolicyIdMarker request parameter.
Valid Values: true | false
String trafficPolicyIdMarker
If the value of IsTruncated is true,
TrafficPolicyIdMarker is the ID of the first traffic policy
in the next group of MaxItems traffic policies.
String maxItems
The value that you specified for the MaxItems parameter in
the call to ListTrafficPolicies that produced the current
response.
String hostedZoneId
The ID of the hosted zone for which you want to list traffic policy instances.
String trafficPolicyInstanceNameMarker
For the first request to
ListTrafficPolicyInstancesByHostedZone, omit this value.
If the value of IsTruncated in the previous response was
true, TrafficPolicyInstanceNameMarker is the
name of the first traffic policy instance in the next group of
MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was
false, there are no more traffic policy instances to get for
this hosted zone.
If the value of IsTruncated in the previous response was
false, omit this value.
String trafficPolicyInstanceTypeMarker
For the first request to
ListTrafficPolicyInstancesByHostedZone, omit this value.
If the value of IsTruncated in the previous response was
true, TrafficPolicyInstanceTypeMarker is the
DNS type of the first traffic policy instance in the next group of
MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was
false, there are no more traffic policy instances to get for
this hosted zone.
String maxItems
The maximum number of traffic policy instances to be included in the
response body for this request. If you have more than
MaxItems traffic policy instances, the value of the
IsTruncated element in the response is true,
and the values of HostedZoneIdMarker,
TrafficPolicyInstanceNameMarker, and
TrafficPolicyInstanceTypeMarker represent the first traffic
policy instance in the next group of MaxItems traffic policy
instances.
com.amazonaws.internal.SdkInternalList<T> trafficPolicyInstances
A list that contains one TrafficPolicyInstance element for
each traffic policy instance that matches the elements in the request.
String trafficPolicyInstanceNameMarker
If IsTruncated is true,
TrafficPolicyInstanceNameMarker is the name of the first
traffic policy instance in the next group of MaxItems
traffic policy instances.
String trafficPolicyInstanceTypeMarker
If IsTruncated is true,
TrafficPolicyInstanceTypeMarker is the DNS type of the
resource record sets that are associated with the first traffic policy
instance in the next group of MaxItems traffic policy
instances.
Boolean isTruncated
A flag that indicates whether there are more traffic policy instances to
be listed. If the response was truncated, you can get the next group of
MaxItems traffic policy instances by calling
ListTrafficPolicyInstancesByHostedZone again and specifying
the values of the HostedZoneIdMarker,
TrafficPolicyInstanceNameMarker, and
TrafficPolicyInstanceTypeMarker elements in the
corresponding request parameters.
Valid Values: true | false
String maxItems
The value that you specified for the MaxItems parameter in
the call to ListTrafficPolicyInstancesByHostedZone that
produced the current response.
String trafficPolicyId
The ID of the traffic policy for which you want to list traffic policy instances.
Integer trafficPolicyVersion
The version of the traffic policy for which you want to list traffic
policy instances. The version must be associated with the traffic policy
that is specified by TrafficPolicyId.
String hostedZoneIdMarker
For the first request to ListTrafficPolicyInstancesByPolicy,
omit this value.
If the value of IsTruncated in the previous response was
true, HostedZoneIdMarker is the ID of the
hosted zone for the first traffic policy instance in the next group of
MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was
false, there are no more traffic policy instances to get for
this hosted zone.
If the value of IsTruncated in the previous response was
false, omit this value.
String trafficPolicyInstanceNameMarker
For the first request to ListTrafficPolicyInstancesByPolicy,
omit this value.
If the value of IsTruncated in the previous response was
true, TrafficPolicyInstanceNameMarker is the
name of the first traffic policy instance in the next group of
MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was
false, there are no more traffic policy instances to get for
this hosted zone.
If the value of IsTruncated in the previous response was
false, omit this value.
String trafficPolicyInstanceTypeMarker
For the first request to ListTrafficPolicyInstancesByPolicy,
omit this value.
If the value of IsTruncated in the previous response was
true, TrafficPolicyInstanceTypeMarker is the
DNS type of the first traffic policy instance in the next group of
MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was
false, there are no more traffic policy instances to get for
this hosted zone.
String maxItems
The maximum number of traffic policy instances to be included in the
response body for this request. If you have more than
MaxItems traffic policy instances, the value of the
IsTruncated element in the response is true,
and the values of HostedZoneIdMarker,
TrafficPolicyInstanceNameMarker, and
TrafficPolicyInstanceTypeMarker represent the first traffic
policy instance in the next group of MaxItems traffic policy
instances.
com.amazonaws.internal.SdkInternalList<T> trafficPolicyInstances
A list that contains one TrafficPolicyInstance element for
each traffic policy instance that matches the elements in the request.
String hostedZoneIdMarker
If IsTruncated is true,
HostedZoneIdMarker is the ID of the hosted zone of the first
traffic policy instance in the next group of MaxItems
traffic policy instances.
String trafficPolicyInstanceNameMarker
If IsTruncated is true,
TrafficPolicyInstanceNameMarker is the name of the first
traffic policy instance in the next group of MaxItems
traffic policy instances.
String trafficPolicyInstanceTypeMarker
If IsTruncated is true,
TrafficPolicyInstanceTypeMarker is the DNS type of the
resource record sets that are associated with the first traffic policy
instance in the next group of MaxItems traffic policy
instances.
Boolean isTruncated
A flag that indicates whether there are more traffic policy instances to
be listed. If the response was truncated, you can get the next group of
MaxItems traffic policy instances by calling
ListTrafficPolicyInstancesByPolicy again and specifying the
values of the HostedZoneIdMarker,
TrafficPolicyInstanceNameMarker, and
TrafficPolicyInstanceTypeMarker elements in the
corresponding request parameters.
Valid Values: true | false
String maxItems
The value that you specified for the MaxItems parameter in
the call to ListTrafficPolicyInstancesByPolicy that produced
the current response.
String hostedZoneIdMarker
For the first request to ListTrafficPolicyInstances, omit
this value.
If the value of IsTruncated in the previous response was
true, you have more traffic policy instances. To get the
next group of MaxItems traffic policy instances, submit
another ListTrafficPolicyInstances request. For the value of
HostedZoneIdMarker, specify the value of
HostedZoneIdMarker from the previous response, which is the
hosted zone ID of the first traffic policy instance in the next group of
MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was
false, there are no more traffic policy instances to get.
String trafficPolicyInstanceNameMarker
For the first request to ListTrafficPolicyInstances, omit
this value.
If the value of IsTruncated in the previous response was
true, TrafficPolicyInstanceNameMarker is the
name of the first traffic policy instance in the next group of
MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was
false, there are no more traffic policy instances to get.
String trafficPolicyInstanceTypeMarker
For the first request to ListTrafficPolicyInstances, omit
this value.
If the value of IsTruncated in the previous response was
true, TrafficPolicyInstanceTypeMarker is the
DNS type of the first traffic policy instance in the next group of
MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was
false, there are no more traffic policy instances to get.
String maxItems
The maximum number of traffic policy instances to be included in the
response body for this request. If you have more than
MaxItems traffic policy instances, the value of the
IsTruncated element in the response is true,
and the values of HostedZoneIdMarker,
TrafficPolicyInstanceNameMarker, and
TrafficPolicyInstanceTypeMarker represent the first traffic
policy instance in the next group of MaxItems traffic policy
instances.
com.amazonaws.internal.SdkInternalList<T> trafficPolicyInstances
A list that contains one TrafficPolicyInstance element for
each traffic policy instance that matches the elements in the request.
String hostedZoneIdMarker
If IsTruncated is true,
HostedZoneIdMarker is the ID of the hosted zone of the first
traffic policy instance in the next group of MaxItems
traffic policy instances.
String trafficPolicyInstanceNameMarker
If IsTruncated is true,
TrafficPolicyInstanceNameMarker is the name of the first
traffic policy instance in the next group of MaxItems
traffic policy instances.
String trafficPolicyInstanceTypeMarker
If IsTruncated is true,
TrafficPolicyInstanceTypeMarker is the DNS type of the
resource record sets that are associated with the first traffic policy
instance in the next group of MaxItems traffic policy
instances.
Boolean isTruncated
A flag that indicates whether there are more traffic policy instances to
be listed. If the response was truncated, you can get the next group of
MaxItems traffic policy instances by calling
ListTrafficPolicyInstances again and specifying the values
of the HostedZoneIdMarker,
TrafficPolicyInstanceNameMarker, and
TrafficPolicyInstanceTypeMarker elements in the
corresponding request parameters.
Valid Values: true | false
String maxItems
The value that you specified for the MaxItems parameter in
the call to ListTrafficPolicyInstances that produced the
current response.
String id
Specify the value of Id of the traffic policy for which you
want to list all versions.
String trafficPolicyVersionMarker
For your first request to ListTrafficPolicyVersions, do not
include the TrafficPolicyVersionMarker parameter.
If you have more traffic policy versions than the value of
MaxItems, ListTrafficPolicyVersions returns
only the first group of MaxItems versions. To get the next
group of MaxItems traffic policy versions, submit another
request to ListTrafficPolicyVersions. For the value of
TrafficPolicyVersionMarker, specify the value of the
TrafficPolicyVersionMarker element that was returned in the
previous response.
Traffic policy versions are listed in sequential order.
String maxItems
The maximum number of traffic policy versions that you want Amazon Route
53 to include in the response body for this request. If the specified
traffic policy has more than MaxItems versions, the value of
the IsTruncated element in the response is true
, and the value of the TrafficPolicyVersionMarker element is
the ID of the first version in the next group of MaxItems
traffic policy versions.
com.amazonaws.internal.SdkInternalList<T> trafficPolicies
A list that contains one TrafficPolicy element for each
traffic policy version that is associated with the specified traffic
policy.
Boolean isTruncated
A flag that indicates whether there are more traffic policies to be
listed. If the response was truncated, you can get the next group of
maxitems traffic policies by calling
ListTrafficPolicyVersions again and specifying the value of
the NextMarker element in the marker parameter.
Valid Values: true | false
String trafficPolicyVersionMarker
If IsTruncated is true, the value of
TrafficPolicyVersionMarker identifies the first traffic
policy in the next group of MaxItems traffic policies. Call
ListTrafficPolicyVersions again and specify the value of
TrafficPolicyVersionMarker in the
TrafficPolicyVersionMarker request parameter.
This element is present only if IsTruncated is
true.
String maxItems
The value that you specified for the maxitems parameter in
the call to ListTrafficPolicyVersions that produced the
current response.
String value
The current or new DNS record value, not to exceed 4,000 characters. In
the case of a DELETE action, if the current value does not
match the actual value, an error is returned. For descriptions about how
to format Value for different record types, see Supported DNS Resource Record Types in the Amazon Route 53
Developer Guide.
You can specify more than one value for all record types except
CNAME and SOA.
String name
The name of the domain you want to perform the action on.
Enter a fully qualified domain name, for example,
www.example.com. You can optionally include a trailing dot.
If you omit the trailing dot, Amazon Route 53 still assumes that the
domain name that you specify is fully qualified. This means that Amazon
Route 53 treats www.example.com (without a trailing dot) and
www.example.com. (with a trailing dot) as identical.
For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.
You can use an asterisk (*) character in the name. DNS treats the * character either as a wildcard or as the * character (ASCII 42), depending on where it appears in the name. For more information, see Using an Asterisk (*) in the Names of Hosted Zones and Resource Record Sets in the Amazon Route 53 Developer Guide
String type
The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.
Valid values for basic resource record sets: A |
AAAA | CNAME | MX |
NS | PTR | SOA | SPF
| SRV | TXT
Values for weighted, latency, geolocation, and failover resource record
sets: A | AAAA | CNAME |
MX | PTR | SPF | SRV
| TXT. When creating a group of weighted, latency,
geolocation, or failover resource record sets, specify the same value for
all of the resource record sets in the group.
Type is
SPF. RFC 7208, Sender Policy Framework (SPF) for
Authorizing Use of Domains in Email, Version 1, has been updated to
say,
"...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it."
In RFC 7208, see section 14.1, The SPF DNS Record
Type.Values for alias resource record sets:
AA | AAAANS or SOA.String setIdentifier
Weighted, Latency, Geo, and Failover resource record sets only: An
identifier that differentiates among multiple resource record sets that
have the same combination of DNS name and type. The value of
SetIdentifier must be unique for each resource record set
that has the same combination of DNS name and type.
Long weight
Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Amazon Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Amazon Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:
Weight element for
every weighted resource record set.ResourceRecord per weighted
resource record set.Name and
Type elements as weighted resource record sets.Name and Type
elements.
For weighted (but not weighted alias) resource record sets, if you set
Weight to 0 for a resource record set, Amazon
Route 53 never responds to queries with the applicable value for that
resource record set. However, if you set Weight to
0 for all resource record sets that have the same
combination of DNS name and type, traffic is routed to all resources with
equal probability.
The effect of setting Weight to 0 is different
when you associate health checks with weighted resource record sets. For
more information, see Options for Configuring Amazon Route 53 Active-Active and Active-Passive
Failover in the Amazon Route 53 Developer Guide.
String region
Latency-based resource record sets only: The Amazon EC2 region where the resource that is specified in this resource record set resides. The resource typically is an AWS resource, such as an Amazon EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.
When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Amazon Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 region. Amazon Route 53 then returns the value that is associated with the selected resource record set.
Note the following:
ResourceRecord per latency
resource record set.Name and Type elements as
latency resource record sets.GeoLocation geoLocation
Geo location resource record sets only: A complex type that lets
you control how Amazon Route 53 responds to DNS queries based on the
geographic origin of the query. For example, if you want all queries from
Africa to be routed to a web server with an IP address of
192.0.2.111, create a resource record set with a
Type of A and a ContinentCode of
AF.
If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.
You cannot create two geolocation resource record sets that specify the same geographic location.
The value * in the CountryCode element matches
all geographic locations that aren't specified in other geolocation
resource record sets that have the same values for the Name
and Type elements.
CountryCode is *,
which handles both queries that come from locations for which you haven't
created geolocation resource record sets and queries from IP addresses
that aren't mapped to a location. If you don't create a *
resource record set, Amazon Route 53 returns a "no answer" response for
queries from those locations.
You cannot create non-geolocation resource record sets that have the same
values for the Name and Type elements as
geolocation resource record sets.
String failover
Failover resource record sets only: To configure failover, you add
the Failover element to two resource record sets. For one
resource record set, you specify PRIMARY as the value for
Failover; for the other resource record set, you specify
SECONDARY. In addition, you include the
HealthCheckId element and specify the health check that you
want Amazon Route 53 to perform for each resource record set.
Except where noted, the following failover behaviors assume that you have
included the HealthCheckId element in both resource record
sets:
HealthCheckId element for the secondary
resource record set, and if the primary resource record set is unhealthy,
Amazon Route 53 always responds to DNS queries with the applicable value
from the secondary resource record set. This is true regardless of the
health of the associated endpoint.
You cannot create non-failover resource record sets that have the same
values for the Name and Type elements as
failover resource record sets.
For failover alias resource record sets, you must also include the
EvaluateTargetHealth element and set the value to true.
For more information about configuring failover for Amazon Route 53, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
Valid values: PRIMARY | SECONDARY
Long tTL
The cache time to live for the current resource record set. Note the following:
TTL. Amazon Route 53 uses the value of TTL for
the alias target.HealthCheckId element), we recommend
that you specify a TTL of 60 seconds or less so clients
respond quickly to changes in health status.TTL.TTL of 60
seconds for all of the non-alias weighted resource record sets that have
the same name and type. Values other than 60 seconds (the TTL for load
balancers) will change the effect of the values that you specify for
Weight.com.amazonaws.internal.SdkInternalList<T> resourceRecords
A complex type that contains the resource records for the current resource record set.
AliasTarget aliasTarget
Alias resource record sets only: Information about the AWS resource to which you are redirecting traffic.
String healthCheckId
Health Check resource record sets only, not required for alias resource record sets: An identifier that is used to identify health check associated with the resource record set.
String trafficPolicyInstanceId
String resourceType
The type of the resource.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
String resourceId
The ID for the specified resource.
com.amazonaws.internal.SdkInternalList<T> tags
The tags associated with the specified resource.
String status
The observed health check status.
Date checkedTime
The date and time the health check status was observed, in the format
YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard
(for example, 2009-11-19T19:37:58Z). The Z after the time
indicates that the time is listed in Coordinated Universal Time (UTC).
String healthCheckId
The ID of the health check to update.
Long healthCheckVersion
Optional. When you specify a health check version, Amazon Route 53
compares this value with the current value in the health check, which
prevents you from updating the health check when the versions don't
match. Using HealthCheckVersion lets you prevent overwriting
another change to the health check.
String iPAddress
The IP address of the resource that you want to check.
Specify this value only if you want to change it.
Integer port
The port on which you want Amazon Route 53 to open a connection to perform health checks.
Specify this value only if you want to change it.
String resourcePath
The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.
Specify this value only if you want to change it.
String fullyQualifiedDomainName
Fully qualified domain name of the instance to be health checked.
Specify this value only if you want to change it.
String searchString
If the value of Type is HTTP_STR_MATCH or
HTTP_STR_MATCH, the string that you want Amazon Route 53 to
search for in the response body from the specified resource. If the
string appears in the response body, Amazon Route 53 considers the
resource healthy.
Specify this value only if you want to change it.
Integer failureThreshold
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Specify this value only if you want to change it.
Boolean inverted
A boolean value that indicates whether the status of health check should
be inverted. For example, if a health check is healthy but
Inverted is True, then Amazon Route 53
considers the health check to be unhealthy.
Specify this value only if you want to change it.
Integer healthThreshold
The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.
Specify this value only if you want to change it.
com.amazonaws.internal.SdkInternalList<T> childHealthChecks
For a specified parent health check, a list of HealthCheckId
values for the associated child health checks.
Specify this value only if you want to change it.
HealthCheck healthCheck
HostedZone hostedZone
TrafficPolicy trafficPolicy
A complex type that contains settings for the specified traffic policy.
String id
The ID of the traffic policy instance that you want to update.
Long tTL
The TTL that you want Amazon Route 53 to assign to all of the updated resource record sets.
String trafficPolicyId
The ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.
Integer trafficPolicyVersion
The version of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.
TrafficPolicyInstance trafficPolicyInstance
A complex type that contains settings for the updated traffic policy instance.
String domainName
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
String idnLangCode
Reserved for future use.
String availability
Whether the domain name is available for registering.
You can only register domains designated as AVAILABLE.
Type: String
Valid values:
AVAILABLE – The domain name is available.AVAILABLE_RESERVED – The domain name is reserved under
specific conditions.AVAILABLE_PREORDER – The domain name is available and
can be preordered.UNAVAILABLE – The domain name is not available.UNAVAILABLE_PREMIUM – The domain name is not available.UNAVAILABLE_RESTRICTED – The domain name is forbidden.RESERVED – The domain name has been reserved for another
person or organization.DONT_KNOW – The TLD registry didn't reply with a
definitive answer about whether the domain name is available. Amazon
Route 53 can return this response for a variety of reasons, for example,
the registry is performing maintenance. Try again later.String firstName
First name of contact.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact,
TechContact
Required: Yes
String lastName
Last name of contact.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact,
TechContact
Required: Yes
String contactType
Indicates whether the contact is a person, company, association, or
public organization. If you choose an option other than
PERSON, you must enter an organization name, and you
can't enable privacy protection for the contact.
Type: String
Default: None
Constraints: Maximum 255 characters.
Valid values: PERSON | COMPANY |
ASSOCIATION | PUBLIC_BODY
Parents: RegistrantContact, AdminContact,
TechContact
Required: Yes
String organizationName
Name of the organization for contact types other than PERSON
.
Type: String
Default: None
Constraints: Maximum 255 characters. Contact type must not be
PERSON.
Parents: RegistrantContact, AdminContact,
TechContact
Required: No
String addressLine1
First line of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact,
TechContact
Required: Yes
String addressLine2
Second line of contact's address, if any.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact,
TechContact
Required: No
String city
The city of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact,
TechContact
Required: Yes
String state
The state or province of the contact's city.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact,
TechContact
Required: No
String countryCode
Code for the country of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact,
TechContact
Required: Yes
String zipCode
The zip or postal code of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact,
TechContact
Required: No
String phoneNumber
The phone number of the contact.
Type: String
Default: None
Constraints: Phone number must be specified in the format
"+[country dialing code].[number including any area code>]". For example,
a US phone number might appear as "+1.1234567890".
Parents: RegistrantContact, AdminContact,
TechContact
Required: Yes
String email
Email address of the contact.
Type: String
Default: None
Constraints: Maximum 254 characters.
Parents: RegistrantContact, AdminContact,
TechContact
Required: Yes
String fax
Fax number of the contact.
Type: String
Default: None
Constraints: Phone number must be specified in the format
"+[country dialing code].[number including any area code]". For example,
a US phone number might appear as "+1.1234567890".
Parents: RegistrantContact, AdminContact,
TechContact
Required: No
com.amazonaws.internal.SdkInternalList<T> extraParams
A list of name-value pairs for parameters required by certain top-level domains.
Type: Complex
Default: None
Parents: RegistrantContact, AdminContact,
TechContact
Children: Name, Value
Required: No
String domainName
The domain for which you want to delete one or more tags.
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when they're surrounded by letters, numbers, or other hyphens. You can't specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode.
Required: Yes
com.amazonaws.internal.SdkInternalList<T> tagsToDelete
A list of tag keys to delete.
Type: A list that contains the keys of the tags that you want to delete.
Default: None
Required: No
'>String domainName
String domainName
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
String domainName
The name of a domain.
Type: String
Boolean autoRenew
Indicates whether the domain is automatically renewed upon expiration.
Type: Boolean
Valid values: True | False
Boolean transferLock
Indicates whether a domain is locked from unauthorized transfer to another party.
Type: Boolean
Valid values: True | False
Date expiry
Expiration date of the domain in Coordinated Universal Time (UTC).
Type: Long
String domainName
String domainName
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
String name
Name of the additional parameter required by the top-level domain.
Type: String
Default: None
Valid values: DUNS_NUMBER | BRAND_NUMBER |
BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD |
BIRTH_COUNTRY | BIRTH_CITY |
DOCUMENT_NUMBER | AU_ID_NUMBER |
AU_ID_TYPE | CA_LEGAL_TYPE |
ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE |
ES_LEGAL_FORM | FI_BUSINESS_NUMBER |
FI_ID_NUMBER | IT_PIN |
RU_PASSPORT_DATA | SE_ID_NUMBER |
SG_ID_NUMBER | VAT_NUMBER
Parent: ExtraParams
Required: Yes
String value
Values corresponding to the additional parameter names required by some top-level domains.
Type: String
Default: None
Constraints: Maximum 2048 characters.
Parent: ExtraParams
Required: Yes
String domainName
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
String domainName
The name of a domain.
Type: String
com.amazonaws.internal.SdkInternalList<T> nameservers
The name of the domain.
Type: String
Boolean autoRenew
Specifies whether the domain registration is set to renew automatically.
Type: Boolean
ContactDetail adminContact
Provides details about the domain administrative contact.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
ContactDetail registrantContact
Provides details about the domain registrant.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
ContactDetail techContact
Provides details about the domain technical contact.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
Boolean adminPrivacy
Specifies whether contact information for the admin contact is concealed
from WHOIS queries. If the value is true, WHOIS ("who is")
queries will return contact information for our registrar partner, Gandi,
instead of the contact information that you enter.
Type: Boolean
Boolean registrantPrivacy
Specifies whether contact information for the registrant contact is
concealed from WHOIS queries. If the value is true, WHOIS
("who is") queries will return contact information for our registrar
partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Boolean techPrivacy
Specifies whether contact information for the tech contact is concealed
from WHOIS queries. If the value is true, WHOIS ("who is")
queries will return contact information for our registrar partner, Gandi,
instead of the contact information that you enter.
Type: Boolean
String registrarName
Name of the registrar of the domain as identified in the registry. Amazon
Route 53 domains are registered by registrar Gandi. The value is
"GANDI SAS".
Type: String
String whoIsServer
The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.
Type: String
String registrarUrl
Web address of the registrar.
Type: String
String abuseContactEmail
Email address to contact to report incorrect contact information for a domain, to report that the domain is being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse.
Type: String
String abuseContactPhone
Phone number for reporting abuse.
Type: String
String registryDomainId
Reserved for future use.
Date creationDate
The date when the domain was created as found in the response to a WHOIS query. The date format is Unix time.
Date updatedDate
The last updated date of the domain as found in the response to a WHOIS query. The date format is Unix time.
Date expirationDate
The date when the registration for the domain is set to expire. The date format is Unix time.
String reseller
Reseller of the domain. Domains registered or transferred using Amazon
Route 53 domains will have "Amazon" as the reseller.
Type: String
String dnsSec
Reserved for future use.
com.amazonaws.internal.SdkInternalList<T> statusList
An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.
ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, transferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars use this same set of status codes.
For a current list of domain name status codes and an explanation of what
each code means, go to the ICANN
website and search for epp status codes. (Search on the
ICANN website; web searches sometimes return an old version of the
document.)
Type: Array of String
String operationId
The identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier in the response to the original request.
Type: String
Default: None
Required: Yes
String operationId
The identifier for the operation.
Type: String
String status
The current status of the requested operation in the system.
Type: String
String message
Detailed information on the status including possible errors.
Type: String
String domainName
The name of a domain.
Type: String
String type
The type of operation that was requested.
Type: String
Date submittedDate
The date when the request was submitted.
String marker
For an initial request for a list of domains, omit this element. If the
number of domains that are associated with the current AWS account is
greater than the value that you specified for MaxItems, you
can use Marker to return additional domains. Get the value
of NextPageMarker from the previous response, and submit
another request that includes the value of NextPageMarker in
the Marker element.
Type: String
Default: None
Constraints: The marker must match the value specified in the previous request.
Required: No
Integer maxItems
Number of domains to be returned.
Type: Integer
Default: 20
Constraints: A numeral between 1 and 100.
Required: No
com.amazonaws.internal.SdkInternalList<T> domains
A summary of domains.
Type: Complex type containing a list of domain summaries.
Children: AutoRenew, DomainName,
Expiry, TransferLock
String nextPageMarker
If there are more domains than you specified for MaxItems in
the request, submit another request and include the value of
NextPageMarker in the value of Marker.
Type: String
Parent: Operations
String marker
For an initial request for a list of operations, omit this element. If
the number of operations that are not yet complete is greater than the
value that you specified for MaxItems, you can use
Marker to return additional operations. Get the value of
NextPageMarker from the previous response, and submit
another request that includes the value of NextPageMarker in
the Marker element.
Type: String
Default: None
Required: No
Integer maxItems
Number of domains to be returned.
Type: Integer
Default: 20
Constraints: A value between 1 and 100.
Required: No
com.amazonaws.internal.SdkInternalList<T> operations
Lists summaries of the operations.
Type: Complex type containing a list of operation summaries
Children: OperationId, Status,
SubmittedDate, Type
String nextPageMarker
If there are more operations than you specified for MaxItems
in the request, submit another request and include the value of
NextPageMarker in the value of Marker.
Type: String
Parent: Operations
String domainName
The domain for which you want to get a list of tags.
com.amazonaws.internal.SdkInternalList<T> tagList
A list of the tags that are associated with the specified domain.
Type: A complex type containing a list of tags
Each tag includes the following elements.
Key
The key (name) of a tag.
Type: String
Value
The value of a tag.
Type: String
String name
The fully qualified host name of the name server.
Type: String
Constraint: Maximum 255 characterss
Parent: Nameservers
com.amazonaws.internal.SdkInternalList<T> glueIps
Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server is a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is ns.example.com, you need to specify the IP address for ns.example.com.
Type: List of IP addresses.
Constraints: The list can contain only one IPv4 and one IPv6 address.
Parent: Nameservers
String operationId
Identifier returned to track the requested action.
Type: String
String status
The current status of the requested operation in the system.
Type: String
String type
Type of the action requested.
Type: String
Valid values: REGISTER_DOMAIN | DELETE_DOMAIN |
TRANSFER_IN_DOMAIN | UPDATE_DOMAIN_CONTACT |
UPDATE_NAMESERVER | CHANGE_PRIVACY_PROTECTION |
DOMAIN_LOCK
Date submittedDate
The date when the request was submitted.
String domainName
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
String idnLangCode
Reserved for future use.
Integer durationInYears
The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.
Type: Integer
Default: 1
Valid values: Integer from 1 to 10
Required: Yes
Boolean autoRenew
Indicates whether the domain will be automatically renewed (
true) or not (false). Autorenewal only takes
effect after the account is charged.
Type: Boolean
Valid values: true | false
Default: true
Required: No
ContactDetail adminContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
Required: Yes
ContactDetail registrantContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
Required: Yes
ContactDetail techContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
Required: Yes
Boolean privacyProtectAdminContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
Boolean privacyProtectRegistrantContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
Boolean privacyProtectTechContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
String domainName
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
String authCode
The authorization code for the domain.
Type: String
String key
The key (name) of a tag.
Type: String
Default: None
Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@"
Constraints: Each key can be 1-128 characters long.
Required: Yes
String value
The value of a tag.
Type: String
Default: None
Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@"
Constraints: Each value can be 0-256 characters long.
Required: Yes
String domainName
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
String idnLangCode
Reserved for future use.
Integer durationInYears
The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.
Type: Integer
Default: 1
Valid values: Integer from 1 to 10
Required: Yes
com.amazonaws.internal.SdkInternalList<T> nameservers
Contains details for the host and glue IP addresses.
Type: Complex
Children: GlueIps, Name
Required: No
String authCode
The authorization code for the domain. You get this value from the current registrar.
Type: String
Required: Yes
Boolean autoRenew
Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.
Type: Boolean
Valid values: true | false
Default: true
Required: No
ContactDetail adminContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
Required: Yes
ContactDetail registrantContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
Required: Yes
ContactDetail techContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
Required: Yes
Boolean privacyProtectAdminContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
Boolean privacyProtectRegistrantContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
Boolean privacyProtectTechContact
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
String domainName
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Boolean adminPrivacy
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: None
Valid values: true | false
Required: No
Boolean registrantPrivacy
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: None
Valid values: true | false
Required: No
Boolean techPrivacy
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: None
Valid values: true | false
Required: No
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
String domainName
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
ContactDetail adminContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
Required: Yes
ContactDetail registrantContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
Required: Yes
ContactDetail techContact
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode, PhoneNumber,
Email, Fax, ExtraParams
Required: Yes
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
String domainName
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
String fIAuthKey
The authorization key for .fi domains
com.amazonaws.internal.SdkInternalList<T> nameservers
A list of new name servers for the domain.
Type: Complex
Children: Name, GlueIps
Required: Yes
String operationId
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
String domainName
The domain for which you want to add or update tags.
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when they're surrounded by letters, numbers, or other hyphens. You can't specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode.
Required: Yes
com.amazonaws.internal.SdkInternalList<T> tagsToUpdate
A list of the tag keys and values that you want to add or update. If you specify a key that already exists, the corresponding value will be replaced.
Type: A complex type containing a list of tags
Default: None
Required: No
'>Each tag includes the following elements:
Key
The key (name) of a tag.
Type: String
Default: None
Valid values: Unicode characters including alphanumeric, space, and ".:/=+\-@"
Constraints: Each key can be 1-128 characters long.
Required: Yes
Value
The value of a tag.
Type: String
Default: None
Valid values: Unicode characters including alphanumeric, space, and ".:/=+\-@"
Constraints: Each value can be 0-256 characters long.
Required: Yes
String bucketName
Permission.Write permission granted to you
in order to upload new objects to a bucket.String key
File file
ObjectMetadata metadata
CannedAccessControlList cannedAcl
AccessControlList accessControlList
String storageClass
For more information on Amazon S3 storage classes and available values,
see the StorageClass enumeration.
String redirectLocation
SSECustomerKey sseCustomerKey
SSEAwsKeyManagementParams sseAwsKeyManagementParams
String extendedRequestId
Map<K,V> additionalDetails
String errorResponseXml
int days
String storageClass
String id
String prefix
String status
int expirationInDays
int noncurrentVersionExpirationInDays
Date expirationDate
List<E> transitions
List<E> noncurrentVersionTransitions
int days
Date date
String storageClass
String policyText
String indexDocumentSuffix
String errorDocument
RedirectRule redirectAllRequestsTo
List<E> routingRules
String bucketName
String key
String uploadId
List<E> partETags
String bucketName
String key
String location
String eTag
String versionId
Date expirationTime
String expirationTimeRuleId
String sourceBucketName
String sourceKey
String sourceVersionId
For more information about enabling versioning for a bucket, see
AmazonS3.setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest).
String destinationBucketName
String destinationKey
String storageClass
For more information on Amazon S3 storage classes and available values,
see the StorageClass enumeration.
ObjectMetadata newObjectMetadata
CannedAccessControlList cannedACL
AccessControlList accessControlList
List<E> matchingETagConstraints
List<E> nonmatchingEtagConstraints
Date unmodifiedSinceConstraint
Date modifiedSinceConstraint
String redirectLocation
SSECustomerKey sourceSSECustomerKey
SSECustomerKey destinationSSECustomerKey
SSEAwsKeyManagementParams sseAwsKeyManagementParams
String etag
Date lastModifiedDate
String versionId
Date expirationTime
String expirationTimeRuleId
String uploadId
int partNumber
String sourceBucketName
String sourceKey
String sourceVersionId
For more information about enabling versioning for a bucket, see
AmazonS3#withBucketVersioningConfiguration(withBucketVersioningConfigurationRequest).
String destinationBucketName
String destinationKey
List<E> matchingETagConstraints
List<E> nonmatchingEtagConstraints
Date unmodifiedSinceConstraint
Date modifiedSinceConstraint
Long firstByte
CopyPartRequest.lastByteLong lastByte
CopyPartRequest.firstByte.SSECustomerKey sourceSSECustomerKey
SSECustomerKey destinationSSECustomerKey
String etag
Date lastModifiedDate
String versionId
int partNumber
String bucketName
String region
CannedAccessControlList cannedAcl
AccessControlList accessControlList
CryptoMode cryptoMode
CryptoStorageMode storageMode
Provider cryptoProvider
boolean ignoreMissingInstructionFile
CryptoMode.StrictAuthenticatedEncryption where
missing instruction file would always cause security exception.Regions kmsRegion
String bucketName
String bucketName
String bucketName
boolean quiet
MultiFactorAuthentication mfa
BucketVersioningConfiguration.setMfaDeleteEnabled(Boolean) for
more information on MFA Delete.List<E> keys
String bucketName
String key
String versionId
MultiFactorAuthentication mfa
BucketVersioningConfiguration.setMfaDeleteEnabled(Boolean) for
more information on MFA Delete.String emailAddress
ExtraMaterialsDescription supplemental
String instructionFileSuffix
boolean keyWrapExpected
Note, however, that if CryptoMode.StrictAuthenticatedEncryption
is in use, key wrapping is always expected for the CEK regardless.
Map<K,V> extra
ExtraMaterialsDescription.ConflictResolution resolve
ExtraMaterialsDescription.ConflictResolution.FAIL_FAST.S3KeyFilter s3KeyFilter
HttpMethod method
String bucketName
String key
String contentType
String contentMd5
Date expiration
boolean zeroByteContent
Map<K,V> requestParameters
ResponseHeaderOverrides responseHeaders
SSECustomerKey sseCustomerKey
String sseAlgorithm
String kmsCmkId
String bucketName
String bucketName
String bucketName
String bucketName
String bucketName
String bucketName
String key
String versionId
SSECustomerKey sseCustomerKey
S3ObjectIdBuilder s3ObjectIdBuilder
long[] range
List<E> matchingETagConstraints
List<E> nonmatchingEtagConstraints
Date unmodifiedSinceConstraint
Date modifiedSinceConstraint
ResponseHeaderOverrides responseHeaders
boolean isRequesterPays
SSECustomerKey sseCustomerKey
String bucketName
Grantee grantee
Permission permission
String bucketName
String bucketRegion
String bucketName
String key
ObjectMetadata objectMetadata
CannedAccessControlList cannedACL
AccessControlList accessControlList
StorageClass storageClass
String redirectLocation
SSECustomerKey sseCustomerKey
SSEAwsKeyManagementParams sseAwsKeyManagementParams
String functionARN
String bucketName
String delimiter
MultipartUploadListing.getCommonPrefixes() list. These rolled-up
keys are not returned elsewhere in the response. The most commonly used
delimiter is "/", which simulates a hierarchical organization similar to
a file system directory structure.String prefix
Integer maxUploads
String keyMarker
Together with the upload ID marker, specifies the multipart upload after which listing should begin.
If the upload ID marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.
If the upload ID marker is specified, any multipart uploads for a key equal to the key-marker may also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified marker.
String uploadIdMarker
Together with the key marker, specifies the multipart upload after which listing should begin. If no key marker is specified, the upload ID marker is ignored. Otherwise, any multipart uploads for a key equal to the key marker may be included in the list only if they have an upload ID lexicographically greater than the specified marker.
String encodingType
ObjectListing previousObjectListing
VersionListing previousVersionListing
String bucketName
String prefix
String marker
ObjectListing.getNextMarker() as the marker
for the next request to list objects.String delimiter
ObjectListing.getCommonPrefixes() list. These rolled-up keys
are not returned elsewhere in the response. The most commonly used
delimiter is "/", which simulates a hierarchical organization similar to
a file system directory structure.Integer maxKeys
String encodingType
String bucketName
String key
String uploadId
Integer maxParts
Integer partNumberMarker
String encodingType
String bucketName
String prefix
String keyMarker
This enables pagination; to get the next page of results use the next key
marker and next version ID marker (from
VersionListing.getNextKeyMarker() and
VersionListing.getNextVersionIdMarker()) as the markers for the
next request to list versions. Or use the convenience method
AmazonS3.listNextBatchOfVersions(VersionListing)
String versionIdMarker
This enables pagination; to get the next page of results use the next key
marker and next version ID marker (from
VersionListing.getNextKeyMarker() and
VersionListing.getNextVersionIdMarker()) as the markers for the
next request to list versions. Or use the convenience method
AmazonS3.listNextBatchOfVersions(VersionListing)
String delimiter
VersionListing.getCommonPrefixes() list. These rolled-up keys
are not returned elsewhere in the response. The most commonly used
delimiter is "/", which simulates a hierarchical organization similar to
a file system directory structure.Integer maxResults
String encodingType
String key
String uploadId
Owner owner
Owner initiator
String storageClass
Date initiated
String bucketName
String keyMarker
String delimiter
String prefix
String uploadIdMarker
int maxUploads
String encodingType
boolean isTruncated
String nextKeyMarker
String nextUploadIdMarker
List<E> multipartUploads
List<E> commonPrefixes
List<E> objectSummaries
List<E> commonPrefixes
String bucketName
String nextMarker
boolean isTruncated
String prefix
String marker
int maxKeys
String delimiter
String encodingType
Map<K,V> userMetadata
Map<K,V> metadata
Date httpExpiresDate
Date expirationTime
This and the expiration time rule aren't stored in the metadata map because the header contains both the time and the rule.
String expirationTimeRuleId
Boolean ongoingRestore
Date restoreExpirationTime
int partNumber
String eTag
String bucketName
String key
String uploadId
Integer maxParts
Integer partNumberMarker
String encodingType
Owner owner
Owner initiator
String storageClass
boolean isTruncated
Integer nextPartNumberMarker
List<E> parts
int partNumber
Date lastModified
String eTag
long size
String versionId
String eTag
Date expirationTime
String expirationTimeRuleId
String contentMd5
ObjectMetadata metadata
String queueARN
String protocol
String hostName
String replaceKeyPrefixWith
String replaceKeyWith
String httpRedirectCode
String prefix
String status
ReplicationDestinationConfig destinationConfig
RequestPaymentConfiguration.Payer payer
int expirationInDays
String bucketName
String key
String versionId
For more information about enabling versioning for a bucket, see
AmazonS3#setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest).
For more information about enabling lifecycle versioning for a bucket,
see AmazonS3#setBucketLifecycleConfiguration(SetBucketLifecycleConfigurationRequest).
RoutingRuleCondition condition
RedirectRule redirect
String keyPrefixEquals
String httpErrorCodeReturnedEquals
String key
String bucketName
ObjectMetadata metadata
String redirectLocation
boolean isRequesterCharged
String bucketName
String key
String eTag
long size
Date lastModified
String storageClass
Owner owner
String bucketName
String key
String versionId
boolean isLatest
Date lastModified
Owner owner
String eTag
long size
String storageClass
boolean isDeleteMarker
String bucketName
AccessControlList acl
CannedAccessControlList cannedAcl
String bucketName
BucketCrossOriginConfiguration crossOriginConfiguration
String bucketName
BucketLifecycleConfiguration lifecycleConfiguration
String bucketName
BucketLoggingConfiguration loggingConfiguration
BucketNotificationConfiguration notificationConfiguration
String bucketName
String bucketName
BucketReplicationConfiguration replicationConfiguration
String bucketName
BucketTaggingConfiguration taggingConfiguration
String bucketName
BucketVersioningConfiguration versioningConfiguration
MultiFactorAuthentication mfa
BucketVersioningConfiguration for more details on MFA Delete.String bucketName
BucketWebsiteConfiguration configuration
String bucketName
String key
String versionId
AccessControlList acl
CannedAccessControlList cannedAcl
String bucketName
RequestPaymentConfiguration configuration
Map<K,V> map
EncryptionMaterials latest
String awsKmsKeyId
EncryptionMaterials materials
String topicARN
ObjectMetadata uploadPartMetadata
Map<K,V> materialsDescription
long partSize
long diskLimit
UploadObjectRequest.partSize. The default is .ObjectMetadata objectMetadata
String bucketName
String key
String uploadId
int partNumber
long partSize
String md5Digest
File file
long fileOffset
boolean isLastPart
SSECustomerKey sseCustomerKey
int partNumber
String eTag
List<E> versionSummaries
List<E> commonPrefixes
String bucketName
String nextKeyMarker
String nextVersionIdMarker
boolean isTruncated
String prefix
String keyMarker
String versionIdMarker
int maxKeys
String delimiter
String encodingType
PauseStatus status
String assumedRoleId
A unique identifier that contains the role ID and the role session name of the role that is being assumed. The role ID is generated by AWS when the role is created.
String arn
The ARN of the temporary security credentials that are returned from the AssumeRole action. For more information about ARNs and how to use them in policies, see IAM Identifiers in Using IAM.
String roleArn
The Amazon Resource Name (ARN) of the role to assume.
String roleSessionName
An identifier for the assumed role session.
Use the role session name to uniquely identity a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.
String policy
An IAM policy in JSON format.
This parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both (the intersection of) the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the Using IAM.
Integer durationSeconds
The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.
String externalId
A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the Using IAM.
String serialNumber
The identification number of the MFA device that is associated with the
user who is making the AssumeRole call. Specify this value
if the trust policy of the role being assumed includes a condition that
requires MFA authentication. The value is either the serial number for a
hardware device (such as GAHT12345678) or an Amazon Resource
Name (ARN) for a virtual device (such as
arn:aws:iam::123456789012:mfa/user).
String tokenCode
The value provided by the MFA device, if the trust policy of the role
being assumed requires MFA (that is, if the policy includes a condition
that tests for MFA). If the role being assumed requires MFA and if the
TokenCode value is missing or expired, the
AssumeRole call returns an "access denied" error.
Credentials credentials
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
AssumedRoleUser assumedRoleUser
The Amazon Resource Name (ARN) and the assumed role ID, which are
identifiers that you can use to refer to the resulting temporary security
credentials. For example, you can reference these credentials as a
principal in a resource-based policy by using the ARN or assumed role ID.
The ARN and ID include the RoleSessionName that you
specified when you called AssumeRole.
Integer packedPolicySize
A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
String roleArn
The Amazon Resource Name (ARN) of the role that the caller is assuming.
String principalArn
The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
String sAMLAssertion
The base-64 encoded SAML authentication response provided by the IdP.
For more information, see Configuring a Relying Party and Adding Claims in the Using IAM guide.
String policy
An IAM policy in JSON format.
The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the Using IAM.
Integer durationSeconds
The duration, in seconds, of the role session. The value can range from
900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value
is set to 3600 seconds. An expiration can also be specified in the SAML
authentication response's SessionNotOnOrAfter value. The
actual expiration time is whichever value is shorter.
Credentials credentials
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
AssumedRoleUser assumedRoleUser
Integer packedPolicySize
A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
String subject
The value of the NameID element in the Subject
element of the SAML assertion.
String subjectType
The format of the name ID, as defined by the Format
attribute in the NameID element of the SAML assertion.
Typical examples of the format are transient or
persistent.
If the format includes the prefix
urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is
removed. For example,
urn:oasis:names:tc:SAML:2.0:nameid-format:transient is
returned as transient. If the format includes any other
prefix, the format is returned with no modifications.
String issuer
The value of the Issuer element of the SAML assertion.
String audience
The value of the Recipient attribute of the
SubjectConfirmationData element of the SAML assertion.
String nameQualifier
A hash value based on the concatenation of the Issuer
response value, the AWS account ID, and the friendly name (the last part
of the ARN) of the SAML provider in IAM. The combination of
NameQualifier and Subject can be used to
uniquely identify a federated user.
The following pseudocode shows how the hash value is calculated:
BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )
String roleArn
The Amazon Resource Name (ARN) of the role that the caller is assuming.
String roleSessionName
An identifier for the assumed role session. Typically, you pass the name
or identifier that is associated with the user who is using your
application. That way, the temporary security credentials that your
application will use are associated with that user. This session name is
included as part of the ARN and assumed role ID in the
AssumedRoleUser response element.
String webIdentityToken
The OAuth 2.0 access token or OpenID Connect ID token that is provided by
the identity provider. Your application must get this token by
authenticating the user who is using your application with a web identity
provider before the application makes an
AssumeRoleWithWebIdentity call.
String providerId
The fully qualified host component of the domain name of the identity provider.
Specify this value only for OAuth 2.0 access tokens. Currently
www.amazon.com and graph.facebook.com are the
only supported identity providers for OAuth 2.0 access tokens. Do not
include URL schemes and port numbers.
Do not specify this value for OpenID Connect ID tokens.
String policy
An IAM policy in JSON format.
The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRoleWithWebIdentity in the Using IAM.
Integer durationSeconds
The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.
Credentials credentials
The temporary security credentials, which include an access key ID, a secret access key, and a security token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
String subjectFromWebIdentityToken
The unique user identifier that is returned by the identity provider.
This identifier is associated with the WebIdentityToken that
was submitted with the AssumeRoleWithWebIdentity call. The
identifier is typically unique to the user and the application that
acquired the WebIdentityToken (pairwise identifier). For
OpenID Connect ID tokens, this field contains the value returned by the
identity provider as the token's sub (Subject) claim.
AssumedRoleUser assumedRoleUser
The Amazon Resource Name (ARN) and the assumed role ID, which are
identifiers that you can use to refer to the resulting temporary security
credentials. For example, you can reference these credentials as a
principal in a resource-based policy by using the ARN or assumed role ID.
The ARN and ID include the RoleSessionName that you
specified when you called AssumeRole.
Integer packedPolicySize
A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
String provider
The issuing authority of the web identity token presented. For OpenID
Connect ID Tokens this contains the value of the iss field.
For OAuth 2.0 access tokens, this contains the value of the
ProviderId parameter that was passed in the
AssumeRoleWithWebIdentity request.
String audience
The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.
String accessKeyId
The access key ID that identifies the temporary security credentials.
String secretAccessKey
The secret access key that can be used to sign requests.
String sessionToken
The token that users must pass to the service API to use the temporary credentials.
Date expiration
The date on which the current credentials expire.
String encodedMessage
The encoded message that was returned with the response.
String decodedMessage
An XML document that contains the decoded message. For more information,
see DecodeAuthorizationMessage.
String federatedUserId
The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.
String arn
The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see IAM Identifiers in Using IAM.
String name
The name of the federated user. The name is used as an identifier for the
temporary security credentials (such as Bob). For example,
you can reference the federated user name in a resource-based policy,
such as in an Amazon S3 bucket policy.
String policy
An IAM policy in JSON format that is passed with the
GetFederationToken call and evaluated along with the policy
or policies that are attached to the IAM user whose credentials are used
to call GetFederationToken. The passed policy is used to
scope down the permissions that are available to the IAM user, by
allowing only a subset of the permissions that are granted to the IAM
user. The passed policy cannot grant more permissions than those granted
to the IAM user. The final permissions for the federated user are the
most restrictive set based on the intersection of the passed policy and
the IAM user policy.
If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.
For more information about how permissions work, see Permissions for GetFederationToken.
Integer durationSeconds
The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions obtained using AWS account (root) credentials are restricted to a maximum of 3600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using AWS account (root) credentials defaults to one hour.
Credentials credentials
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
FederatedUser federatedUser
Identifiers for the federated user associated with the credentials (such
as arn:aws:sts::123456789012:federated-user/Bob or
123456789012:Bob). You can use the federated user's ARN in
your resource-based policies, such as an Amazon S3 bucket policy.
Integer packedPolicySize
A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value.
Integer durationSeconds
The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour.
String serialNumber
The identification number of the MFA device that is associated with the
IAM user who is making the 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.
String tokenCode
The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, and the user does not provide a code when requesting a set of temporary security credentials, the user will receive an "access denied" response when requesting resources that require MFA authentication.
Credentials credentials
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
Float boxUsage
String domainName
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String domainName
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String domainName
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
String domainName
String itemName
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
UpdateCondition expected
String domainName
String domainName
Integer itemCount
Long itemNamesSizeBytes
Integer attributeNameCount
Long attributeNamesSizeBytes
Integer attributeValueCount
Long attributeValuesSizeBytes
Integer timestamp
Float boxUsage
String domainName
String itemName
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeNames
Boolean consistentRead
true, any data previously
written to SimpleDB will be returned. Otherwise, results will be
consistent eventually, and the client may not see data that was
written immediately before your read.com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
String name
String alternateNameEncoding
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainNames
String nextToken
MaxNumberOfDomains still available.Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
String domainName
String itemName
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
UpdateCondition expected
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
Float boxUsage
String selectExpression
String nextToken
ItemNames.Boolean consistentRead
true, any data previously
written to SimpleDB will be returned. Otherwise, results will be
consistent eventually, and the client may not see data that was
written immediately before your read.com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String nextToken
MaxNumberOfItems were matched, the response size exceeded
1 megabyte, or the execution time exceeded 5 seconds.Float boxUsage
String name
String value
Exists parameter is equal to true.Boolean exists
true if the attribute must exist for
the update condition to be satisfied. Specify false if
the attribute should not exist in order for the update condition to be
satisfied.String headerName
The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.
String headerValue
Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n").
String name
Content text
The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).
Content html
The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.
String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
bounce action is taken. An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
String smtpReplyCode
The SMTP reply code, as defined by RFC 5321.
String statusCode
The SMTP enhanced status code, as defined by RFC 3463.
String message
Human-readable text to include in the bounce message.
String sender
The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.
String recipient
The email address of the recipient of the bounced email.
String recipientArn
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to receive email for the recipient of the bounced email. For more information about sending authorization, see the Amazon SES Developer Guide.
String bounceType
The reason for the bounce. You must provide either this parameter or
RecipientDsnFields.
RecipientDsnFields recipientDsnFields
Recipient-related DSN fields, most of which would normally be filled in
automatically when provided with a BounceType. You must
provide either this parameter or BounceType.
String name
String ruleSetName
The name of the rule set to create. The name must:
String originalRuleSetName
The name of the rule set to clone.
ReceiptFilter filter
A data structure that describes the IP address filter to create, which consists of a name, an IP address range, and whether to allow or block mail from it.
String ruleSetName
The name of the rule set to which to add the rule.
String after
The name of an existing rule after which the new rule will be placed. If this parameter is null, the new rule will be inserted at the beginning of the rule list.
ReceiptRule rule
A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
String ruleSetName
The name of the rule set to create. The name must:
String identity
The identity that is associated with the policy that you want to delete.
You can specify the identity by using its name or by using its Amazon
Resource Name (ARN). Examples: user@example.com,
example.com,
arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this API, you must own the identity.
String policyName
The name of the policy to be deleted.
String identity
The identity to be removed from the list of identities for the AWS Account.
String filterName
The name of the IP address filter to delete.
String ruleSetName
The name of the receipt rule set to delete.
String emailAddress
An email address to be removed from the list of verified addresses.
ReceiptRuleSetMetadata metadata
The metadata for the currently active receipt rule set. The metadata consists of the rule set name and a timestamp of when the rule set was created.
com.amazonaws.internal.SdkInternalList<T> rules
The receipt rules that belong to the active rule set.
ReceiptRule rule
A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy.
String ruleSetName
The name of the receipt rule set to describe.
ReceiptRuleSetMetadata metadata
The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when the rule set was created.
com.amazonaws.internal.SdkInternalList<T> rules
A list of the receipt rules that belong to the specified receipt rule set.
com.amazonaws.internal.SdkInternalList<T> toAddresses
The To: field(s) of the message.
com.amazonaws.internal.SdkInternalList<T> ccAddresses
The CC: field(s) of the message.
com.amazonaws.internal.SdkInternalList<T> bccAddresses
The BCC: field(s) of the message.
String name
The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.
String value
The value of the header to add. Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n").
com.amazonaws.internal.SdkInternalList<T> identities
A list of one or more verified identities - email addresses, domains, or both.
com.amazonaws.internal.SdkInternalMap<K,V> dkimAttributes
The DKIM attributes for an email address or a domain.
com.amazonaws.internal.SdkInternalList<T> identities
A list of one or more identities. You can specify an identity by using
its name or by using its Amazon Resource Name (ARN). Examples:
user@example.com, example.com,
arn:aws:ses:us-east-1:123456789012:identity/example.com.
com.amazonaws.internal.SdkInternalMap<K,V> notificationAttributes
A map of Identity to IdentityNotificationAttributes.
String identity
The identity for which the policies will be retrieved. You can specify an
identity by using its name or by using its Amazon Resource Name (ARN).
Examples: user@example.com, example.com,
arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this API, you must own the identity.
com.amazonaws.internal.SdkInternalList<T> policyNames
A list of the names of policies to be retrieved. You can retrieve a
maximum of 20 policies at a time. If you do not know the names of the
policies that are attached to the identity, you can use
ListIdentityPolicies.
com.amazonaws.internal.SdkInternalMap<K,V> policies
A map of policy names to policies.
com.amazonaws.internal.SdkInternalList<T> identities
A list of identities.
com.amazonaws.internal.SdkInternalMap<K,V> verificationAttributes
A map of Identities to IdentityVerificationAttributes objects.
Double max24HourSend
The maximum number of emails the user is allowed to send in a 24-hour interval. A value of -1 signifies an unlimited quota.
Double maxSendRate
The maximum number of emails that Amazon SES can accept from the user's account per second.
Double sentLast24Hours
The number of emails sent during the previous 24 hours.
com.amazonaws.internal.SdkInternalList<T> sendDataPoints
A list of data points, each of which represents 15 minutes of activity.
Boolean dkimEnabled
True if DKIM signing is enabled for email sent from the identity; false otherwise.
String dkimVerificationStatus
Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS. (This only applies to domain identities, not email address identities.)
com.amazonaws.internal.SdkInternalList<T> dkimTokens
A set of character strings that represent the domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
String bounceTopic
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications.
String complaintTopic
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications.
String deliveryTopic
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications.
Boolean forwardingEnabled
Describes whether Amazon SES will forward bounce and complaint
notifications as email. true indicates that Amazon SES will
forward bounce and complaint notifications as email, while
false indicates that bounce and complaint notifications will
be published only to the specified bounce and complaint Amazon SNS
topics.
String functionArn
String bucket
String topic
String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
Lambda action is taken. An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
String functionArn
The Amazon Resource Name (ARN) of the AWS Lambda function. An example of
an AWS Lambda function ARN is
arn:aws:lambda:us-west-2:account-id:function:MyFunction. For
more information about AWS Lambda, see the AWS
Lambda Developer Guide.
String invocationType
The invocation type of the AWS Lambda function. An invocation type of
RequestResponse means that the execution of the function
will immediately result in a response, and a value of Event
means that the function will be invoked asynchronously. The default value
is Event. For information about AWS Lambda invocation types,
see the AWS
Lambda Developer Guide.
RequestResponse
invocations. You should use Event invocation in most cases.
Use RequestResponse only when you want to make a mail flow
decision, such as whether to stop the receipt rule or the receipt rule
set.String identityType
The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this parameter is omitted, then all identities will be listed.
String nextToken
The token to use for pagination.
Integer maxItems
The maximum number of identities per page. Possible values are 1-1000 inclusive.
com.amazonaws.internal.SdkInternalList<T> identities
A list of identities.
String nextToken
The token used for pagination.
String identity
The identity that is associated with the policy for which the policies
will be listed. You can specify an identity by using its name or by using
its Amazon Resource Name (ARN). Examples: user@example.com,
example.com,
arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this API, you must own the identity.
com.amazonaws.internal.SdkInternalList<T> policyNames
A list of names of policies that apply to the specified identity.
com.amazonaws.internal.SdkInternalList<T> filters
A list of IP address filter data structures, which each consist of a name, an IP address range, and whether to allow or block mail from it.
String nextToken
A token returned from a previous call to ListReceiptRuleSets
to indicate the position in the receipt rule set list.
com.amazonaws.internal.SdkInternalList<T> ruleSets
The metadata for the currently active receipt rule set. The metadata consists of the rule set name and the timestamp of when the rule set was created.
String nextToken
A token indicating that there are additional receipt rule sets available
to be listed. Pass this token to successive calls of
ListReceiptRuleSets to retrieve up to 100 receipt rule sets
at a time.
com.amazonaws.internal.SdkInternalList<T> verifiedEmailAddresses
A list of email addresses that have been verified.
String reportingMta
The reporting MTA that attempted to deliver the message, formatted as
specified in RFC 3464 (
mta-name-type; mta-name). The default value is
dns; inbound-smtp.[region].amazonaws.com.
Date arrivalDate
When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format.
com.amazonaws.internal.SdkInternalList<T> extensionFields
Additional X-headers to include in the DSN.
String identity
The identity to which the policy will apply. You can specify an identity
by using its name or by using its Amazon Resource Name (ARN). Examples:
user@example.com, example.com,
arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this API, you must own the identity.
String policyName
The name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
String policy
The text of the policy in JSON format. The policy cannot exceed 4 KB.
For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.
ByteBuffer data
The raw data of the message. The client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, MIME encoding, and base64 encoding (if necessary).
The To:, CC:, and BCC: headers in the raw message can contain a group list.
If you are using SendRawEmail with sending authorization,
you can include X-headers in the raw message to specify the "Source,"
"From," and "Return-Path" addresses. For more information, see the
documentation for SendRawEmail.
For more information, go to the Amazon SES Developer Guide.
S3Action s3Action
Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
BounceAction bounceAction
Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
WorkmailAction workmailAction
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.
LambdaAction lambdaAction
Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
StopAction stopAction
Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
AddHeaderAction addHeaderAction
Adds a header to the received email.
SNSAction sNSAction
Publishes the email content within a notification to Amazon SNS.
String name
The name of the IP address filter. The name must:
ReceiptIpFilter ipFilter
A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.
String policy
Indicates whether to block or allow incoming mail from the specified IP addresses.
String cidr
A single IP address or a range of IP addresses that you want to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see RFC 2317.
String name
The name of the receipt rule. The name must:
Boolean enabled
If true, the receipt rule is active. The default value is
true.
String tlsPolicy
Specifies whether Amazon SES should require that incoming email is
delivered over a connection encrypted with Transport Layer Security
(TLS). If this parameter is set to Require, Amazon SES will
bounce emails that are not received over TLS. The default is
Optional.
com.amazonaws.internal.SdkInternalList<T> recipients
The recipient domains and email addresses to which the receipt rule applies. If this field is not specified, this rule will match all recipients under all verified domains.
com.amazonaws.internal.SdkInternalList<T> actions
An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
Boolean scanEnabled
If true, then messages to which this receipt rule applies
are scanned for spam and viruses. The default value is true.
String name
The name of the receipt rule set. The name must:
Date createdTimestamp
The date and time the receipt rule set was created.
String finalRecipient
The email address to which the message was ultimately delivered. This
corresponds to the Final-Recipient in the DSN. If not
specified, FinalRecipient will be set to the
Recipient specified in the BouncedRecipientInfo
structure. Either FinalRecipient or the recipient in
BouncedRecipientInfo must be a recipient of the original
bounced message.
FinalRecipient email address with
rfc 822;, as described in RFC 3798.String action
The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.
String remoteMta
The MTA to which the remote MTA attempted to deliver the message,
formatted as specified in RFC 3464 (
mta-name-type; mta-name). This parameter typically applies
only to propagating synchronous bounces.
String status
The status code that indicates what went wrong. This is required by RFC 3464.
String diagnosticCode
An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.
Date lastAttemptDate
The time the final delivery attempt was made, in RFC 822 date-time format.
com.amazonaws.internal.SdkInternalList<T> extensionFields
Additional X-headers to include in the DSN.
String ruleSetName
The name of the receipt rule set to reorder.
com.amazonaws.internal.SdkInternalList<T> ruleNames
A list of the specified receipt rule set's receipt rules in the order that you want to put them.
String name
String name
String topicArn
The ARN of the Amazon SNS topic to notify when the message is saved to
the Amazon S3 bucket. An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
String bucketName
The name of the Amazon S3 bucket to which to save the received email.
String objectKeyPrefix
The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.
String kmsKeyArn
The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows:
arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses.
For example, if your AWS account ID is 123456789012 and you want to use
the default master key in the US West (Oregon) region, the ARN of the
default master key would be
arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use
the default master key, you don't need to perform any extra steps to give
Amazon SES permission to use the key.For more information about key policies, see the AWS KMS Developer Guide. If you do not specify a master key, Amazon SES will not encrypt your emails.
String originalMessageId
The message ID of the message to be bounced.
String bounceSender
The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES.
String explanation
Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information.
MessageDsn messageDsn
Message-related DSN fields. If not specified, Amazon SES will choose the values.
com.amazonaws.internal.SdkInternalList<T> bouncedRecipientInfoList
A list of recipients of the bounced message, including the information
required to create the Delivery Status Notifications (DSNs) for the
recipients. You must specify at least one
BouncedRecipientInfo in the list.
String bounceSenderArn
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the "From" header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide.
String messageId
The message ID of the bounce message.
Date timestamp
Time of the data point.
Long deliveryAttempts
Number of emails that have been enqueued for sending.
Long bounces
Number of emails that have bounced.
Long complaints
Number of unwanted emails that were rejected by recipients.
Long rejects
Number of emails rejected by Amazon SES.
String source
The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
If you are sending on behalf of another user and have been permitted to
do so by a sending authorization policy, then you must also specify the
SourceArn parameter. For more information about sending
authorization, see the Amazon SES Developer Guide.
In all cases, the email address must be 7-bit ASCII. If the text must
contain any other characters, then you must use MIME encoded-word syntax
(RFC 2047) instead of a literal string. MIME encoded-word syntax uses the
following form: =?charset?encoding?encoded-text?=. For more
information, see RFC
2047.
Destination destination
The destination for this email, composed of To:, CC:, and BCC: fields.
Message message
The message to be sent.
com.amazonaws.internal.SdkInternalList<T> replyToAddresses
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
String returnPath
The email address to which bounces and complaints are to be forwarded
when feedback forwarding is enabled. If the message cannot be delivered
to the recipient, then an error message will be returned from the
recipient's ISP; this message will then be forwarded to the email address
specified by the ReturnPath parameter. The
ReturnPath parameter is never overwritten. This email
address must be either individually verified with Amazon SES, or from a
domain that has been verified with Amazon SES.
String sourceArn
This parameter is used only for sending authorization. It is the ARN of
the identity that is associated with the sending authorization policy
that permits you to send for the email address specified in the
Source parameter.
For example, if the owner of example.com (which has ARN
arn:aws:ses:us-east-1:123456789012:identity/example.com)
attaches a policy to it that authorizes you to send from
user@example.com, then you would specify the
SourceArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and
the Source to be user@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
String returnPathArn
This parameter is used only for sending authorization. It is the ARN of
the identity that is associated with the sending authorization policy
that permits you to use the email address specified in the
ReturnPath parameter.
For example, if the owner of example.com (which has ARN
arn:aws:ses:us-east-1:123456789012:identity/example.com)
attaches a policy to it that authorizes you to use
feedback@example.com, then you would specify the
ReturnPathArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and
the ReturnPath to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
String messageId
The unique message identifier returned from the SendEmail
action.
String source
The identity's email address. If you do not provide a value for this parameter, you must specify a "From" address in the raw text of the message. (You can also specify both.)
By default, the string must be 7-bit ASCII. If the text must contain any
other characters, then you must use MIME encoded-word syntax (RFC 2047)
instead of a literal string. MIME encoded-word syntax uses the following
form: =?charset?encoding?encoded-text?=. For more
information, see RFC
2047.
Source parameter and have feedback
forwarding enabled, then bounces and complaints will be sent to this
email address. This takes precedence over any Return-Path header
that you might include in the raw text of the message. com.amazonaws.internal.SdkInternalList<T> destinations
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
RawMessage rawMessage
The raw text of the message. The client is responsible for ensuring the following:
String fromArn
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to specify a particular "From" address in the header of the raw email.
Instead of using this parameter, you can use the X-header
X-SES-FROM-ARN in the raw message of the email. If you use
both the FromArn parameter and the corresponding X-header,
Amazon SES uses the value of the FromArn parameter.
SendRawEmail in this guide, or see the Amazon SES Developer Guide. String sourceArn
This parameter is used only for sending authorization. It is the ARN of
the identity that is associated with the sending authorization policy
that permits you to send for the email address specified in the
Source parameter.
For example, if the owner of example.com (which has ARN
arn:aws:ses:us-east-1:123456789012:identity/example.com)
attaches a policy to it that authorizes you to send from
user@example.com, then you would specify the
SourceArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and
the Source to be user@example.com.
Instead of using this parameter, you can use the X-header
X-SES-SOURCE-ARN in the raw message of the email. If you use
both the SourceArn parameter and the corresponding X-header,
Amazon SES uses the value of the SourceArn parameter.
SendRawEmail in this guide, or see the Amazon SES Developer Guide. String returnPathArn
This parameter is used only for sending authorization. It is the ARN of
the identity that is associated with the sending authorization policy
that permits you to use the email address specified in the
ReturnPath parameter.
For example, if the owner of example.com (which has ARN
arn:aws:ses:us-east-1:123456789012:identity/example.com)
attaches a policy to it that authorizes you to use
feedback@example.com, then you would specify the
ReturnPathArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and
the ReturnPath to be feedback@example.com.
Instead of using this parameter, you can use the X-header
X-SES-RETURN-PATH-ARN in the raw message of the email. If
you use both the ReturnPathArn parameter and the
corresponding X-header, Amazon SES uses the value of the
ReturnPathArn parameter.
SendRawEmail in this guide, or see the Amazon SES Developer Guide. String messageId
The unique message identifier returned from the SendRawEmail
action.
String ruleSetName
The name of the receipt rule set to make active. Setting this value to null disables all email receiving.
String identity
The identity for which to set bounce and complaint notification
forwarding. Examples: user@example.com,
example.com.
Boolean forwardingEnabled
Sets whether Amazon SES will forward bounce and complaint notifications
as email. true specifies that Amazon SES will forward bounce
and complaint notifications as email, in addition to any Amazon SNS topic
publishing otherwise specified. false specifies that Amazon
SES will publish bounce and complaint notifications only through Amazon
SNS. This value can only be set to false when Amazon SNS
topics are set for both Bounce and Complaint
notification types.
String identity
The identity for which the Amazon SNS topic will be set. You can specify
an identity by using its name or by using its Amazon Resource Name (ARN).
Examples: user@example.com, example.com,
arn:aws:ses:us-east-1:123456789012:identity/example.com.
String notificationType
The type of notifications that will be published to the specified Amazon SNS topic.
String snsTopic
The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter
is omitted from the request or a null value is passed,
SnsTopic is cleared and publishing is disabled.
String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An
example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
String scope
The scope to which the Stop action applies. That is, what is being stopped.
String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
stop action is taken. An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
String ruleSetName
The name of the receipt rule set to which the receipt rule belongs.
ReceiptRule rule
A data structure that contains the updated receipt rule information.
String domain
The name of the domain to be verified for Easy DKIM signing.
com.amazonaws.internal.SdkInternalList<T> dkimTokens
A set of character strings that represent the domain's identity. If the identity is an email address, the tokens represent the domain of that address.
Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign emails originating from that domain.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
String domain
The domain to be verified.
String verificationToken
A TXT record that must be placed in the DNS settings for the domain, in order to complete domain verification.
String emailAddress
The email address to be verified.
String emailAddress
The email address to be verified.
String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
WorkMail action is called. An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
String organizationArn
The ARN of the Amazon WorkMail organization. An example of an Amazon
WorkMail organization ARN is
arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7
. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.
String commandId
com.amazonaws.internal.SdkInternalList<T> instanceIds
(Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested.
String commandId
String documentName
String comment
Date expiresAfter
Map<K,V> parameters
com.amazonaws.internal.SdkInternalList<T> instanceIds
Date requestedDateTime
String status
String outputS3BucketName
String outputS3KeyPrefix
String commandId
String instanceId
String comment
String documentName
Date requestedDateTime
String status
String traceOutput
com.amazonaws.internal.SdkInternalList<T> commandPlugins
String name
String status
Integer responseCode
Date responseStartDateTime
Date responseFinishDateTime
String output
String outputS3BucketName
String outputS3KeyPrefix
com.amazonaws.internal.SdkInternalList<T> entries
One or more associations.
com.amazonaws.internal.SdkInternalList<T> successful
Information about the associations that succeeded.
com.amazonaws.internal.SdkInternalList<T> failed
Information about the associations that failed.
AssociationDescription associationDescription
Information about the association.
String content
A valid JSON string. For more information about the contents of this string, see SSM Document.
String name
A name for the SSM document.
DocumentDescription documentDescription
Information about the SSM document.
String name
The name of the SSM document.
AssociationDescription associationDescription
Information about the association.
String name
The name of the SSM document.
DocumentDescription document
Information about the SSM document.
com.amazonaws.internal.SdkInternalList<T> instanceInformationFilterList
Integer maxResults
String nextToken
com.amazonaws.internal.SdkInternalList<T> instanceInformationList
String nextToken
String sha1
The SHA1 hash of the document, which you can use for verification purposes.
String name
The name of the SSM document.
Date createdDate
String status
The status of the SSM document.
String description
com.amazonaws.internal.SdkInternalList<T> parameters
A description of the parameters for a document.
com.amazonaws.internal.SdkInternalList<T> platformTypes
String name
The name of the SSM document.
com.amazonaws.internal.SdkInternalList<T> platformTypes
String name
The name of the parameter.
String type
The type of parameter. The type can be either “String” or “StringList”.
String description
A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
String defaultValue
If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
CreateAssociationBatchRequestEntry entry
The association.
String message
A description of the failure.
String fault
The source of the failure.
String name
The name of the SSM document.
String instanceId
String pingStatus
Date lastPingDateTime
String agentVersion
Boolean isLatestVersion
String platformType
String platformName
String platformVersion
String key
com.amazonaws.internal.SdkInternalList<T> valueSet
com.amazonaws.internal.SdkInternalList<T> associationFilterList
One or more filters. Use a filter to return a more specific list of results.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> associations
The associations.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
String commandId
String instanceId
Integer maxResults
String nextToken
com.amazonaws.internal.SdkInternalList<T> filters
Boolean details
com.amazonaws.internal.SdkInternalList<T> commandInvocations
String nextToken
String commandId
String instanceId
Integer maxResults
String nextToken
com.amazonaws.internal.SdkInternalList<T> filters
com.amazonaws.internal.SdkInternalList<T> commands
String nextToken
com.amazonaws.internal.SdkInternalList<T> documentFilterList
One or more filters. Use a filter to return a more specific list of results.
Integer maxResults
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
com.amazonaws.internal.SdkInternalList<T> documentIdentifiers
The names of the SSM documents.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
com.amazonaws.internal.SdkInternalList<T> instanceIds
String documentName
Integer timeoutSeconds
String comment
Map<K,V> parameters
String outputS3BucketName
String outputS3KeyPrefix
Command command
String name
The name of the SSM document.
String instanceId
The ID of the instance.
AssociationStatus associationStatus
The association status.
AssociationDescription associationDescription
Information about the association.
String details
ActivityType activityType
String activityId
String details
ActivityTaskTimeoutType timeoutType
String details
WorkflowExecution workflowExecution
WorkflowType workflowType
String details
String key
String detail
LambdaFunctionTimeoutType timeoutType
ScheduleActivityTaskFailedCause failureCause
ScheduleLambdaFunctionFailedCause failureCause
SignalExternalWorkflowExecutionFailedCause failureCause
WorkflowExecution signaledExecution
StartChildWorkflowExecutionFailedCause failureCause
StartTimerFailedCause failureCause
String details
String taskToken
Constraints:
Length: 1 - 1024
String activityId
Constraints:
Length: 1 - 256
Long startedEventId
ActivityTaskStarted event recorded in the
history.WorkflowExecution workflowExecution
ActivityType activityType
String input
Constraints:
Length: 0 - 32768
String details
Constraints:
Length: 0 - 32768
Long scheduledEventId
ActivityTaskScheduled event that was
recorded when this activity task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.Long startedEventId
ActivityTaskStarted event recorded when
this activity task was started. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.Long latestCancelRequestedEventId
ActivityTaskCancelRequested event recorded for this
activity task. This information can be useful for diagnosing problems
by tracing back the chain of events leading up to this event.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
RequestCancelActivityTask decision for this cancellation
request. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.String activityId
Constraints:
Length: 1 - 256
String result
Constraints:
Length: 0 - 32768
Long scheduledEventId
ActivityTaskScheduled event that was
recorded when this activity task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.Long startedEventId
ActivityTaskStarted event recorded when
this activity task was started. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.String reason
Constraints:
Length: 0 - 256
String details
Constraints:
Length: 0 - 32768
Long scheduledEventId
ActivityTaskScheduled event that was
recorded when this activity task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.Long startedEventId
ActivityTaskStarted event recorded when
this activity task was started. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.ActivityType activityType
String activityId
Constraints:
Length: 1 - 256
String input
Constraints:
Length: 0 - 32768
String control
Constraints:
Length: 0 - 32768
String scheduleToStartTimeout
Constraints:
Length: 0 - 8
String scheduleToCloseTimeout
Constraints:
Length: 0 - 8
String startToCloseTimeout
Constraints:
Length: 0 - 8
TaskList taskList
String taskPriority
Valid values are
integers that range from Java's Integer.MIN_VALUE
(-2147483648) to Integer.MAX_VALUE (2147483647). Higher
numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision that resulted in the scheduling of this activity task.
This information can be useful for diagnosing problems by tracing back
the chain of events leading up to this event.String heartbeatTimeout
Constraints:
Length: 0 - 8
String identity
Constraints:
Length: 0 - 256
Long scheduledEventId
ActivityTaskScheduled event that was
recorded when this activity task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.Boolean cancelRequested
true if cancellation of the task is requested.String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE, SCHEDULE_TO_START, SCHEDULE_TO_CLOSE, HEARTBEAT
Long scheduledEventId
ActivityTaskScheduled event that was
recorded when this activity task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.Long startedEventId
ActivityTaskStarted event recorded when
this activity task was started. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.String details
details parameter for the
last call made by the activity to
RecordActivityTaskHeartbeat.
Constraints:
Length: 0 - 2048
String name
Constraints:
Length: 1 - 256
String version
Constraints:
Length: 1 - 64
String defaultTaskStartToCloseTimeout
ScheduleActivityTask decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String defaultTaskHeartbeatTimeout
You can specify this value only
when registering an activity type. The registered default value
can be overridden when you schedule a task through the
ScheduleActivityTask decision. If the activity worker
subsequently attempts to record a heartbeat or returns a result, the
activity worker receives an UnknownResource fault. In
this case, Amazon SWF no longer considers the activity task to be
valid; the activity worker should clean up the activity task.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList defaultTaskList
ScheduleActivityTask decision. You can override the
default registered task list when scheduling a task through the
ScheduleActivityTask decision.String defaultTaskPriority
Valid values are integers that range from Java's
Integer.MIN_VALUE (-2147483648) to
Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
String defaultTaskScheduleToStartTimeout
ScheduleActivityTask
decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String defaultTaskScheduleToCloseTimeout
ScheduleActivityTask decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
ActivityTypeInfo typeInfo
The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.
ActivityTypeConfiguration configuration
ActivityType activityType
String status
Constraints:
Allowed Values: REGISTERED, DEPRECATED
String description
Constraints:
Length: 0 - 1024
Date creationDate
Date deprecationDate
com.amazonaws.internal.ListWithAutoConstructFlag<T> typeInfos
String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
String timerId
Constraints:
Length: 1 - 256
String timerId
CancelTimer decision that
failed.
Constraints:
Length: 1 - 256
String cause
Constraints:
Allowed Values: TIMER_ID_UNKNOWN, OPERATION_NOT_PERMITTED
Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the CancelTimer
decision to cancel this timer. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.String details
Constraints:
Length: 0 - 32768
String cause
Constraints:
Allowed Values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED
Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
CancelWorkflowExecution decision for this cancellation
request. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.WorkflowExecution workflowExecution
WorkflowType workflowType
String details
Constraints:
Length: 0 - 32768
Long initiatedEventId
StartChildWorkflowExecutionInitiated event
corresponding to the StartChildWorkflowExecution decision
to start this child workflow execution. This information can be useful
for diagnosing problems by tracing back the chain of events leading up
to this event.Long startedEventId
ChildWorkflowExecutionStarted event
recorded when this child workflow execution was started. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.WorkflowExecution workflowExecution
WorkflowType workflowType
String result
Constraints:
Length: 0 - 32768
Long initiatedEventId
StartChildWorkflowExecutionInitiated event
corresponding to the StartChildWorkflowExecution decision
to start this child workflow execution. This information can be useful
for diagnosing problems by tracing back the chain of events leading up
to this event.Long startedEventId
ChildWorkflowExecutionStarted event
recorded when this child workflow execution was started. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.WorkflowExecution workflowExecution
WorkflowType workflowType
String reason
Constraints:
Length: 0 - 256
String details
Constraints:
Length: 0 - 32768
Long initiatedEventId
StartChildWorkflowExecutionInitiated event
corresponding to the StartChildWorkflowExecution decision
to start this child workflow execution. This information can be useful
for diagnosing problems by tracing back the chain of events leading up
to this event.Long startedEventId
ChildWorkflowExecutionStarted event
recorded when this child workflow execution was started. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.WorkflowExecution workflowExecution
WorkflowType workflowType
Long initiatedEventId
StartChildWorkflowExecutionInitiated event
corresponding to the StartChildWorkflowExecution decision
to start this child workflow execution. This information can be useful
for diagnosing problems by tracing back the chain of events leading up
to this event.WorkflowExecution workflowExecution
WorkflowType workflowType
Long initiatedEventId
StartChildWorkflowExecutionInitiated event
corresponding to the StartChildWorkflowExecution decision
to start this child workflow execution. This information can be useful
for diagnosing problems by tracing back the chain of events leading up
to this event.Long startedEventId
ChildWorkflowExecutionStarted event
recorded when this child workflow execution was started. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.WorkflowExecution workflowExecution
WorkflowType workflowType
String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE
Long initiatedEventId
StartChildWorkflowExecutionInitiated event
corresponding to the StartChildWorkflowExecution decision
to start this child workflow execution. This information can be useful
for diagnosing problems by tracing back the chain of events leading up
to this event.Long startedEventId
ChildWorkflowExecutionStarted event
recorded when this child workflow execution was started. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.String status
Constraints:
Allowed Values: COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT
String result
Constraints:
Length: 0 - 32768
String cause
Constraints:
Allowed Values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED
Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
CompleteWorkflowExecution decision to complete this
execution. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.String input
Constraints:
Length: 0 - 32768
String executionStartToCloseTimeout
defaultExecutionStartToCloseTimeout
specified when registering the workflow type. The duration is
specified in seconds; an integer greater than or equal to 0. The value
"NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList taskList
String taskPriority
Integer.MIN_VALUE (-2147483648) to
Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
String taskStartToCloseTimeout
defaultTaskStartToCloseTimout specified when registering
the workflow type using RegisterWorkflowType. The duration
is specified in seconds; an integer greater than or equal to 0. The
value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
String workflowTypeVersion
String lambdaRole
Constraints:
Length: 1 - 1224
String cause
Constraints:
Allowed Values: UNHANDLED_DECISION, WORKFLOW_TYPE_DEPRECATED, WORKFLOW_TYPE_DOES_NOT_EXIST, DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_TASK_LIST_UNDEFINED, DEFAULT_CHILD_POLICY_UNDEFINED, CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED
Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
ContinueAsNewWorkflowExecution decision that started this
execution. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.String domain
Constraints:
Length: 1 - 256
ExecutionTimeFilter startTimeFilter
startTimeFilter
and closeTimeFilter are mutually exclusive. You must
specify one of these in a request but not both.ExecutionTimeFilter closeTimeFilter
startTimeFilter
and closeTimeFilter are mutually exclusive. You must
specify one of these in a request but not both.WorkflowExecutionFilter executionFilter
WorkflowId in the filter are counted.
closeStatusFilter, executionFilter,
typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.WorkflowTypeFilter typeFilter
closeStatusFilter,
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.TagFilter tagFilter
closeStatusFilter,
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.CloseStatusFilter closeStatusFilter
executionStatus is specified as CLOSED.
closeStatusFilter, executionFilter,
typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.String domain
Constraints:
Length: 1 - 256
ExecutionTimeFilter startTimeFilter
WorkflowTypeFilter typeFilter
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.TagFilter tagFilter
executionFilter,
typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.WorkflowExecutionFilter executionFilter
WorkflowId in the filter are counted.
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.String decisionType
Constraints:
Allowed Values: ScheduleActivityTask, RequestCancelActivityTask, CompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution, ContinueAsNewWorkflowExecution, RecordMarker, StartTimer, CancelTimer, SignalExternalWorkflowExecution, RequestCancelExternalWorkflowExecution, StartChildWorkflowExecution, ScheduleLambdaFunction
ScheduleActivityTaskDecisionAttributes scheduleActivityTaskDecisionAttributes
ScheduleActivityTask decision. It
is not set for other decision types.RequestCancelActivityTaskDecisionAttributes requestCancelActivityTaskDecisionAttributes
RequestCancelActivityTask
decision. It is not set for other decision types.CompleteWorkflowExecutionDecisionAttributes completeWorkflowExecutionDecisionAttributes
CompleteWorkflowExecution
decision. It is not set for other decision types.FailWorkflowExecutionDecisionAttributes failWorkflowExecutionDecisionAttributes
FailWorkflowExecution decision.
It is not set for other decision types.CancelWorkflowExecutionDecisionAttributes cancelWorkflowExecutionDecisionAttributes
CancelWorkflowExecution decision.
It is not set for other decision types.ContinueAsNewWorkflowExecutionDecisionAttributes continueAsNewWorkflowExecutionDecisionAttributes
ContinueAsNewWorkflowExecution
decision. It is not set for other decision types.RecordMarkerDecisionAttributes recordMarkerDecisionAttributes
RecordMarker decision. It is not
set for other decision types.StartTimerDecisionAttributes startTimerDecisionAttributes
StartTimer decision. It is not
set for other decision types.CancelTimerDecisionAttributes cancelTimerDecisionAttributes
CancelTimer decision. It is not
set for other decision types.SignalExternalWorkflowExecutionDecisionAttributes signalExternalWorkflowExecutionDecisionAttributes
SignalExternalWorkflowExecution
decision. It is not set for other decision types.RequestCancelExternalWorkflowExecutionDecisionAttributes requestCancelExternalWorkflowExecutionDecisionAttributes
RequestCancelExternalWorkflowExecution decision. It is
not set for other decision types.StartChildWorkflowExecutionDecisionAttributes startChildWorkflowExecutionDecisionAttributes
StartChildWorkflowExecution
decision. It is not set for other decision types.ScheduleLambdaFunctionDecisionAttributes scheduleLambdaFunctionDecisionAttributes
ScheduleLambdaFunction decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action
to only specified domains.Action element
to allow or deny permission to call this action.Condition element
with the appropriate keys. activityType.name:
String constraint. The key is swf:activityType.name.activityType.version: String constraint. The key is
swf:activityType.version.taskList:
String constraint. The key is swf:taskList.name.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
String taskToken
Constraints:
Length: 1 - 1024
Long startedEventId
DecisionTaskStarted event recorded in the
history.WorkflowExecution workflowExecution
WorkflowType workflowType
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
Long previousStartedEventId
String executionContext
Constraints:
Length: 0 - 32768
Long scheduledEventId
DecisionTaskScheduled event that was
recorded when this decision task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.Long startedEventId
DecisionTaskStarted event recorded when
this decision task was started. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.TaskList taskList
String taskPriority
Integer.MIN_VALUE (-2147483648) to
Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
String startToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String identity
Constraints:
Length: 0 - 256
Long scheduledEventId
DecisionTaskScheduled event that was
recorded when this decision task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE
Long scheduledEventId
DecisionTaskScheduled event that was
recorded when this decision task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.Long startedEventId
DecisionTaskStarted event recorded when
this decision task was started. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.String domain
Constraints:
Length: 1 - 256
ActivityType activityType
String name
Constraints:
Length: 1 - 256
String domain
Constraints:
Length: 1 - 256
WorkflowType workflowType
String domain
Constraints:
Length: 1 - 256
ActivityType activityType
name and version that were
supplied when the activity was registered.String name
Constraints:
Length: 1 - 256
String domain
Constraints:
Length: 1 - 256
WorkflowExecution execution
String domain
Constraints:
Length: 1 - 256
WorkflowType workflowType
String workflowExecutionRetentionPeriodInDays
Constraints:
Length: 1 - 8
DomainInfo domainInfo
DomainConfiguration configuration
String name
Constraints:
Length: 1 - 256
String status
Constraints:
Allowed Values: REGISTERED, DEPRECATED
String description
Constraints:
Length: 0 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainInfos
String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
WorkflowExecution workflowExecution
Long initiatedEventId
RequestCancelExternalWorkflowExecutionInitiated event
corresponding to the
RequestCancelExternalWorkflowExecution decision to cancel
this external workflow execution. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.WorkflowExecution workflowExecution
Long initiatedEventId
SignalExternalWorkflowExecutionInitiated
event corresponding to the
SignalExternalWorkflowExecution decision to request this
signal. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.String cause
Constraints:
Allowed Values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED
Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
FailWorkflowExecution decision to fail this execution.
This information can be useful for diagnosing problems by tracing back
the chain of events leading up to this event.String domain
Constraints:
Length: 1 - 256
WorkflowExecution execution
String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
Integer maximumPageSize
nextPageToken can be used to obtain futher pages of
results. The default is 1000, which is the maximum allowed page size.
You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Constraints:
Range: 0 - 1000
Boolean reverseOrder
true, returns the events in reverse order. By
default the results are returned in ascending order of the
eventTimeStamp of the events.com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
Date eventTimestamp
String eventType
Constraints:
Allowed Values: WorkflowExecutionStarted, WorkflowExecutionCancelRequested, WorkflowExecutionCompleted, CompleteWorkflowExecutionFailed, WorkflowExecutionFailed, FailWorkflowExecutionFailed, WorkflowExecutionTimedOut, WorkflowExecutionCanceled, CancelWorkflowExecutionFailed, WorkflowExecutionContinuedAsNew, ContinueAsNewWorkflowExecutionFailed, WorkflowExecutionTerminated, DecisionTaskScheduled, DecisionTaskStarted, DecisionTaskCompleted, DecisionTaskTimedOut, ActivityTaskScheduled, ScheduleActivityTaskFailed, ActivityTaskStarted, ActivityTaskCompleted, ActivityTaskFailed, ActivityTaskTimedOut, ActivityTaskCanceled, ActivityTaskCancelRequested, RequestCancelActivityTaskFailed, WorkflowExecutionSignaled, MarkerRecorded, RecordMarkerFailed, TimerStarted, StartTimerFailed, TimerFired, TimerCanceled, CancelTimerFailed, StartChildWorkflowExecutionInitiated, StartChildWorkflowExecutionFailed, ChildWorkflowExecutionStarted, ChildWorkflowExecutionCompleted, ChildWorkflowExecutionFailed, ChildWorkflowExecutionTimedOut, ChildWorkflowExecutionCanceled, ChildWorkflowExecutionTerminated, SignalExternalWorkflowExecutionInitiated, SignalExternalWorkflowExecutionFailed, ExternalWorkflowExecutionSignaled, RequestCancelExternalWorkflowExecutionInitiated, RequestCancelExternalWorkflowExecutionFailed, ExternalWorkflowExecutionCancelRequested, LambdaFunctionScheduled, LambdaFunctionStarted, LambdaFunctionCompleted, LambdaFunctionFailed, LambdaFunctionTimedOut, ScheduleLambdaFunctionFailed, StartLambdaFunctionFailed
Long eventId
WorkflowExecutionStartedEventAttributes workflowExecutionStartedEventAttributes
WorkflowExecutionStarted then
this member is set and provides detailed information about the event.
It is not set for other event types.WorkflowExecutionCompletedEventAttributes workflowExecutionCompletedEventAttributes
WorkflowExecutionCompleted then
this member is set and provides detailed information about the event.
It is not set for other event types.CompleteWorkflowExecutionFailedEventAttributes completeWorkflowExecutionFailedEventAttributes
CompleteWorkflowExecutionFailed
then this member is set and provides detailed information about the
event. It is not set for other event types.WorkflowExecutionFailedEventAttributes workflowExecutionFailedEventAttributes
WorkflowExecutionFailed then this
member is set and provides detailed information about the event. It is
not set for other event types.FailWorkflowExecutionFailedEventAttributes failWorkflowExecutionFailedEventAttributes
FailWorkflowExecutionFailed then
this member is set and provides detailed information about the event.
It is not set for other event types.WorkflowExecutionTimedOutEventAttributes workflowExecutionTimedOutEventAttributes
WorkflowExecutionTimedOut then
this member is set and provides detailed information about the event.
It is not set for other event types.WorkflowExecutionCanceledEventAttributes workflowExecutionCanceledEventAttributes
WorkflowExecutionCanceled then
this member is set and provides detailed information about the event.
It is not set for other event types.CancelWorkflowExecutionFailedEventAttributes cancelWorkflowExecutionFailedEventAttributes
CancelWorkflowExecutionFailed
then this member is set and provides detailed information about the
event. It is not set for other event types.WorkflowExecutionContinuedAsNewEventAttributes workflowExecutionContinuedAsNewEventAttributes
WorkflowExecutionContinuedAsNew
then this member is set and provides detailed information about the
event. It is not set for other event types.ContinueAsNewWorkflowExecutionFailedEventAttributes continueAsNewWorkflowExecutionFailedEventAttributes
ContinueAsNewWorkflowExecutionFailed then this member is
set and provides detailed information about the event. It is not set
for other event types.WorkflowExecutionTerminatedEventAttributes workflowExecutionTerminatedEventAttributes
WorkflowExecutionTerminated then
this member is set and provides detailed information about the event.
It is not set for other event types.WorkflowExecutionCancelRequestedEventAttributes workflowExecutionCancelRequestedEventAttributes
WorkflowExecutionCancelRequested
then this member is set and provides detailed information about the
event. It is not set for other event types.DecisionTaskScheduledEventAttributes decisionTaskScheduledEventAttributes
DecisionTaskScheduled then this
member is set and provides detailed information about the event. It is
not set for other event types.DecisionTaskStartedEventAttributes decisionTaskStartedEventAttributes
DecisionTaskStarted then this
member is set and provides detailed information about the event. It is
not set for other event types.DecisionTaskCompletedEventAttributes decisionTaskCompletedEventAttributes
DecisionTaskCompleted then this
member is set and provides detailed information about the event. It is
not set for other event types.DecisionTaskTimedOutEventAttributes decisionTaskTimedOutEventAttributes
DecisionTaskTimedOut then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskScheduledEventAttributes activityTaskScheduledEventAttributes
ActivityTaskScheduled then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskStartedEventAttributes activityTaskStartedEventAttributes
ActivityTaskStarted then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskCompletedEventAttributes activityTaskCompletedEventAttributes
ActivityTaskCompleted then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskFailedEventAttributes activityTaskFailedEventAttributes
ActivityTaskFailed then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskTimedOutEventAttributes activityTaskTimedOutEventAttributes
ActivityTaskTimedOut then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskCanceledEventAttributes activityTaskCanceledEventAttributes
ActivityTaskCanceled then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskCancelRequestedEventAttributes activityTaskCancelRequestedEventAttributes
ActivityTaskcancelRequested then
this member is set and provides detailed information about the event.
It is not set for other event types.WorkflowExecutionSignaledEventAttributes workflowExecutionSignaledEventAttributes
WorkflowExecutionSignaled then
this member is set and provides detailed information about the event.
It is not set for other event types.MarkerRecordedEventAttributes markerRecordedEventAttributes
MarkerRecorded then this member
is set and provides detailed information about the event. It is not
set for other event types.RecordMarkerFailedEventAttributes recordMarkerFailedEventAttributes
DecisionTaskFailed then this
member is set and provides detailed information about the event. It is
not set for other event types.TimerStartedEventAttributes timerStartedEventAttributes
TimerStarted then this member is
set and provides detailed information about the event. It is not set
for other event types.TimerFiredEventAttributes timerFiredEventAttributes
TimerFired then this member is
set and provides detailed information about the event. It is not set
for other event types.TimerCanceledEventAttributes timerCanceledEventAttributes
TimerCanceled then this member is
set and provides detailed information about the event. It is not set
for other event types.StartChildWorkflowExecutionInitiatedEventAttributes startChildWorkflowExecutionInitiatedEventAttributes
StartChildWorkflowExecutionInitiated then this member is
set and provides detailed information about the event. It is not set
for other event types.ChildWorkflowExecutionStartedEventAttributes childWorkflowExecutionStartedEventAttributes
ChildWorkflowExecutionStarted
then this member is set and provides detailed information about the
event. It is not set for other event types.ChildWorkflowExecutionCompletedEventAttributes childWorkflowExecutionCompletedEventAttributes
ChildWorkflowExecutionCompleted
then this member is set and provides detailed information about the
event. It is not set for other event types.ChildWorkflowExecutionFailedEventAttributes childWorkflowExecutionFailedEventAttributes
ChildWorkflowExecutionFailed then
this member is set and provides detailed information about the event.
It is not set for other event types.ChildWorkflowExecutionTimedOutEventAttributes childWorkflowExecutionTimedOutEventAttributes
ChildWorkflowExecutionTimedOut
then this member is set and provides detailed information about the
event. It is not set for other event types.ChildWorkflowExecutionCanceledEventAttributes childWorkflowExecutionCanceledEventAttributes
ChildWorkflowExecutionCanceled
then this member is set and provides detailed information about the
event. It is not set for other event types.ChildWorkflowExecutionTerminatedEventAttributes childWorkflowExecutionTerminatedEventAttributes
ChildWorkflowExecutionTerminated
then this member is set and provides detailed information about the
event. It is not set for other event types.SignalExternalWorkflowExecutionInitiatedEventAttributes signalExternalWorkflowExecutionInitiatedEventAttributes
SignalExternalWorkflowExecutionInitiated then this member
is set and provides detailed information about the event. It is not
set for other event types.ExternalWorkflowExecutionSignaledEventAttributes externalWorkflowExecutionSignaledEventAttributes
ExternalWorkflowExecutionSignaled
then this member is set and provides detailed information about the
event. It is not set for other event types.SignalExternalWorkflowExecutionFailedEventAttributes signalExternalWorkflowExecutionFailedEventAttributes
SignalExternalWorkflowExecutionFailed then this member is
set and provides detailed information about the event. It is not set
for other event types.ExternalWorkflowExecutionCancelRequestedEventAttributes externalWorkflowExecutionCancelRequestedEventAttributes
ExternalWorkflowExecutionCancelRequested then this member
is set and provides detailed information about the event. It is not
set for other event types.RequestCancelExternalWorkflowExecutionInitiatedEventAttributes requestCancelExternalWorkflowExecutionInitiatedEventAttributes
RequestCancelExternalWorkflowExecutionInitiated then this
member is set and provides detailed information about the event. It is
not set for other event types.RequestCancelExternalWorkflowExecutionFailedEventAttributes requestCancelExternalWorkflowExecutionFailedEventAttributes
RequestCancelExternalWorkflowExecutionFailed then this
member is set and provides detailed information about the event. It is
not set for other event types.ScheduleActivityTaskFailedEventAttributes scheduleActivityTaskFailedEventAttributes
ScheduleActivityTaskFailed then
this member is set and provides detailed information about the event.
It is not set for other event types.RequestCancelActivityTaskFailedEventAttributes requestCancelActivityTaskFailedEventAttributes
RequestCancelActivityTaskFailed
then this member is set and provides detailed information about the
event. It is not set for other event types.StartTimerFailedEventAttributes startTimerFailedEventAttributes
StartTimerFailed then this member
is set and provides detailed information about the event. It is not
set for other event types.CancelTimerFailedEventAttributes cancelTimerFailedEventAttributes
CancelTimerFailed then this
member is set and provides detailed information about the event. It is
not set for other event types.StartChildWorkflowExecutionFailedEventAttributes startChildWorkflowExecutionFailedEventAttributes
StartChildWorkflowExecutionFailed
then this member is set and provides detailed information about the
event. It is not set for other event types.LambdaFunctionScheduledEventAttributes lambdaFunctionScheduledEventAttributes
LambdaFunctionScheduled event.LambdaFunctionStartedEventAttributes lambdaFunctionStartedEventAttributes
LambdaFunctionStarted event.LambdaFunctionCompletedEventAttributes lambdaFunctionCompletedEventAttributes
LambdaFunctionCompleted event.LambdaFunctionFailedEventAttributes lambdaFunctionFailedEventAttributes
LambdaFunctionFailed event.LambdaFunctionTimedOutEventAttributes lambdaFunctionTimedOutEventAttributes
LambdaFunctionTimedOut event.ScheduleLambdaFunctionFailedEventAttributes scheduleLambdaFunctionFailedEventAttributes
ScheduleLambdaFunctionFailed
event.StartLambdaFunctionFailedEventAttributes startLambdaFunctionFailedEventAttributes
StartLambdaFunctionFailed event.Long scheduledEventId
LambdaFunctionScheduled event that was
recorded when this AWS Lambda function was scheduled. This information
can be useful for diagnosing problems by tracing back the chain of
events leading up to this event.Long startedEventId
LambdaFunctionStarted event recorded in the
history.String result
Constraints:
Length: 0 - 32768
Long scheduledEventId
LambdaFunctionScheduled event that was
recorded when this AWS Lambda function was scheduled. This information
can be useful for diagnosing problems by tracing back the chain of
events leading up to this event.Long startedEventId
LambdaFunctionStarted event recorded in the
history.String reason
Constraints:
Length: 0 - 256
String details
Constraints:
Length: 0 - 32768
String id
Constraints:
Length: 1 - 256
String name
Constraints:
Length: 1 - 64
String input
Constraints:
Length: 1 - 32768
String startToCloseTimeout
Constraints:
Length: 0 - 8
Long decisionTaskCompletedEventId
DecisionTaskCompleted event for the
decision that resulted in the scheduling of this AWS Lambda function.
This information can be useful for diagnosing problems by tracing back
the chain of events leading up to this event.Long scheduledEventId
LambdaFunctionScheduled event that was
recorded when this AWS Lambda function was scheduled. This information
can be useful for diagnosing problems by tracing back the chain of
events leading up to this event.Long scheduledEventId
LambdaFunctionScheduled event that was
recorded when this AWS Lambda function was scheduled. This information
can be useful for diagnosing problems by tracing back the chain of
events leading up to this event.Long startedEventId
LambdaFunctionStarted event recorded in the
history.String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE
String domain
Constraints:
Length: 1 - 256
String name
Constraints:
Length: 1 - 256
String registrationStatus
Constraints:
Allowed Values: REGISTERED, DEPRECATED
String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
Integer maximumPageSize
nextPageToken can be used to obtain futher pages of
results. The default is 1000, which is the maximum allowed page size.
You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Constraints:
Range: 0 - 1000
Boolean reverseOrder
true, returns the results in reverse order.
By default, the results are returned in ascending alphabetical order
by name of the activity types.String domain
Constraints:
Length: 1 - 256
ExecutionTimeFilter startTimeFilter
startTimeFilter and closeTimeFilter
are mutually exclusive. You must specify one of these in a request but
not both.ExecutionTimeFilter closeTimeFilter
startTimeFilter and closeTimeFilter
are mutually exclusive. You must specify one of these in a request but
not both.WorkflowExecutionFilter executionFilter
closeStatusFilter, executionFilter,
typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.CloseStatusFilter closeStatusFilter
closeStatusFilter, executionFilter,
typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.WorkflowTypeFilter typeFilter
closeStatusFilter,
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.TagFilter tagFilter
closeStatusFilter, executionFilter,
typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
Integer maximumPageSize
nextPageToken can be used to obtain futher pages of
results. The default is 1000, which is the maximum allowed page size.
You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Constraints:
Range: 0 - 1000
Boolean reverseOrder
true, returns the results in reverse order.
By default the results are returned in descending order of the start
or the close time of the executions.String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
String registrationStatus
Constraints:
Allowed Values: REGISTERED, DEPRECATED
Integer maximumPageSize
nextPageToken can be used to obtain futher pages of
results. The default is 1000, which is the maximum allowed page size.
You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Constraints:
Range: 0 - 1000
Boolean reverseOrder
true, returns the results in reverse order.
By default, the results are returned in ascending alphabetical order
by name of the domains.String domain
Constraints:
Length: 1 - 256
ExecutionTimeFilter startTimeFilter
WorkflowTypeFilter typeFilter
executionFilter, typeFilter
and tagFilter are mutually exclusive. You can specify at
most one of these in a request.TagFilter tagFilter
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
Integer maximumPageSize
nextPageToken can be used to obtain futher pages of
results. The default is 1000, which is the maximum allowed page size.
You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Constraints:
Range: 0 - 1000
Boolean reverseOrder
true, returns the results in reverse order.
By default the results are returned in descending order of the start
time of the executions.WorkflowExecutionFilter executionFilter
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.String domain
Constraints:
Length: 1 - 256
String name
Constraints:
Length: 1 - 256
String registrationStatus
Constraints:
Allowed Values: REGISTERED, DEPRECATED
String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
Integer maximumPageSize
nextPageToken can be used to obtain futher pages of
results. The default is 1000, which is the maximum allowed page size.
You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Constraints:
Range: 0 - 1000
Boolean reverseOrder
true, returns the results in reverse order.
By default the results are returned in ascending alphabetical order of
the name of the workflow types.String markerName
Constraints:
Length: 1 - 256
String details
Constraints:
Length: 0 - 32768
Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the RecordMarker
decision that requested this marker. This information can be useful
for diagnosing problems by tracing back the chain of events leading up
to this event.String domain
Constraints:
Length: 1 - 256
TaskList taskList
The specified
string must not start or end with whitespace. It must not contain a
: (colon), / (slash), |
(vertical bar), or any control characters ( - | -
). Also, it must not contain the literal string "arn".
String identity
ActivityTaskStarted event in the workflow history. This
enables diagnostic tracing when problems arise. The form of this
identity is user defined.
Constraints:
Length: 0 - 256
String domain
Constraints:
Length: 1 - 256
TaskList taskList
The specified
string must not start or end with whitespace. It must not contain a
: (colon), / (slash), |
(vertical bar), or any control characters ( - | -
). Also, it must not contain the literal string "arn".
String identity
Constraints:
Length: 0 - 256
String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call. nextPageToken
returned by this action cannot be used with
GetWorkflowExecutionHistory to get the next page. You must call
PollForDecisionTask again (with the nextPageToken)
to retrieve the next page of history records. Calling
PollForDecisionTask with a nextPageToken will not
return a new decision task.
Constraints:
Length: 0 - 2048
Integer maximumPageSize
nextPageToken can be used to obtain futher pages of
results. The default is 1000, which is the maximum allowed page size.
You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Constraints:
Range: 0 - 1000
Boolean reverseOrder
true, returns the events in reverse order. By
default the results are returned in ascending order of the
eventTimestamp of the events.String taskToken
taskToken of the ActivityTask. taskToken is generated by the service and should be
treated as an opaque value. If the task is passed to another process,
its taskToken must also be passed. This enables it to
provide its progress and respond with results.
Constraints:
Length: 1 - 1024
String details
Constraints:
Length: 0 - 2048
String markerName
Constraints:
Length: 1 - 256
String cause
Constraints:
Allowed Values: OPERATION_NOT_PERMITTED
Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
RecordMarkerFailed decision for this cancellation
request. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.String domain
Constraints:
Length: 1 - 256
String name
The specified
string must not start or end with whitespace. It must not contain a
: (colon), / (slash), |
(vertical bar), or any control characters ( - | -
). Also, it must not contain the literal string "arn".
Constraints:
Length: 1 - 256
String version
The specified string must not start or end with
whitespace. It must not contain a : (colon),
/ (slash), | (vertical bar), or any control
characters ( - | - ). Also, it must not
contain the literal string "arn".
Constraints:
Length: 1 - 64
String description
Constraints:
Length: 0 - 1024
String defaultTaskStartToCloseTimeout
ScheduleActivityTask decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String defaultTaskHeartbeatTimeout
ScheduleActivityTask decision. If the activity worker
subsequently attempts to record a heartbeat or returns a result, the
activity worker receives an UnknownResource fault. In
this case, Amazon SWF no longer considers the activity task to be
valid; the activity worker should clean up the activity task. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList defaultTaskList
ScheduleActivityTask decision.String defaultTaskPriority
Integer.MIN_VALUE (-2147483648) to
Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
String defaultTaskScheduleToStartTimeout
ScheduleActivityTask decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String defaultTaskScheduleToCloseTimeout
ScheduleActivityTask decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String name
The specified string must not
start or end with whitespace. It must not contain a :
(colon), / (slash), | (vertical bar), or any
control characters ( - | - ). Also, it must
not contain the literal string "arn".
Constraints:
Length: 1 - 256
String description
Constraints:
Length: 0 - 1024
String workflowExecutionRetentionPeriodInDays
If you pass the value
NONE or 0 (zero), then the workflow
execution history will not be retained. As soon as the workflow
execution completes, the execution record and its history are deleted.
The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.
Constraints:
Length: 1 - 8
String domain
Constraints:
Length: 1 - 256
String name
The specified string must not start
or end with whitespace. It must not contain a : (colon),
/ (slash), | (vertical bar), or any control
characters ( - | - ). Also, it must not
contain the literal string "arn".
Constraints:
Length: 1 - 256
String version
The specified
string must not start or end with whitespace. It must not contain a
: (colon), / (slash), |
(vertical bar), or any control characters ( - | -
). Also, it must not contain the literal string "arn".
Constraints:
Length: 1 - 64
String description
Constraints:
Length: 0 - 1024
String defaultTaskStartToCloseTimeout
StartChildWorkflowExecution decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String defaultExecutionStartToCloseTimeout
StartChildWorkflowExecution decision. The duration is
specified in seconds; an integer greater than or equal to 0. Unlike
some of the other timeout parameters in Amazon SWF, you cannot specify
a value of "NONE" for
defaultExecutionStartToCloseTimeout; there is a one-year
max limit on the time that a workflow execution can run. Exceeding
this limit will always cause the workflow execution to time out.
Constraints:
Length: 0 - 8
TaskList defaultTaskList
StartChildWorkflowExecution decision.String defaultTaskPriority
Integer.MIN_VALUE (-2147483648) to
Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
String defaultChildPolicy
StartChildWorkflowExecution decision. The supported child policies are:
WorkflowExecutionCancelRequested event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
String defaultLambdaRole
This default can be
overridden when starting a workflow execution using the
StartWorkflowExecution action or the
StartChildWorkflowExecution and
ContinueAsNewWorkflowExecution decision.
Constraints:
Length: 1 - 1224
String activityId
activityId of the activity task to be canceled.
Constraints:
Length: 1 - 256
String activityId
RequestCancelActivityTask
decision that failed.
Constraints:
Length: 1 - 256
String cause
Constraints:
Allowed Values: ACTIVITY_ID_UNKNOWN, OPERATION_NOT_PERMITTED
Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
RequestCancelActivityTask decision for this cancellation
request. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.String workflowId
workflowId of the external workflow
execution to cancel.
Constraints:
Length: 1 - 256
String runId
runId of the external workflow execution to cancel.
Constraints:
Length: 0 - 64
String control
Constraints:
Length: 0 - 32768
String workflowId
workflowId of the external workflow to which the
cancel request was to be delivered.
Constraints:
Length: 1 - 256
String runId
runId of the external workflow execution.
Constraints:
Length: 0 - 64
String cause
Constraints:
Allowed Values: UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION, REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED
Long initiatedEventId
RequestCancelExternalWorkflowExecutionInitiated event
corresponding to the
RequestCancelExternalWorkflowExecution decision to cancel
this external workflow execution. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
RequestCancelExternalWorkflowExecution decision for this
cancellation request. This information can be useful for diagnosing
problems by tracing back the chain of events leading up to this event.String control
String workflowId
workflowId of the external workflow execution to be
canceled.
Constraints:
Length: 1 - 256
String runId
runId of the external workflow execution to be
canceled.
Constraints:
Length: 0 - 64
Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
RequestCancelExternalWorkflowExecution decision for this
cancellation request. This information can be useful for diagnosing
problems by tracing back the chain of events leading up to this event.String control
Constraints:
Length: 0 - 32768
String domain
Constraints:
Length: 1 - 256
String workflowId
Constraints:
Length: 1 - 256
String runId
Constraints:
Length: 0 - 64
String taskToken
taskToken of the ActivityTask.
taskToken is generated by the service and
should be treated as an opaque value. If the task is passed to another
process, its taskToken must also be passed. This enables
it to provide its progress and respond with results.
Constraints:
Length: 1 - 1024
String details
Constraints:
Length: 0 - 32768
String taskToken
taskToken of the ActivityTask. taskToken is generated by the service and should be
treated as an opaque value. If the task is passed to another process,
its taskToken must also be passed. This enables it to
provide its progress and respond with results.
Constraints:
Length: 1 - 1024
String result
Constraints:
Length: 0 - 32768
String taskToken
taskToken of the ActivityTask. taskToken is generated by the service and should be
treated as an opaque value. If the task is passed to another process,
its taskToken must also be passed. This enables it to
provide its progress and respond with results.
Constraints:
Length: 1 - 1024
String reason
Constraints:
Length: 0 - 256
String details
Constraints:
Length: 0 - 32768
String taskToken
taskToken from the DecisionTask.
taskToken is generated by the service and
should be treated as an opaque value. If the task is passed to another
process, its taskToken must also be passed. This enables
it to provide its progress and respond with results.
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> decisions
String executionContext
Constraints:
Length: 0 - 32768
String runId
runId of a workflow execution. This ID is generated
by the service and can be used to uniquely identify the workflow
execution within a domain.
Constraints:
Length: 1 - 64
ActivityType activityType
String activityId
activityId of the activity task.
The specified string must not start or end with whitespace. It must
not contain a : (colon), / (slash),
| (vertical bar), or any control characters
( - | - ). Also, it must not contain the
literal string "arn".
Constraints:
Length: 1 - 256
String control
Constraints:
Length: 0 - 32768
String input
Constraints:
Length: 0 - 32768
String scheduleToCloseTimeout
The duration is
specified in seconds; an integer greater than or equal to 0. The value
"NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList taskList
defaultTaskList
registered with the activity type will be used. The specified string must not start or end
with whitespace. It must not contain a : (colon),
/ (slash), | (vertical bar), or any control
characters ( - | - ). Also, it must not
contain the literal string "arn".
String taskPriority
Integer.MIN_VALUE (-2147483648) to
Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
String scheduleToStartTimeout
The duration is specified in
seconds; an integer greater than or equal to 0. The value "NONE" can
be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String startToCloseTimeout
The duration is specified in seconds;
an integer greater than or equal to 0. The value "NONE" can be used to
specify unlimited duration.
Constraints:
Length: 0 - 8
String heartbeatTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
ActivityType activityType
ScheduleActivityTask
decision that failed.String activityId
ScheduleActivityTask
decision that failed.
Constraints:
Length: 1 - 256
String cause
Constraints:
Allowed Values: ACTIVITY_TYPE_DEPRECATED, ACTIVITY_TYPE_DOES_NOT_EXIST, ACTIVITY_ID_ALREADY_IN_USE, OPEN_ACTIVITIES_LIMIT_EXCEEDED, ACTIVITY_CREATION_RATE_EXCEEDED, DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_TASK_LIST_UNDEFINED, DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED, DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED, OPERATION_NOT_PERMITTED
Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision that resulted in the scheduling of this activity task.
This information can be useful for diagnosing problems by tracing back
the chain of events leading up to this event.String id
id of the AWS Lambda task.
The specified string must not start or end with whitespace. It must
not contain a : (colon), / (slash),
| (vertical bar), or any control characters
( - | - ). Also, it must not contain the
literal string "arn".
Constraints:
Length: 1 - 256
String name
Constraints:
Length: 1 - 64
String input
Constraints:
Length: 1 - 32768
String startToCloseTimeout
Constraints:
Length: 0 - 8
String id
Constraints:
Length: 1 - 256
String name
Constraints:
Length: 1 - 64
String cause
Constraints:
Allowed Values: ID_ALREADY_IN_USE, OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED, LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED, LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION
Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision that resulted in the scheduling of this AWS Lambda
function. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.String workflowId
workflowId of the workflow execution
to be signaled.
Constraints:
Length: 1 - 256
String runId
runId of the workflow execution to be signaled.
Constraints:
Length: 0 - 64
String signalName
Constraints:
Length: 1 - 256
String input
Constraints:
Length: 0 - 32768
String control
Constraints:
Length: 0 - 32768
String workflowId
workflowId of the external workflow execution that
the signal was being delivered to.
Constraints:
Length: 1 - 256
String runId
runId of the external workflow execution that the
signal was being delivered to.
Constraints:
Length: 0 - 64
String cause
Constraints:
Allowed Values: UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION, SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED
Long initiatedEventId
SignalExternalWorkflowExecutionInitiated
event corresponding to the
SignalExternalWorkflowExecution decision to request this
signal. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
SignalExternalWorkflowExecution decision for this signal.
This information can be useful for diagnosing problems by tracing back
the chain of events leading up to this event.String control
String workflowId
workflowId of the external workflow execution.
Constraints:
Length: 1 - 256
String runId
runId of the external workflow execution to send the
signal to.
Constraints:
Length: 0 - 64
String signalName
Constraints:
Length: 1 - 256
String input
Constraints:
Length: 0 - 32768
Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
SignalExternalWorkflowExecution decision for this signal.
This information can be useful for diagnosing problems by tracing back
the chain of events leading up to this event.String control
Constraints:
Length: 0 - 32768
String domain
Constraints:
Length: 1 - 256
String workflowId
Constraints:
Length: 1 - 256
String runId
Constraints:
Length: 0 - 64
String signalName
Constraints:
Length: 1 - 256
String input
WorkflowExecutionSignaled event in
the target workflow execution's history.
Constraints:
Length: 0 - 32768
WorkflowType workflowType
String workflowId
workflowId of the workflow
execution. The specified string must not start or end with
whitespace. It must not contain a : (colon),
/ (slash), | (vertical bar), or any control
characters ( - | - ). Also, it must not
contain the literal string "arn".
Constraints:
Length: 1 - 256
String control
Constraints:
Length: 0 - 32768
String input
Constraints:
Length: 0 - 32768
String executionStartToCloseTimeout
The duration is specified in seconds; an integer
greater than or equal to 0. The value "NONE" can be used to specify
unlimited duration.
Constraints:
Length: 0 - 8
TaskList taskList
The specified string must not start or end with
whitespace. It must not contain a : (colon),
/ (slash), | (vertical bar), or any control
characters ( - | - ). Also, it must not
contain the literal string "arn".
String taskPriority
Integer.MIN_VALUE (-2147483648) to
Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
String taskStartToCloseTimeout
defaultTaskStartToCloseTimout specified when registering
the workflow type using RegisterWorkflowType. The duration
is specified in seconds; an integer greater than or equal to 0. The
value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
String lambdaRole
Constraints:
Length: 1 - 1224
WorkflowType workflowType
StartChildWorkflowExecution decision that failed.String cause
Constraints:
Allowed Values: WORKFLOW_TYPE_DOES_NOT_EXIST, WORKFLOW_TYPE_DEPRECATED, OPEN_CHILDREN_LIMIT_EXCEEDED, OPEN_WORKFLOWS_LIMIT_EXCEEDED, CHILD_CREATION_RATE_EXCEEDED, WORKFLOW_ALREADY_RUNNING, DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_TASK_LIST_UNDEFINED, DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_CHILD_POLICY_UNDEFINED, OPERATION_NOT_PERMITTED
String workflowId
workflowId of the child workflow execution.
Constraints:
Length: 1 - 256
Long initiatedEventId
StartChildWorkflowExecutionInitiated event
corresponding to the StartChildWorkflowExecution decision
to start this child workflow execution. This information can be useful
for diagnosing problems by tracing back the chain of events leading up
to this event.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
StartChildWorkflowExecution decision to request this
child workflow execution. This information can be useful for
diagnosing problems by tracing back the cause of events.String control
String workflowId
workflowId of the child workflow execution.
Constraints:
Length: 1 - 256
WorkflowType workflowType
String control
Constraints:
Length: 0 - 32768
String input
Constraints:
Length: 0 - 32768
String executionStartToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList taskList
String taskPriority
Integer.MIN_VALUE (-2147483648) to
Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
StartChildWorkflowExecution decision to request this
child workflow execution. This information can be useful for
diagnosing problems by tracing back the cause of events.String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
String taskStartToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
String lambdaRole
Constraints:
Length: 1 - 1224
Long scheduledEventId
LambdaFunctionScheduled event that was
recorded when this AWS Lambda function was scheduled. This information
can be useful for diagnosing problems by tracing back the chain of
events leading up to this event.String cause
Constraints:
Allowed Values: ASSUME_ROLE_FAILED
String message
Constraints:
Length: 0 - 1728
String timerId
The specified string
must not start or end with whitespace. It must not contain a
: (colon), / (slash), |
(vertical bar), or any control characters ( - | -
). Also, it must not contain the literal string "arn".
Constraints:
Length: 1 - 256
String control
Constraints:
Length: 0 - 32768
String startToFireTimeout
The duration is specified in seconds; an integer greater than or equal to 0.
Constraints:
Length: 1 - 8
String timerId
StartTimer decision that
failed.
Constraints:
Length: 1 - 256
String cause
Constraints:
Allowed Values: TIMER_ID_ALREADY_IN_USE, OPEN_TIMERS_LIMIT_EXCEEDED, TIMER_CREATION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED
Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the StartTimer
decision for this activity task. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.String domain
Constraints:
Length: 1 - 256
String workflowId
workflowId at
the same time. The specified string must not start or end with
whitespace. It must not contain a : (colon),
/ (slash), | (vertical bar), or any control
characters ( - | - ). Also, it must not
contain the literal string "arn".
Constraints:
Length: 1 - 256
WorkflowType workflowType
TaskList taskList
defaultTaskList
specified when registering the workflow type. The specified string must not start
or end with whitespace. It must not contain a : (colon),
/ (slash), | (vertical bar), or any control
characters ( - | - ). Also, it must not
contain the literal string "arn".
String taskPriority
Integer.MIN_VALUE (-2147483648) to
Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
String input
input is made available to the new workflow execution in
the WorkflowExecutionStarted history event.
Constraints:
Length: 0 - 32768
String executionStartToCloseTimeout
The duration is specified in seconds; an integer
greater than or equal to 0. Exceeding this limit will cause the
workflow execution to time out. Unlike some of the other timeout
parameters in Amazon SWF, you cannot specify a value of "NONE" for
this timeout; there is a one-year max limit on the time that a
workflow execution can run.
Constraints:
Length: 0 - 8
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
String taskStartToCloseTimeout
defaultTaskStartToCloseTimout specified when registering
the workflow type using RegisterWorkflowType. The duration
is specified in seconds; an integer greater than or equal to 0. The
value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
String lambdaRole
Constraints:
Length: 1 - 1224
String tag
Constraints:
Length: 1 - 256
String name
Constraints:
Length: 1 - 256
String domain
Constraints:
Length: 1 - 256
String workflowId
Constraints:
Length: 1 - 256
String runId
Constraints:
Length: 0 - 64
String reason
Constraints:
Length: 0 - 256
String details
Constraints:
Length: 0 - 32768
String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
String timerId
Constraints:
Length: 1 - 256
Long startedEventId
TimerStarted event that was recorded when
this timer was started. This information can be useful for diagnosing
problems by tracing back the chain of events leading up to this event.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the CancelTimer
decision to cancel this timer. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.String timerId
Constraints:
Length: 1 - 256
Long startedEventId
TimerStarted event that was recorded when
this timer was started. This information can be useful for diagnosing
problems by tracing back the chain of events leading up to this event.String timerId
Constraints:
Length: 1 - 256
String control
Constraints:
Length: 0 - 32768
String startToFireTimeout
The duration is specified in seconds; an integer greater than or equal to 0.
Constraints:
Length: 1 - 8
Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the StartTimer
decision for this activity task. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.String details
Constraints:
Length: 0 - 32768
Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
CancelWorkflowExecution decision for this cancellation
request. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.WorkflowExecution externalWorkflowExecution
Long externalInitiatedEventId
RequestCancelExternalWorkflowExecutionInitiated event
corresponding to the
RequestCancelExternalWorkflowExecution decision to cancel
this workflow execution.The source event with this ID can be found in
the history of the source workflow execution. This information can be
useful for diagnosing problems by tracing back the chain of events
leading up to this event.String cause
Constraints:
Allowed Values: CHILD_POLICY_APPLIED
String result
Constraints:
Length: 0 - 32768
Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
CompleteWorkflowExecution decision to complete this
execution. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.String taskStartToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 1 - 8
String executionStartToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 1 - 8
TaskList taskList
String taskPriority
Integer.MIN_VALUE (-2147483648) to
Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
String lambdaRole
Constraints:
Length: 1 - 1224
String input
Constraints:
Length: 0 - 32768
Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
ContinueAsNewWorkflowExecution decision that started this
execution. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.String newExecutionRunId
runId of the new workflow execution.
Constraints:
Length: 1 - 64
String executionStartToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList taskList
String taskPriority
String taskStartToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
WorkflowType workflowType
String lambdaRole
Constraints:
Length: 1 - 1224
WorkflowExecutionInfo executionInfo
WorkflowExecutionConfiguration executionConfiguration
WorkflowExecutionOpenCounts openCounts
Date latestActivityTaskTimestamp
String latestExecutionContext
Constraints:
Length: 0 - 32768
String reason
Constraints:
Length: 0 - 256
String details
Constraints:
Length: 0 - 32768
Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
FailWorkflowExecution decision to fail this execution.
This information can be useful for diagnosing problems by tracing back
the chain of events leading up to this event.String workflowId
Constraints:
Length: 1 - 256
WorkflowExecution execution
WorkflowType workflowType
Date startTimestamp
Date closeTimestamp
String executionStatus
Constraints:
Allowed Values: OPEN, CLOSED
String closeStatus
COMPLETED: the execution
was successfully completed.CANCELED: the
execution was canceled.Cancellation allows the implementation to
gracefully clean up before the execution is closed.TERMINATED: the execution was force terminated.FAILED: the execution failed to complete.TIMED_OUT: the execution did not complete in the
alloted time and was automatically timed out.CONTINUED_AS_NEW: the execution is logically
continued. This means the current execution was completed and a new
execution was started to carry on the workflow.
Constraints:
Allowed Values: COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT
WorkflowExecution parent
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
Boolean cancelRequested
com.amazonaws.internal.ListWithAutoConstructFlag<T> executionInfos
String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
Integer openActivityTasks
Constraints:
Range: 0 -
Integer openDecisionTasks
Constraints:
Range: 0 - 1
Integer openTimers
Constraints:
Range: 0 -
Integer openChildWorkflowExecutions
Constraints:
Range: 0 -
Integer openLambdaFunctions
Constraints:
Range: 0 -
String signalName
Constraints:
Length: 1 - 256
String input
Constraints:
Length: 0 - 32768
WorkflowExecution externalWorkflowExecution
Long externalInitiatedEventId
SignalExternalWorkflowExecutionInitiated
event corresponding to the SignalExternalWorkflow
decision to signal this workflow execution.The source event with this
ID can be found in the history of the source workflow execution. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event. This field is set only if
the signal was initiated by another workflow execution.String input
Constraints:
Length: 0 - 32768
String executionStartToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String taskStartToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
TaskList taskList
WorkflowType workflowType
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
String taskPriority
String continuedExecutionRunId
ContinueAsNewWorkflowExecution decision, then it contains
the runId of the previous workflow execution that was
closed and continued as this execution.
Constraints:
Length: 0 - 64
WorkflowExecution parentWorkflowExecution
Long parentInitiatedEventId
StartChildWorkflowExecutionInitiated event
corresponding to the StartChildWorkflowExecution decision
to start this workflow execution. The source event with this ID can be
found in the history of the source workflow execution. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.String lambdaRole
Constraints:
Length: 1 - 1224
String reason
Constraints:
Length: 0 - 256
String details
Constraints:
Length: 0 - 32768
String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
String cause
Constraints:
Allowed Values: CHILD_POLICY_APPLIED, EVENT_LIMIT_EXCEEDED, OPERATOR_INITIATED
String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE
String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
String name
Constraints:
Length: 1 - 256
String version
Constraints:
Length: 1 - 64
String defaultTaskStartToCloseTimeout
StartChildWorkflowExecution decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
String defaultExecutionStartToCloseTimeout
StartChildWorkflowExecution decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList defaultTaskList
StartChildWorkflowExecution decision.String defaultTaskPriority
StartChildWorkflowExecution decision. Valid values are
integers that range from Java's Integer.MIN_VALUE
(-2147483648) to Integer.MAX_VALUE (2147483647). Higher
numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
String defaultChildPolicy
StartChildWorkflowExecution decision. The supported child policies are:
WorkflowExecutionCancelRequested event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
String defaultLambdaRole
Constraints:
Length: 1 - 1224
WorkflowTypeInfo typeInfo
The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.
WorkflowTypeConfiguration configuration
WorkflowType workflowType
String status
Constraints:
Allowed Values: REGISTERED, DEPRECATED
String description
Constraints:
Length: 0 - 1024
Date creationDate
Date deprecationDate
com.amazonaws.internal.ListWithAutoConstructFlag<T> typeInfos
String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
String topicArn
The ARN of the topic whose access control policy you wish to modify.
String label
A unique identifier for the new policy statement.
com.amazonaws.internal.SdkInternalList<T> aWSAccountIds
The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.
com.amazonaws.internal.SdkInternalList<T> actionNames
The action you want to allow for the specified principal(s).
Valid values: any Amazon SNS action name.
String topicArn
The ARN of the topic for which you wish to confirm a subscription.
String token
Short-lived token sent to an endpoint during the Subscribe
action.
String authenticateOnUnsubscribe
Disallows unauthenticated unsubscribes of the subscription. If the value
of this parameter is 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
The ARN of the created subscription.
String name
Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.
String platform
The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).
com.amazonaws.internal.SdkInternalMap<K,V> attributes
For a list of attributes, see SetPlatformApplicationAttributes
String platformApplicationArn
PlatformApplicationArn is returned.
String platformApplicationArn
PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
String token
Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.
String customUserData
Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
For a list of attributes, see SetEndpointAttributes.
String endpointArn
EndpointArn returned from CreateEndpoint action.
String name
The name of the topic you want to create.
Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
String topicArn
The Amazon Resource Name (ARN) assigned to the created topic.
String endpointArn
EndpointArn of endpoint to delete.
String platformApplicationArn
PlatformApplicationArn of platform application object to delete.
String topicArn
The ARN of the topic you want to delete.
String endpointArn
EndpointArn for mobile app and device.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
Attributes for endpoint.
String endpointArn
EndpointArn for GetEndpointAttributes input.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
Attributes include the following:
CustomUserData -- arbitrary user data to associate with
the endpoint. Amazon SNS does not use this data. The data must be in
UTF-8 format and less than 2KB.Enabled -- flag that enables/disables delivery to the
endpoint. Amazon SNS will set this to false when a notification service
indicates to Amazon SNS that the endpoint is invalid. Users can set it
back to true, typically after updating Token.Token -- device token, also referred to as a
registration id, for an app and mobile device. This is returned from the
notification service when an app and mobile device are registered with
the notification service.String platformApplicationArn
PlatformApplicationArn for GetPlatformApplicationAttributesInput.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
Attributes include the following:
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
The ARN of the subscription whose properties you want to get.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
A map of the subscription's attributes. Attributes in this map include the following:
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
The ARN of the topic whose properties you want to get.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
A map of the topic's attributes. Attributes in this map include the following:
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
PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.
String nextToken
NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.
com.amazonaws.internal.SdkInternalList<T> endpoints
Endpoints returned for ListEndpointsByPlatformApplication action.
String nextToken
NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.
String nextToken
NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.
com.amazonaws.internal.SdkInternalList<T> platformApplications
Platform applications returned when calling ListPlatformApplications action.
String nextToken
NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.
com.amazonaws.internal.SdkInternalList<T> subscriptions
A list of subscriptions.
String nextToken
Token to pass along to the next ListSubscriptionsByTopic
request. This element is returned if there are more subscriptions to
retrieve.
String nextToken
Token returned by the previous ListSubscriptions request.
com.amazonaws.internal.SdkInternalList<T> subscriptions
A list of subscriptions.
String nextToken
Token to pass along to the next ListSubscriptions request.
This element is returned if there are more subscriptions to retrieve.
String nextToken
Token returned by the previous ListTopics request.
com.amazonaws.internal.SdkInternalList<T> topics
A list of topic ARNs.
String nextToken
Token to pass along to the next ListTopics request. This
element is returned if there are additional topics to retrieve.
String dataType
Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.
String stringValue
Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
ByteBuffer binaryValue
Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
String platformApplicationArn
PlatformApplicationArn for platform application object.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
Attributes for platform application object.
String topicArn
The topic you want to publish to.
String targetArn
Either TopicArn or EndpointArn, but not both.
String message
The message you want to send to the topic.
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
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
String messageStructure
Set 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
com.amazonaws.internal.SdkInternalMap<K,V> messageAttributes
Message attributes for Publish action.
String messageId
Unique identifier assigned to the published message.
Length Constraint: Maximum 100 characters
String endpointArn
EndpointArn used for SetEndpointAttributes action.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
A map of the endpoint attributes. Attributes in this map include the following:
CustomUserData -- arbitrary user data to associate with
the endpoint. Amazon SNS does not use this data. The data must be in
UTF-8 format and less than 2KB.Enabled -- flag that enables/disables delivery to the
endpoint. Amazon SNS will set this to false when a notification service
indicates to Amazon SNS that the endpoint is invalid. Users can set it
back to true, typically after updating Token.Token -- device token, also referred to as a
registration id, for an app and mobile device. This is returned from the
notification service when an app and mobile device are registered with
the notification service.String platformApplicationArn
PlatformApplicationArn for SetPlatformApplicationAttributes action.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
A map of the platform application attributes. Attributes in this map include the following:
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
The ARN of the subscription to modify.
String attributeName
The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.
Valid values: DeliveryPolicy |
RawMessageDelivery
String attributeValue
The new value for the attribute in JSON format.
String topicArn
The ARN of the topic to modify.
String attributeName
The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.
Valid values: Policy | DisplayName |
DeliveryPolicy
String attributeValue
The new value for the attribute.
String topicArn
The ARN of the topic you want to subscribe to.
String protocol
The protocol you want to use. Supported protocols include:
http -- delivery of JSON-encoded message via HTTP POSThttps -- delivery of JSON-encoded message via HTTPS POST
email -- 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
The endpoint that you want to receive notifications. Endpoints vary by protocol:
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 address
email-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
The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).
String subscriptionArn
The subscription's ARN.
String owner
The subscription's owner.
String protocol
The subscription's protocol.
String endpoint
The subscription's endpoint (format depends on the protocol).
String topicArn
The ARN of the subscription's topic.
String topicArn
The topic's ARN.
String subscriptionArn
The ARN of the subscription to be deleted.
String queueUrl
The URL of the Amazon SQS queue to take action on.
String label
The unique identification of the permission you're setting (e.g.,
AliceSendMessage). Constraints: Maximum 80 characters;
alphanumeric characters, hyphens (-), and underscores (_) are allowed.
com.amazonaws.internal.SdkInternalList<T> aWSAccountIds
The AWS account number of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon SQS Developer Guide.
com.amazonaws.internal.SdkInternalList<T> actions
The action the client wants to allow for the specified principal. The
following are valid values:
* | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl
. For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide.
Specifying SendMessage, DeleteMessage, or
ChangeMessageVisibility for the ActionName.n
also grants permissions for the corresponding batch versions of those
actions: SendMessageBatch, DeleteMessageBatch,
and ChangeMessageVisibilityBatch.
String queueUrl
The URL of the Amazon SQS queue to take action on.
com.amazonaws.internal.SdkInternalList<T> entries
A list of receipt handles of the messages for which the visibility timeout must be changed.
String id
An identifier for this particular receipt handle. This is used to
communicate the result. Note that the Ids of a batch request
need to be unique within the request.
String receiptHandle
A receipt handle.
Integer visibilityTimeout
The new value (in seconds) for the message's visibility timeout.
com.amazonaws.internal.SdkInternalList<T> successful
A list of ChangeMessageVisibilityBatchResultEntry items.
com.amazonaws.internal.SdkInternalList<T> failed
A list of BatchResultErrorEntry items.
String id
Represents a message whose visibility timeout has been changed successfully.
String queueUrl
The URL of the Amazon SQS queue to take action on.
String receiptHandle
The receipt handle associated with the message whose visibility timeout should be changed. This parameter is returned by the ReceiveMessage action.
Integer visibilityTimeout
The new value (in seconds - from 0 to 43200 - maximum 12 hours) for the message's visibility timeout.
String queueName
The name for the queue to be created.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special
request parameters the CreateQueue action uses:
DelaySeconds - The time in seconds that the delivery of
all messages in the queue will be delayed. An integer from 0 to 900 (15
minutes). The default for this attribute is 0 (zero).MaximumMessageSize - The limit of how many bytes a
message can contain before Amazon SQS rejects it. An integer from 1024
bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this
attribute is 262144 (256 KiB).MessageRetentionPeriod - The number of seconds Amazon
SQS retains a message. Integer representing seconds, from 60 (1 minute)
to 1209600 (14 days). The default for this attribute is 345600 (4 days).Policy - The queue's policy. A valid AWS policy. For
more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.ReceiveMessageWaitTimeSeconds - The time for which a
ReceiveMessage call will wait for a message to arrive. An integer
from 0 to 20 (seconds). The default for this attribute is 0.VisibilityTimeout - The visibility timeout for the
queue. An integer from 0 to 43200 (12 hours). The default for this
attribute is 30. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.String queueUrl
The URL for the created Amazon SQS queue.
String queueUrl
The URL of the Amazon SQS queue to take action on.
com.amazonaws.internal.SdkInternalList<T> entries
A list of receipt handles for the messages to be deleted.
com.amazonaws.internal.SdkInternalList<T> successful
A list of DeleteMessageBatchResultEntry items.
com.amazonaws.internal.SdkInternalList<T> failed
A list of BatchResultErrorEntry items.
String id
Represents a successfully deleted message.
String queueUrl
The URL of the Amazon SQS queue to take action on.
String queueUrl
The URL of the Amazon SQS queue to take action on.
com.amazonaws.internal.SdkInternalList<T> attributeNames
A list of attributes to retrieve information for.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
A map of attributes to the respective values.
String queueUrl
The URL for the queue.
String queueUrl
com.amazonaws.internal.SdkInternalList<T> queueUrls
String queueNamePrefix
A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.
com.amazonaws.internal.SdkInternalList<T> queueUrls
A list of queue URLs, up to 1000 entries.
String messageId
A unique identifier for the message. Message IDs are considered unique across all AWS accounts for an extended period of time.
String receiptHandle
An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.
String mD5OfBody
An MD5 digest of the non-URL-encoded message body string.
String body
The message's contents (not URL-encoded).
com.amazonaws.internal.SdkInternalMap<K,V> attributes
SenderId, SentTimestamp,
ApproximateReceiveCount, and/or
ApproximateFirstReceiveTimestamp. SentTimestamp
and ApproximateFirstReceiveTimestamp are each returned as an
integer representing the epoch time in
milliseconds.
String mD5OfMessageAttributes
An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
com.amazonaws.internal.SdkInternalMap<K,V> messageAttributes
Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.
String stringValue
Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
ByteBuffer binaryValue
Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
com.amazonaws.internal.SdkInternalList<T> stringListValues
Not implemented. Reserved for future use.
com.amazonaws.internal.SdkInternalList<T> binaryListValues
Not implemented. Reserved for future use.
String dataType
Amazon SQS supports the following logical data types: String, Number, and Binary. In addition, you can append your own custom labels. For more information, see Message Attribute Data Types.
String queueUrl
The queue URL of the queue to delete the messages from when using the
PurgeQueue API.
String queueUrl
The URL of the Amazon SQS queue to take action on.
com.amazonaws.internal.SdkInternalList<T> attributeNames
A list of attributes that need to be returned along with each message.
The following lists the names and descriptions of the attributes that can be returned:
All - returns all values.ApproximateFirstReceiveTimestamp - returns the time when
the message was first received from the queue (epoch time in
milliseconds).ApproximateReceiveCount - returns the number of times a
message has been received from the queue but not deleted.SenderId - returns the AWS account number (or the IP
address, if anonymous access is allowed) of the sender.SentTimestamp - returns the time when the message was
sent to the queue (epoch time in milliseconds).com.amazonaws.internal.SdkInternalList<T> messageAttributeNames
The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name cannot start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.
When using ReceiveMessage, you can send a list of attribute
names to receive, or you can return all of the attributes by specifying
"All" or ".*" in your request. You can also use "foo.*" to return all
message attributes starting with the "foo" prefix.
Integer maxNumberOfMessages
The maximum number of messages to return. Amazon SQS never returns more messages than this value but may return fewer. Values can be from 1 to 10. Default is 1.
All of the messages are not necessarily returned.
Integer visibilityTimeout
The duration (in seconds) that the received messages are hidden from
subsequent retrieve requests after being retrieved by a
ReceiveMessage request.
Integer waitTimeSeconds
The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning. If a message is available, the call will return sooner than WaitTimeSeconds.
com.amazonaws.internal.SdkInternalList<T> messages
A list of messages.
String queueUrl
The URL of the Amazon SQS queue to take action on.
String label
The identification of the permission to remove. This is the label added with the AddPermission action.
String queueUrl
The URL of the Amazon SQS queue to take action on.
com.amazonaws.internal.SdkInternalList<T> entries
A list of SendMessageBatchRequestEntry items.
String id
An identifier for the message in this batch. This is used to communicate
the result. Note that the Ids of a batch request need to be
unique within the request.
String messageBody
Body of the message.
Integer delaySeconds
The number of seconds for which the message has to be delayed.
com.amazonaws.internal.SdkInternalMap<K,V> messageAttributes
Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.
com.amazonaws.internal.SdkInternalList<T> successful
A list of SendMessageBatchResultEntry items.
com.amazonaws.internal.SdkInternalList<T> failed
A list of BatchResultErrorEntry items with the error detail about each message that could not be enqueued.
String id
An identifier for the message in this batch.
String messageId
An identifier for the message.
String mD5OfMessageBody
An MD5 digest of the non-URL-encoded message body string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
String mD5OfMessageAttributes
An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message batch correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
String queueUrl
The URL of the Amazon SQS queue to take action on.
String messageBody
The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding important note.
Integer delaySeconds
The number of seconds (0 to 900 - 15 minutes) to delay a specific
message. Messages with a positive DelaySeconds value become
available for processing after the delay time is finished. If you don't
specify a value, the default value for the queue applies.
com.amazonaws.internal.SdkInternalMap<K,V> messageAttributes
Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.
String mD5OfMessageBody
An MD5 digest of the non-URL-encoded message body string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
String mD5OfMessageAttributes
An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
String messageId
An element containing the message ID of the message sent to the queue. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.
String queueUrl
The URL of the Amazon SQS queue to take action on.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
A map of attributes to set.
The following lists the names, descriptions, and values of the special
request parameters the SetQueueAttributes action uses:
DelaySeconds - The time in seconds that the delivery of
all messages in the queue will be delayed. An integer from 0 to 900 (15
minutes). The default for this attribute is 0 (zero).MaximumMessageSize - The limit of how many bytes a
message can contain before Amazon SQS rejects it. An integer from 1024
bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this
attribute is 262144 (256 KiB).MessageRetentionPeriod - The number of seconds Amazon
SQS retains a message. Integer representing seconds, from 60 (1 minute)
to 1209600 (14 days). The default for this attribute is 345600 (4 days).Policy - The queue's policy. A valid AWS policy. For
more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.ReceiveMessageWaitTimeSeconds - The time for which a
ReceiveMessage call will wait for a message to arrive. An integer from 0
to 20 (seconds). The default for this attribute is 0.VisibilityTimeout - The visibility timeout for the
queue. An integer from 0 to 43200 (12 hours). The default for this
attribute is 30. For more information about visibility timeout, see
Visibility Timeout in the Amazon SQS Developer Guide.RedrivePolicy - The parameters for dead letter queue
functionality of the source queue. For more information about
RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter
Queues in the Amazon SQS Developer Guide.String activationKey
Your gateway activation key. You can obtain the activation key by sending
an HTTP GET request with redirects enabled to the gateway IP address
(port 80). The redirect URL returned in the response provides you the
activation key for your gateway in the query string parameter
activationKey. It may also include other activation-related
parameters, however, these are merely defaults -- the arguments you pass
to the ActivateGateway API call determine the actual
configuration of your gateway.
String gatewayName
String gatewayTimezone
One of the values that indicates the time zone you want to set for the gateway. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
String gatewayRegion
One of the values that indicates the region where you want to store the
snapshot backups. The gateway region specified must be the same region as
the region in your Host header in the request. For more
information about available regions and endpoints for AWS Storage
Gateway, see Regions and Endpoints in the Amazon Web Services Glossary.
Valid Values: "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2", "sa-east-1"
String gatewayType
One of the values that defines the type of gateway to activate. The type
specified is critical to all later functions of the gateway and cannot be
changed after activation. The default value is STORED.
String tapeDriveType
The value that indicates the type of tape drive to use for gateway-VTL. This field is optional.
Valid Values: "IBM-ULT3580-TD5"
String mediumChangerType
The value that indicates the type of medium changer to use for gateway-VTL. This field is optional.
Valid Values: "STK-L700", "AWS-Gateway-VTL"
String gatewayARN
String gatewayARN
com.amazonaws.internal.SdkInternalList<T> diskIds
String gatewayARN
String resourceARN
The Amazon Resource Name (ARN) of the resource you want to add tags to.
com.amazonaws.internal.SdkInternalList<T> tags
The key-value pair that represents the tag you want to add to the resource. The value can be an empty string.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.
String resourceARN
The Amazon Resource Name (ARN) of the resource you want to add tags to.
String gatewayARN
com.amazonaws.internal.SdkInternalList<T> diskIds
String gatewayARN
String gatewayARN
com.amazonaws.internal.SdkInternalList<T> diskIds
An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
String gatewayARN
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape for which archiving was canceled.
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled.
String targetARN
The Amazon Resource Name (ARN) of the volume.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
String secretToAuthenticateInitiator
The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
String initiatorName
The iSCSI initiator that connects to the target.
String secretToAuthenticateTarget
The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
String volumeARN
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
String snapshotDescription
Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field
String volumeARN
The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.
String snapshotId
The snapshot ID that is used to refer to the snapshot in future
operations such as describing snapshots (Amazon Elastic Compute Cloud API
DescribeSnapshots) or creating a volume from a snapshot
(CreateStorediSCSIVolume).
String gatewayARN
String diskId
The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.
String snapshotId
The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
Boolean preserveExistingData
Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume.
Valid Values: true, false
String targetName
The name of the iSCSI target used by initiators to connect to the target
and as a suffix for the target ARN. For example, specifying
TargetName as myvolume results in the target ARN of
arn
:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn
.1997-05.com.amazon:myvolume. The target name must be unique across all
volumes of a gateway.
String networkInterfaceId
The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.
Valid Values: A valid IP address.
String volumeARN
The Amazon Resource Name (ARN) of the configured volume.
Long volumeSizeInBytes
The size of the volume in bytes.
String targetARN
he Amazon Resource Name (ARN) of the volume target that includes the iSCSI name that initiators can use to connect to the target.
String gatewayARN
The unique Amazon Resource Name(ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and region.
Long tapeSizeInBytes
The size, in bytes, of the virtual tapes you want to create.
String clientToken
A unique identifier that you use to retry a request. If you retry a
request, use the same ClientToken you specified in the
initial request.
ClientToken prevents creating the tape
multiple times.Integer numTapesToCreate
The number of virtual tapes you want to create.
String tapeBarcodePrefix
A prefix you append to the barcode of the virtual tape you are creating. This makes a barcode unique.
com.amazonaws.internal.SdkInternalList<T> tapeARNs
A list of unique Amazon Resource Named (ARN) that represents the virtual tapes that were created.
String gatewayARN
String targetARN
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
String initiatorName
The iSCSI initiator that connects to the target.
String gatewayARN
String gatewayARN
String volumeARN
String volumeARN
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS).
String gatewayARN
The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the ListGateways operation to return a list of gateways for your account and region.
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape to delete.
String tapeARN
The Amazon Resource Name (ARN) of the deleted virtual tape.
String volumeARN
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
String volumeARN
The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.
String gatewayARN
String gatewayARN
Long averageUploadRateLimitInBitsPerSec
The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the upload rate limit is not set.
Long averageDownloadRateLimitInBitsPerSec
The average download bandwidth rate limit in bits per second. This field does not appear in the response if the download rate limit is not set.
com.amazonaws.internal.SdkInternalList<T> volumeARNs
com.amazonaws.internal.SdkInternalList<T> cachediSCSIVolumes
An array of objects where each object contains metadata about one cached volume.
String gatewayARN
String gatewayARN
com.amazonaws.internal.SdkInternalList<T> diskIds
Long cacheAllocatedInBytes
Double cacheUsedPercentage
Double cacheDirtyPercentage
Double cacheHitPercentage
Double cacheMissPercentage
String targetARN
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
com.amazonaws.internal.SdkInternalList<T> chapCredentials
An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:
InitiatorName: The iSCSI initiator that connects to the target.
SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
TargetARN: The Amazon Resource Name (ARN) of the storage volume.
String gatewayARN
String gatewayARN
String gatewayId
The gateway ID.
String gatewayName
The gateway name.
String gatewayTimezone
One of the values that indicates the time zone configured for the gateway.
String gatewayState
One of the values that indicates the operating state of the gateway.
com.amazonaws.internal.SdkInternalList<T> gatewayNetworkInterfaces
A NetworkInterface array that contains descriptions of the gateway network interfaces.
String gatewayType
The type of the gateway.
String nextUpdateAvailabilityDate
The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.
String lastSoftwareUpdate
The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response.
String gatewayARN
String volumeARN
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
com.amazonaws.internal.SdkInternalList<T> volumeARNs
An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must from the same gateway. Use ListVolumes to get volume ARNs for a gateway.
com.amazonaws.internal.SdkInternalList<T> storediSCSIVolumes
com.amazonaws.internal.SdkInternalList<T> tapeARNs
Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.
String marker
An opaque string that indicates the position at which to begin describing virtual tapes.
Integer limit
Specifies that the number of virtual tapes descried be limited to the specified number.
com.amazonaws.internal.SdkInternalList<T> tapeArchives
An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name(ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description and tape barcode.
String marker
An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.
String gatewayARN
com.amazonaws.internal.SdkInternalList<T> tapeRecoveryPointInfos
An array of TapeRecoveryPointInfos that are available for the specified gateway.
String marker
An opaque string that indicates the position at which the virtual tape recovery points that were listed for description ended.
Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response.
String gatewayARN
com.amazonaws.internal.SdkInternalList<T> tapeARNs
Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, AWS Storage Gateway returns a description of all virtual tapes associated with the specified gateway.
String marker
A marker value, obtained in a previous call to DescribeTapes
. This marker indicates which page of results to retrieve.
If not specified, the first page of results is retrieved.
Integer limit
Specifies that the number of virtual tapes described be limited to the specified number.
com.amazonaws.internal.SdkInternalList<T> tapes
An array of virtual tape descriptions.
String marker
An opaque string which can be used as part of a subsequent DescribeTapes call to retrieve the next page of results.
If a response does not contain a marker, then there are no more results to be retrieved.
String gatewayARN
String gatewayARN
com.amazonaws.internal.SdkInternalList<T> diskIds
Long uploadBufferUsedInBytes
Long uploadBufferAllocatedInBytes
String gatewayARN
com.amazonaws.internal.SdkInternalList<T> vTLDeviceARNs
An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.
String marker
An opaque string that indicates the position at which to begin describing the VTL devices.
Integer limit
Specifies that the number of VTL devices described be limited to the specified number.
String gatewayARN
com.amazonaws.internal.SdkInternalList<T> vTLDevices
An array of VTL device objects composed of the Amazon Resource Name(ARN) of the VTL devices.
String marker
An opaque string that indicates the position at which the VTL devices that were fetched for description ended. Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this field does not appear in the response.
String gatewayARN
String gatewayARN
com.amazonaws.internal.SdkInternalList<T> diskIds
An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.
Long workingStorageUsedInBytes
The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.
Long workingStorageAllocatedInBytes
The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.
String targetARN
Specifies the unique Amazon Resource Name(ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.
String networkInterfaceId
The network interface identifier of the VTL device.
Integer networkInterfacePort
The port used to communicate with iSCSI VTL device targets.
Boolean chapEnabled
Indicates whether mutual CHAP is enabled for the iSCSI target.
String gatewayARN
String gatewayARN
The unique Amazon Resource Name of the disabled gateway.
com.amazonaws.internal.SdkInternalList<T> gateways
String marker
String gatewayARN
String gatewayARN
com.amazonaws.internal.SdkInternalList<T> disks
String resourceARN
The Amazon Resource Name (ARN) of the resource for which you want to list tags.
String marker
An opaque string that indicates the position at which to begin returning the list of tags.
Integer limit
Specifies that the list of tags returned be limited to the specified number of items.
String resourceARN
he Amazon Resource Name (ARN) of the resource for which you want to list tags.
String marker
An opaque string that indicates the position at which to stop returning the list of tags.
com.amazonaws.internal.SdkInternalList<T> tags
An array that contains the tags for the specified resource.
String volumeARN
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes for the gateway.
com.amazonaws.internal.SdkInternalList<T> initiators
The host names and port numbers of all iSCSI initiators that are connected to the gateway.
String gatewayARN
String gatewayARN
com.amazonaws.internal.SdkInternalList<T> volumeRecoveryPointInfos
String gatewayARN
String marker
A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.
Integer limit
Specifies that the list of volumes returned be limited to the specified number of items.
String gatewayARN
String marker
com.amazonaws.internal.SdkInternalList<T> volumeInfos
String ipv4Address
The Internet Protocol version 4 (IPv4) address of the interface.
String macAddress
The Media Access Control (MAC) address of the interface.
String ipv6Address
The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported.
String resourceARN
The Amazon Resource Name (ARN) of the resource you want to remove the tags from.
com.amazonaws.internal.SdkInternalList<T> tagKeys
The keys of the tags you want to remove from the specified resource. A tag is composed of a key/value pair.
String resourceARN
The Amazon Resource Name (ARN) of the resource that the tags were removed from.
String gatewayARN
String gatewayARN
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).
String gatewayARN
The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the ListGateways operation to return a list of gateways for your account and region.
You retrieve archived virtual tapes to only one gateway and the gateway must be a gateway-VTL.
String tapeARN
The Amazon Resource Name (ARN) of the retrieved virtual tape.
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was retrieved.
String gatewayARN
String gatewayARN
String gatewayARN
String gatewayARN
String volumeARN
String volumeId
String volumeType
String volumeStatus
Long volumeSizeInBytes
Double volumeProgress
String volumeDiskId
String sourceSnapshotId
Boolean preservedExistingData
VolumeiSCSIAttributes volumeiSCSIAttributes
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape.
String tapeBarcode
The barcode that identifies a specific virtual tape.
Long tapeSizeInBytes
The size, in bytes, of the virtual tape.
String tapeStatus
The current state of the virtual tape.
String vTLDevice
The virtual tape library (VTL) device that the virtual tape is associated with.
Double progress
For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.
Range: 0 (not started) to 100 (complete).
String tapeARN
The Amazon Resource Name (ARN) of an archived virtual tape.
String tapeBarcode
The barcode that identifies the archived virtual tape.
Long tapeSizeInBytes
The size, in bytes, of the archived virtual tape.
Date completionTime
The time that the archiving of the virtual tape was completed.
The string format of the completion time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
String retrievedTo
The Amazon Resource Name (ARN) of the gateway-VTL that the virtual tape is being retrieved to.
The virtual tape is retrieved from the virtual tape shelf (VTS).
String tapeStatus
The current state of the archived virtual tape.
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape.
Date tapeRecoveryPointTime
The time when the point-in-time view of the virtual tape was replicated for later recovery.
The string format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
Long tapeSizeInBytes
The size, in bytes, of the virtual tapes to recover.
String tapeStatus
String gatewayARN
Long averageUploadRateLimitInBitsPerSec
The average upload bandwidth rate limit in bits per second.
Long averageDownloadRateLimitInBitsPerSec
The average download bandwidth rate limit in bits per second.
String gatewayARN
String targetARN
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN.
String secretToAuthenticateInitiator
The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
String initiatorName
The iSCSI initiator that connects to the target.
String secretToAuthenticateTarget
The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
Byte constraints: Minimum bytes of 12. Maximum bytes of 16.
String gatewayARN
String gatewayARN
String gatewayARN
Integer hourOfDay
The hour component of the maintenance start time represented as hh, where hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway.
Integer minuteOfHour
The minute component of the maintenance start time represented as mm, where mm is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.
Integer dayOfWeek
The maintenance start time day of the week.
String gatewayARN
String volumeARN
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
Integer startAt
The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.
Integer recurrenceInHours
Frequency of snapshots. Specify the number of hours between snapshots.
String description
Optional description of the snapshot that overwrites the existing description.
String volumeARN
String vTLDeviceARN
The Amazon Resource Name (ARN) of the medium changer you have selected.
String targetARN
The Amazon Resource Name (ARN) of the volume target.
String networkInterfaceId
The network interface identifier.
Integer networkInterfacePort
The port used to communicate with iSCSI targets.
Integer lunNumber
The logical disk number.
Boolean chapEnabled
Indicates whether mutual CHAP is enabled for the iSCSI target.
String vTLDeviceARN
Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).
String vTLDeviceType
String vTLDeviceVendor
String vTLDeviceProductIdentifier
DeviceiSCSIAttributes deviceiSCSIAttributes
A list of iSCSI information about a VTL device.
String attachmentSetId
The ID of the attachment set. If an AttachmentSetId is not
specified, a new attachment set is created, and the ID of the set is
returned in the response. If an AttachmentSetId is
specified, the attachments are added to the specified set, if it exists.
com.amazonaws.internal.SdkInternalList<T> attachments
One or more attachments to add to the set. The limit is 3 attachments per set, and the size limit is 5 MB per attachment.
String attachmentSetId
The ID of the attachment set. If an AttachmentSetId was not
specified, a new attachment set is created, and the ID of the set is
returned in the response. If an AttachmentSetId was
specified, the attachments are added to the specified set, if it exists.
String expiryTime
The time and date when the attachment set expires.
String caseId
The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
String communicationBody
The body of an email communication to add to the support case.
com.amazonaws.internal.SdkInternalList<T> ccEmailAddresses
The email addresses in the CC line of an email to be added to the support case.
String attachmentSetId
The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling AddAttachmentsToSet
Boolean result
True if AddCommunicationToCase succeeds. Otherwise, returns an error.
String fileName
The name of the attachment file.
ByteBuffer data
The content of the attachment file.
String caseId
The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
String displayId
The ID displayed for the case in the AWS Support Center. This is a numeric string.
String subject
The subject line for the case in the AWS Support Center.
String status
The status of the case.
String serviceCode
The code for the AWS service returned by the call to DescribeServices.
String categoryCode
The category of problem for the AWS Support case.
String severityCode
The code for the severity level returned by the call to DescribeSeverityLevels.
String submittedBy
The email address of the account that submitted the case.
String timeCreated
The time that the case was case created in the AWS Support Center.
RecentCaseCommunications recentCommunications
The five most recent communications between you and AWS Support Center,
including the IDs of any attachments to the communications. Also includes
a nextToken that you can use to retrieve earlier
communications.
com.amazonaws.internal.SdkInternalList<T> ccEmailAddresses
The email addresses that receive copies of communication about the case.
String language
The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
String caseId
The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
String body
The text of the communication between the customer and AWS Support.
String submittedBy
The email address of the account that submitted the AWS Support case.
String timeCreated
The time the communication was created.
com.amazonaws.internal.SdkInternalList<T> attachmentSet
Information about the attachments to the case communication.
String subject
The title of the AWS Support case.
String serviceCode
The code for the AWS service returned by the call to DescribeServices.
String severityCode
The code for the severity level returned by the call to DescribeSeverityLevels.
The availability of severity levels depends on each customer's support subscription. In other words, your subscription may not necessarily require the urgent level of response time.
String categoryCode
The category of problem for the AWS Support case.
String communicationBody
The communication body text when you create an AWS Support case by calling CreateCase.
com.amazonaws.internal.SdkInternalList<T> ccEmailAddresses
A list of email addresses that AWS Support copies on case correspondence.
String language
The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
String issueType
The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical."
String attachmentSetId
The ID of a set of one or more attachments for the case. Create the set by using AddAttachmentsToSet.
String caseId
The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
String attachmentId
The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.
Attachment attachment
The attachment content and file name.
com.amazonaws.internal.SdkInternalList<T> caseIdList
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
String displayId
The ID displayed for a case in the AWS Support Center user interface.
String afterTime
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
String beforeTime
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
Boolean includeResolvedCases
Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
String nextToken
A resumption point for pagination.
Integer maxResults
The maximum number of results to return before paginating.
String language
The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
Boolean includeCommunications
Specifies whether communications should be included in the DescribeCases results. The default is true.
com.amazonaws.internal.SdkInternalList<T> cases
The details for the cases that match the request.
String nextToken
A resumption point for pagination.
String caseId
The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
String beforeTime
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
String afterTime
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
String nextToken
A resumption point for pagination.
Integer maxResults
The maximum number of results to return before paginating.
com.amazonaws.internal.SdkInternalList<T> communications
The communications for the case.
String nextToken
A resumption point for pagination.
com.amazonaws.internal.SdkInternalList<T> serviceCodeList
A JSON-formatted list of service codes available for AWS services.
String language
The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
com.amazonaws.internal.SdkInternalList<T> services
A JSON-formatted list of AWS services.
String language
The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
com.amazonaws.internal.SdkInternalList<T> severityLevels
The available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS.
com.amazonaws.internal.SdkInternalList<T> checkIds
The IDs of the Trusted Advisor checks.
com.amazonaws.internal.SdkInternalList<T> statuses
The refresh status of the specified Trusted Advisor checks.
String checkId
The unique identifier for the Trusted Advisor check.
String language
The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
TrustedAdvisorCheckResult result
The detailed results of the Trusted Advisor check.
String language
The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
com.amazonaws.internal.SdkInternalList<T> checks
Information about all available Trusted Advisor checks.
com.amazonaws.internal.SdkInternalList<T> checkIds
The IDs of the Trusted Advisor checks.
com.amazonaws.internal.SdkInternalList<T> summaries
The summary information for the requested Trusted Advisor checks.
com.amazonaws.internal.SdkInternalList<T> communications
The five most recent communications associated with the case.
String nextToken
A resumption point for pagination.
String checkId
The unique identifier for the Trusted Advisor check.
TrustedAdvisorCheckRefreshStatus status
The current refresh status for a check, including the amount of time until the check is eligible for refresh.
String caseId
The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
String initialCaseStatus
The status of the case when the ResolveCase request was sent.
String finalCaseStatus
The status of the case after the ResolveCase request was processed.
String code
The code for an AWS service returned by the DescribeServices
response. The Name element contains the corresponding
friendly name.
String name
The friendly name for an AWS service. The Code element
contains the corresponding code.
com.amazonaws.internal.SdkInternalList<T> categories
A list of categories that describe the type of support issue a case describes. Categories consist of a category name and a category code. Category names and codes are passed to AWS Support when you call CreateCase.
TrustedAdvisorCostOptimizingSummary costOptimizing
The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.
String id
The unique identifier for the Trusted Advisor check.
String name
The display name for the Trusted Advisor check.
String description
The description of the Trusted Advisor check, which includes the alert criteria and recommended actions (contains HTML markup).
String category
The category of the Trusted Advisor check.
com.amazonaws.internal.SdkInternalList<T> metadata
The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail for the check. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.
String checkId
The unique identifier for the Trusted Advisor check.
String status
The status of the Trusted Advisor check for which a refresh has been requested: "none", "enqueued", "processing", "success", or "abandoned".
Long millisUntilNextRefreshable
The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.
String checkId
The unique identifier for the Trusted Advisor check.
String timestamp
The time of the last refresh of the check.
String status
The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
TrustedAdvisorResourcesSummary resourcesSummary
TrustedAdvisorCategorySpecificSummary categorySpecificSummary
Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
com.amazonaws.internal.SdkInternalList<T> flaggedResources
The details about each resource listed in the check result.
String checkId
The unique identifier for the Trusted Advisor check.
String timestamp
The time of the last refresh of the check.
String status
The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
Boolean hasFlaggedResources
Specifies whether the Trusted Advisor check has flagged resources.
TrustedAdvisorResourcesSummary resourcesSummary
TrustedAdvisorCategorySpecificSummary categorySpecificSummary
Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
Double estimatedMonthlySavings
The estimated monthly savings that might be realized if the recommended actions are taken.
Double estimatedPercentMonthlySavings
The estimated percentage of savings that might be realized if the recommended actions are taken.
String status
The status code for the resource identified in the Trusted Advisor check.
String region
The AWS region in which the identified resource is located.
String resourceId
The unique identifier for the identified resource.
Boolean isSuppressed
Specifies whether the AWS resource was ignored by Trusted Advisor because it was marked as suppressed by the user.
com.amazonaws.internal.SdkInternalList<T> metadata
Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the TrustedAdvisorCheckDescription object returned by the call to DescribeTrustedAdvisorChecks. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.
Long resourcesProcessed
The number of AWS resources that were analyzed by the Trusted Advisor check.
Long resourcesFlagged
The number of AWS resources that were flagged (listed) by the Trusted Advisor check.
Long resourcesIgnored
The number of AWS resources ignored by Trusted Advisor because information was unavailable.
Long resourcesSuppressed
The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user.
Integer priority
Specifies the order in which the Rules in a
WebACL are evaluated. Rules with a lower value for
Priority are evaluated before Rules with a
higher value. The value must be a unique integer. If you add multiple
Rules to a WebACL, the values don't need to be
consecutive.
String ruleId
The RuleId for a Rule. You use
RuleId to get more information about a Rule
(see GetRule), update a Rule (see UpdateRule),
insert a Rule into a WebACL or delete a one
from a WebACL (see UpdateWebACL), or delete a
Rule from AWS WAF (see DeleteRule).
RuleId is returned by CreateRule and by
ListRules.
WafAction action
Specifies the action that CloudFront or AWS WAF takes when a web request
matches the conditions in the Rule. Valid values for
Action include the following:
ALLOW: CloudFront responds with the requested object.BLOCK: CloudFront responds with an HTTP 403 (Forbidden)
status code.COUNT: AWS WAF increments a counter of requests that
match the conditions in the rule and then continues to inspect the web
request based on the remaining rules in the web ACL.String byteMatchSetId
The ByteMatchSetId for a ByteMatchSet. You use
ByteMatchSetId to get information about a
ByteMatchSet (see GetByteMatchSet), update a
ByteMatchSet (see UpdateByteMatchSet, insert a
ByteMatchSet into a Rule or delete one from a
Rule (see UpdateRule), and delete a
ByteMatchSet from AWS WAF (see DeleteByteMatchSet).
ByteMatchSetId is returned by CreateByteMatchSet and
by ListByteMatchSets.
String name
A friendly name or description of the ByteMatchSet. You can't
change Name after you create a ByteMatchSet.
List<E> byteMatchTuples
Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
String byteMatchSetId
The ByteMatchSetId for a ByteMatchSet. You use
ByteMatchSetId to get information about a
ByteMatchSet, update a ByteMatchSet, remove a
ByteMatchSet from a Rule, and delete a
ByteMatchSet from AWS WAF.
ByteMatchSetId is returned by CreateByteMatchSet and
by ListByteMatchSets.
String name
A friendly name or description of the ByteMatchSet. You can't
change Name after you create a ByteMatchSet.
String action
Specifies whether to insert or delete a ByteMatchTuple.
ByteMatchTuple byteMatchTuple
Information about the part of a web request that you want AWS WAF to
inspect and the value that you want AWS WAF to search for. If you specify
DELETE for the value of Action, the
ByteMatchTuple values must exactly match the values in the
ByteMatchTuple that you want to delete from the
ByteMatchSet.
FieldToMatch fieldToMatch
The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For more information, see FieldToMatch.
ByteBuffer targetString
The value that you want AWS WAF to search for. AWS WAF searches for the
specified string in the part of web requests that you specified in
FieldToMatch. The maximum length of the value is 50 bytes.
Valid values depend on the values that you specified for
FieldToMatch:
HEADER: The value that you want AWS WAF to search for in
the request header that you specified in FieldToMatch, for
example, the value of the User-Agent or Referer
header.METHOD: The HTTP method, which indicates the type of
operation specified in the request. CloudFront supports the following
methods: DELETE, GET, HEAD,
OPTIONS, PATCH, POST, and
PUT.QUERY_STRING: The value that you want AWS WAF to search
for in the query string, which is the part of a URL that appears after a
? character.URI: The value that you want AWS WAF to search for in
the part of a URL that identifies a resource, for example,
/images/daily-ad.jpg.
If TargetString includes alphabetic characters A-Z and a-z,
note that the value is case sensitive.
If you're using the AWS WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
For example, suppose the value of Type is
HEADER and the value of Data is
User-Agent. If you want to search the
User-Agent header for the value BadBot, you
base64-encode BadBot using MIME base64 encoding and include
the resulting value, QmFkQm90, in the value of
TargetString.
If you're using the AWS CLI or one of the AWS SDKs
The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
String textTransformation
Text transformations eliminate some of the unusual formatting that
attackers use in web requests in an effort to bypass AWS WAF. If you
specify a transformation, AWS WAF performs the transformation on
TargetString before inspecting a request for a match.
CMD_LINE
When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one
space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded
characters. HTML_ENTITY_DECODE performs the following
operations:
(ampersand)quot; with "(ampersand)nbsp; with a non-breaking space,
decimal 160(ampersand)lt; with a "less than" symbol(ampersand)gt; with >(ampersand)#xhhhh;, with the corresponding characters(ampersand)#nnnn;, with the corresponding charactersLOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want to perform any text
transformations.
String positionalConstraint
Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following:
CONTAINS
The specified part of the web request must include the value of
TargetString, but the location doesn't matter.
CONTAINS_WORD
The specified part of the web request must include the value of
TargetString, and TargetString must contain
only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In
addition, TargetString must be a word, which means one of
the following:
TargetString exactly matches the value of the specified
part of the web request, such as the value of a header.TargetString is at the beginning of the specified part
of the web request and is followed by a character other than an
alphanumeric character or underscore (_), for example,
BadBot;.TargetString is at the end of the specified part of the
web request and is preceded by a character other than an alphanumeric
character or underscore (_), for example, ;BadBot.TargetString is in the middle of the specified part of
the web request and is preceded and followed by characters other than
alphanumeric characters or underscore (_), for example,
-BadBot;.EXACTLY
The value of the specified part of the web request must exactly match the
value of TargetString.
STARTS_WITH
The value of TargetString must appear at the beginning of
the specified part of the web request.
ENDS_WITH
The value of TargetString must appear at the end of the
specified part of the web request.
String name
A friendly name or description of the ByteMatchSet. You can't
change Name after you create a ByteMatchSet.
String changeToken
The value returned by the most recent call to GetChangeToken.
ByteMatchSet byteMatchSet
A ByteMatchSet that contains no ByteMatchTuple
objects.
String changeToken
The ChangeToken that you used to submit the
CreateByteMatchSet request. You can also use this value to
query the status of the request. For more information, see
GetChangeTokenStatus.
String name
A friendly name or description of the IPSet. You can't change
Name after you create the IPSet.
String changeToken
The value returned by the most recent call to GetChangeToken.
IPSet iPSet
The IPSet returned in the CreateIPSet response.
String changeToken
The ChangeToken that you used to submit the
CreateIPSet request. You can also use this value to query
the status of the request. For more information, see
GetChangeTokenStatus.
String name
A friendly name or description of the Rule. You can't change the
name of a Rule after you create it.
String metricName
A friendly name or description for the metrics for this Rule
. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the
name can't contain whitespace. You can't change the name of the metric
after you create the Rule.
String changeToken
The value returned by the most recent call to GetChangeToken.
Rule rule
The Rule returned in the CreateRule response.
String changeToken
The ChangeToken that you used to submit the
CreateRule request. You can also use this value to query the
status of the request. For more information, see
GetChangeTokenStatus.
String name
A friendly name or description for the SqlInjectionMatchSet that
you're creating. You can't change Name after you create the
SqlInjectionMatchSet.
String changeToken
The value returned by the most recent call to GetChangeToken.
SqlInjectionMatchSet sqlInjectionMatchSet
String changeToken
The ChangeToken that you used to submit the
CreateSqlInjectionMatchSet request. You can also use this
value to query the status of the request. For more information, see
GetChangeTokenStatus.
String name
A friendly name or description of the WebACL. You can't change
Name after you create the WebACL.
String metricName
A friendly name or description for the metrics for this
WebACL. The name can contain only alphanumeric characters
(A-Z, a-z, 0-9); the name can't contain whitespace. You can't change
MetricName after you create the WebACL.
WafAction defaultAction
The action that you want AWS WAF to take when a request doesn't match the
criteria specified in any of the Rule objects that are
associated with the WebACL.
String changeToken
The value returned by the most recent call to GetChangeToken.
WebACL webACL
The WebACL returned in the CreateWebACL response.
String changeToken
The ChangeToken that you used to submit the
CreateWebACL request. You can also use this value to query
the status of the request. For more information, see
GetChangeTokenStatus.
String byteMatchSetId
The ByteMatchSetId of the ByteMatchSet that you want
to delete. ByteMatchSetId is returned by
CreateByteMatchSet and by ListByteMatchSets.
String changeToken
The value returned by the most recent call to GetChangeToken.
String changeToken
The ChangeToken that you used to submit the
DeleteByteMatchSet request. You can also use this value to
query the status of the request. For more information, see
GetChangeTokenStatus.
String iPSetId
The IPSetId of the IPSet that you want to delete.
IPSetId is returned by CreateIPSet and by
ListIPSets.
String changeToken
The value returned by the most recent call to GetChangeToken.
String changeToken
The ChangeToken that you used to submit the
DeleteIPSet request. You can also use this value to query
the status of the request. For more information, see
GetChangeTokenStatus.
String ruleId
The RuleId of the Rule that you want to delete.
RuleId is returned by CreateRule and by
ListRules.
String changeToken
The value returned by the most recent call to GetChangeToken.
String changeToken
The ChangeToken that you used to submit the
DeleteRule request. You can also use this value to query the
status of the request. For more information, see
GetChangeTokenStatus.
String sqlInjectionMatchSetId
The SqlInjectionMatchSetId of the
SqlInjectionMatchSet that you want to delete.
SqlInjectionMatchSetId is returned by
CreateSqlInjectionMatchSet and by
ListSqlInjectionMatchSets.
String changeToken
The value returned by the most recent call to GetChangeToken.
String changeToken
The ChangeToken that you used to submit the
DeleteSqlInjectionMatchSet request. You can also use this
value to query the status of the request. For more information, see
GetChangeTokenStatus.
String webACLId
The WebACLId of the WebACL that you want to delete.
WebACLId is returned by CreateWebACL and by
ListWebACLs.
String changeToken
The value returned by the most recent call to GetChangeToken.
String changeToken
The ChangeToken that you used to submit the
DeleteWebACL request. You can also use this value to query
the status of the request. For more information, see
GetChangeTokenStatus.
String type
The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:
HEADER: A specified request header, for example, the
value of the User-Agent or Referer header. If
you choose HEADER for the type, specify the name of the
header in Data.METHOD: The HTTP method, which indicated the type of
operation that the request is asking the origin to perform. Amazon
CloudFront supports the following methods: DELETE,
GET, HEAD, OPTIONS,
PATCH, POST, and PUT.QUERY_STRING: A query string, which is the part of a URL
that appears after a ? character, if any.URI: The part of a web request that identifies a
resource, for example, /images/daily-ad.jpg.String data
When the value of Type is HEADER, enter the
name of the header that you want AWS WAF to search, for example,
User-Agent or Referer. If the value of
Type is any other value, omit Data.
The name of the header is not case sensitive.
String byteMatchSetId
The ByteMatchSetId of the ByteMatchSet that you want
to get. ByteMatchSetId is returned by
CreateByteMatchSet and by ListByteMatchSets.
ByteMatchSet byteMatchSet
Information about the ByteMatchSet that you specified in the
GetByteMatchSet request. For more information, see the
following topics:
ByteMatchSetId,
ByteMatchTuples, and NameByteMatchTuples: Contains an array of
ByteMatchTuple objects. Each ByteMatchTuple object
contains FieldToMatch, PositionalConstraint,
TargetString, and TextTransformationData and Type
String changeToken
The ChangeToken that you used in the request. Use this value
in a GetChangeTokenStatus request to get the current status
of the request.
String changeToken
The change token for which you want to get the status. This change token
was previously returned in the GetChangeToken response.
String changeTokenStatus
The status of the change token.
String iPSetId
The IPSetId of the IPSet that you want to get.
IPSetId is returned by CreateIPSet and by
ListIPSets.
IPSet iPSet
Information about the IPSet that you specified in the
GetIPSet request. For more information, see the following
topics:
IPSetDescriptors,
IPSetId, and NameIPSetDescriptors: Contains an array of
IPSetDescriptor objects. Each IPSetDescriptor object
contains Type and ValueString ruleId
The RuleId of the Rule that you want to get.
RuleId is returned by CreateRule and by
ListRules.
Rule rule
String webAclId
The WebACLId of the WebACL for which you want
GetSampledRequests to return a sample of requests.
String ruleId
RuleId is one of two values:
RuleId of the Rule for which you want
GetSampledRequests to return a sample of requests.Default_Action, which causes
GetSampledRequests to return a sample of the requests that
didn't match any of the rules in the specified WebACL.TimeWindow timeWindow
The start date and time and the end date and time of the range for which
you want GetSampledRequests to return a sample of requests.
Specify the date and time in Unix time format (in seconds). You can
specify any time range in the previous three hours.
Long maxItems
The number of requests that you want AWS WAF to return from among the
first 5,000 requests that your AWS resource received during the time
range. If your resource received fewer requests than the value of
MaxItems, GetSampledRequests returns
information about all of them.
List<E> sampledRequests
A complex type that contains detailed information about each of the requests in the sample.
Long populationSize
The total number of requests from which GetSampledRequests
got a sample of MaxItems requests. If
PopulationSize is less than MaxItems, the
sample includes every request that your AWS resource received during the
specified time range.
TimeWindow timeWindow
Usually, TimeWindow is the time range that you specified in
the GetSampledRequests request. However, if your AWS
resource received more than 5,000 requests during the time range that you
specified in the request, GetSampledRequests returns the
time range for the first 5,000 requests.
String sqlInjectionMatchSetId
The SqlInjectionMatchSetId of the
SqlInjectionMatchSet that you want to get.
SqlInjectionMatchSetId is returned by
CreateSqlInjectionMatchSet and by
ListSqlInjectionMatchSets.
SqlInjectionMatchSet sqlInjectionMatchSet
Information about the SqlInjectionMatchSet that you specified in
the GetSqlInjectionMatchSet request. For more information,
see the following topics:
Name,
SqlInjectionMatchSetId, and an array of
SqlInjectionMatchTuple objectsSqlInjectionMatchTuple object contains
FieldToMatch and TextTransformationData and Type
String webACLId
The WebACLId of the WebACL that you want to get.
WebACLId is returned by CreateWebACL and by
ListWebACLs.
String clientIP
The IP address that the request originated from. If the
WebACL is associated with a CloudFront distribution, this is
the value of one of the following fields in CloudFront access logs:
c-ip, if the viewer did not use an HTTP proxy or a load
balancer to send the requestx-forwarded-for, if the viewer did use an HTTP proxy or
a load balancer to send the requestString country
The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2.
String uRI
The part of a web request that identifies the resource, for example,
/images/daily-ad.jpg.
String method
The HTTP method specified in the sampled web request. CloudFront supports
the following methods: DELETE, GET,
HEAD, OPTIONS, PATCH,
POST, and PUT.
String hTTPVersion
The HTTP version specified in the sampled web request, for example,
HTTP/1.1.
List<E> headers
A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header.
String iPSetId
The IPSetId for an IPSet. You use
IPSetId to get information about an IPSet (see
GetIPSet), update an IPSet (see UpdateIPSet),
insert an IPSet into a Rule or delete one from
a Rule (see UpdateRule), and delete an
IPSet from AWS WAF (see DeleteIPSet).
IPSetId is returned by CreateIPSet and by
ListIPSets.
String name
A friendly name or description of the IPSet. You can't change the
name of an IPSet after you create it.
List<E> iPSetDescriptors
The IP address type (IPV4) and the IP address range (in CIDR
notation) that web requests originate from. If the WebACL is
associated with a CloudFront distribution, this is the value of one of
the following fields in CloudFront access logs:
c-ip, if the viewer did not use an HTTP proxy or a load
balancer to send the requestx-forwarded-for, if the viewer did use an HTTP proxy or
a load balancer to send the requestString type
Specify IPV4.
String value
Specify an IPv4 address by using CIDR notation. For example:
192.0.2.44/32.192.0.2.0/24.AWS WAF supports only /8, /16, /24, and /32 IP addresses.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
String action
Specifies whether to insert or delete an IP address with UpdateIPSet.
IPSetDescriptor iPSetDescriptor
The IP address type (IPV4) and the IP address range (in CIDR
notation) that web requests originate from.
String nextMarker
If you specify a value for Limit and you have more
ByteMatchSets than the value of Limit, AWS WAF
returns a NextMarker value in the response that allows you
to list another group of ByteMatchSets. For the second and
subsequent ListByteMatchSets requests, specify the value of
NextMarker from the previous response to get information
about another batch of ByteMatchSets.
Integer limit
Specifies the number of ByteMatchSet objects that you want
AWS WAF to return for this request. If you have more
ByteMatchSets objects than the number you specify for
Limit, the response includes a NextMarker value
that you can use to get another batch of ByteMatchSet
objects.
String nextMarker
If you have more ByteMatchSet objects than the number that
you specified for Limit in the request, the response
includes a NextMarker value. To list more
ByteMatchSet objects, submit another
ListByteMatchSets request, and specify the
NextMarker value from the response in the
NextMarker value in the next request.
List<E> byteMatchSets
An array of ByteMatchSetSummary objects.
String nextMarker
If you specify a value for Limit and you have more
IPSets than the value of Limit, AWS WAF returns
a NextMarker value in the response that allows you to list
another group of IPSets. For the second and subsequent
ListIPSets requests, specify the value of
NextMarker from the previous response to get information
about another batch of ByteMatchSets.
Integer limit
Specifies the number of IPSet objects that you want AWS WAF
to return for this request. If you have more IPSet objects
than the number you specify for Limit, the response includes
a NextMarker value that you can use to get another batch of
IPSet objects.
String nextMarker
If you have more IPSet objects than the number that you
specified for Limit in the request, the response includes a
NextMarker value. To list more IPSet objects,
submit another ListIPSets request, and specify the
NextMarker value from the response in the
NextMarker value in the next request.
List<E> iPSets
An array of IPSetSummary objects.
String nextMarker
If you specify a value for Limit and you have more
Rules than the value of Limit, AWS WAF returns
a NextMarker value in the response that allows you to list
another group of Rules. For the second and subsequent
ListRules requests, specify the value of
NextMarker from the previous response to get information
about another batch of Rules.
Integer limit
Specifies the number of Rules that you want AWS WAF to
return for this request. If you have more Rules than the
number that you specify for Limit, the response includes a
NextMarker value that you can use to get another batch of
Rules.
String nextMarker
If you have more Rules than the number that you specified
for Limit in the request, the response includes a
NextMarker value. To list more Rules, submit
another ListRules request, and specify the
NextMarker value from the response in the
NextMarker value in the next request.
List<E> rules
An array of RuleSummary objects.
String nextMarker
If you specify a value for Limit and you have more
SqlInjectionMatchSet objects than the value of Limit,
AWS WAF returns a NextMarker value in the response that
allows you to list another group of SqlInjectionMatchSets.
For the second and subsequent ListSqlInjectionMatchSets
requests, specify the value of NextMarker from the previous
response to get information about another batch of
SqlInjectionMatchSets.
Integer limit
Specifies the number of SqlInjectionMatchSet objects that you want
AWS WAF to return for this request. If you have more
SqlInjectionMatchSet objects than the number you specify for
Limit, the response includes a NextMarker value
that you can use to get another batch of Rules.
String nextMarker
If you have more SqlInjectionMatchSet objects than the number that
you specified for Limit in the request, the response
includes a NextMarker value. To list more
SqlInjectionMatchSet objects, submit another
ListSqlInjectionMatchSets request, and specify the
NextMarker value from the response in the
NextMarker value in the next request.
List<E> sqlInjectionMatchSets
An array of SqlInjectionMatchSetSummary objects.
String nextMarker
If you specify a value for Limit and you have more
WebACL objects than the number that you specify for
Limit, AWS WAF returns a NextMarker value in
the response that allows you to list another group of WebACL
objects. For the second and subsequent ListWebACLs requests,
specify the value of NextMarker from the previous response
to get information about another batch of WebACL objects.
Integer limit
Specifies the number of WebACL objects that you want AWS WAF
to return for this request. If you have more WebACL objects
than the number that you specify for Limit, the response
includes a NextMarker value that you can use to get another
batch of WebACL objects.
String nextMarker
If you have more WebACL objects than the number that you
specified for Limit in the request, the response includes a
NextMarker value. To list more WebACL objects,
submit another ListWebACLs request, and specify the
NextMarker value from the response in the
NextMarker value in the next request.
List<E> webACLs
An array of WebACLSummary objects.
Boolean negated
Set Negated to False if you want AWS WAF to
allow, block, or count requests based on the settings in the specified
ByteMatchSet, IPSet, or SqlInjectionMatchSet. For
example, if an IPSet includes the IP address
192.0.2.44, AWS WAF will allow or block requests based on
that IP address.
Set Negated to True if you want AWS WAF to
allow or block a request based on the negation of the settings in the
ByteMatchSet, IPSet, or SqlInjectionMatchSet. For
example, if an IPSet includes the IP address
192.0.2.44, AWS WAF will allow, block, or count requests
based on all IP addresses except 192.0.2.44.
String type
The type of predicate in a Rule, such as
ByteMatchSet or IPSet.
String dataId
A unique identifier for a predicate in a Rule, such as
ByteMatchSetId or IPSetId. The ID is returned
by the corresponding Create or List command.
String ruleId
A unique identifier for a Rule. You use RuleId
to get more information about a Rule (see GetRule),
update a Rule (see UpdateRule), insert a
Rule into a WebACL or delete a one from a
WebACL (see UpdateWebACL), or delete a
Rule from AWS WAF (see DeleteRule).
RuleId is returned by CreateRule and by
ListRules.
String name
The friendly name or description for the Rule. You can't
change the name of a Rule after you create it.
String metricName
List<E> predicates
The Predicates object contains one Predicate
element for each ByteMatchSet, IPSet, or
SqlInjectionMatchSet object that you want to include in a
Rule.
String ruleId
A unique identifier for a Rule. You use RuleId
to get more information about a Rule (see GetRule),
update a Rule (see UpdateRule), insert a
Rule into a WebACL or delete one from a
WebACL (see UpdateWebACL), or delete a
Rule from AWS WAF (see DeleteRule).
RuleId is returned by CreateRule and by
ListRules.
String name
A friendly name or description of the Rule. You can't change the
name of a Rule after you create it.
HTTPRequest request
A complex type that contains detailed information about the request.
Long weight
A value that indicates how one result in the response relates
proportionally to other results in the response. A result that has a
weight of 2 represents roughly twice as many CloudFront web
requests as a result that has a weight of 1.
Date timestamp
The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).
String action
The action for the Rule that the request matched:
ALLOW, BLOCK, or COUNT.
String sqlInjectionMatchSetId
A unique identifier for a SqlInjectionMatchSet. You use
SqlInjectionMatchSetId to get information about a
SqlInjectionMatchSet (see GetSqlInjectionMatchSet),
update a SqlInjectionMatchSet (see
UpdateSqlInjectionMatchSet, insert a
SqlInjectionMatchSet into a Rule or delete one
from a Rule (see UpdateRule), and delete a
SqlInjectionMatchSet from AWS WAF (see
DeleteByteMatchSet).
SqlInjectionMatchSetId is returned by
CreateSqlInjectionMatchSet and by
ListSqlInjectionMatchSets.
String name
The name, if any, of the SqlInjectionMatchSet.
List<E> sqlInjectionMatchTuples
Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.
String sqlInjectionMatchSetId
A unique identifier for a SqlInjectionMatchSet. You use
SqlInjectionMatchSetId to get information about a
SqlInjectionMatchSet (see GetSqlInjectionMatchSet),
update a SqlInjectionMatchSet (see
UpdateSqlInjectionMatchSet, insert a
SqlInjectionMatchSet into a Rule or delete one
from a Rule (see UpdateRule), and delete a
SqlInjectionMatchSet from AWS WAF (see
DeleteByteMatchSet).
SqlInjectionMatchSetId is returned by
CreateSqlInjectionMatchSet and by
ListSqlInjectionMatchSets.
String name
The name of the SqlInjectionMatchSet, if any, specified by
Id.
String action
Specify INSERT to add a SqlInjectionMatchSetUpdate to
a SqlInjectionMatchSet. Use DELETE to remove a
SqlInjectionMatchSetUpdate from a
SqlInjectionMatchSet.
SqlInjectionMatchTuple sqlInjectionMatchTuple
Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.
FieldToMatch fieldToMatch
String textTransformation
Text transformations eliminate some of the unusual formatting that
attackers use in web requests in an effort to bypass AWS WAF. If you
specify a transformation, AWS WAF performs the transformation on
TargetString before inspecting a request for a match.
CMD_LINE
When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one
space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded
characters. HTML_ENTITY_DECODE performs the following
operations:
(ampersand)quot; with "(ampersand)nbsp; with a non-breaking space,
decimal 160(ampersand)lt; with a "less than" symbol(ampersand)gt; with >(ampersand)#xhhhh;, with the corresponding characters(ampersand)#nnnn;, with the corresponding charactersLOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want to perform any text
transformations.
Date startTime
The beginning of the time range from which you want
GetSampledRequests to return a sample of the requests that
your AWS resource received. You can specify any time range in the
previous three hours.
Date endTime
The end of the time range from which you want
GetSampledRequests to return a sample of the requests that
your AWS resource received. You can specify any time range in the
previous three hours.
String byteMatchSetId
The ByteMatchSetId of the ByteMatchSet that you want
to update. ByteMatchSetId is returned by
CreateByteMatchSet and by ListByteMatchSets.
String changeToken
The value returned by the most recent call to GetChangeToken.
List<E> updates
An array of ByteMatchSetUpdate objects that you want to
insert into or delete from a ByteMatchSet. For more information,
see the applicable data types:
Action and
ByteMatchTupleFieldToMatch,
PositionalConstraint, TargetString, and
TextTransformationData and Type
String changeToken
The ChangeToken that you used to submit the
UpdateByteMatchSet request. You can also use this value to
query the status of the request. For more information, see
GetChangeTokenStatus.
String iPSetId
The IPSetId of the IPSet that you want to update.
IPSetId is returned by CreateIPSet and by
ListIPSets.
String changeToken
The value returned by the most recent call to GetChangeToken.
List<E> updates
An array of IPSetUpdate objects that you want to insert into
or delete from an IPSet. For more information, see the applicable
data types:
Action and
IPSetDescriptorType and
ValueString changeToken
The ChangeToken that you used to submit the
UpdateIPSet request. You can also use this value to query
the status of the request. For more information, see
GetChangeTokenStatus.
String ruleId
The RuleId of the Rule that you want to update.
RuleId is returned by CreateRule and by
ListRules.
String changeToken
The value returned by the most recent call to GetChangeToken.
List<E> updates
An array of RuleUpdate objects that you want to insert into
or delete from a Rule. For more information, see the applicable
data types:
Action and
PredicateDataId, Negated,
and TypeData and Type
String changeToken
The ChangeToken that you used to submit the
UpdateRule request. You can also use this value to query the
status of the request. For more information, see
GetChangeTokenStatus.
String sqlInjectionMatchSetId
The SqlInjectionMatchSetId of the
SqlInjectionMatchSet that you want to update.
SqlInjectionMatchSetId is returned by
CreateSqlInjectionMatchSet and by
ListSqlInjectionMatchSets.
String changeToken
The value returned by the most recent call to GetChangeToken.
List<E> updates
An array of SqlInjectionMatchSetUpdate objects that you want
to insert into or delete from a SqlInjectionMatchSet. For more
information, see the applicable data types:
Action and
SqlInjectionMatchTupleFieldToMatch and
TextTransformationData and Type
String changeToken
The ChangeToken that you used to submit the
UpdateSqlInjectionMatchSet request. You can also use this
value to query the status of the request. For more information, see
GetChangeTokenStatus.
String webACLId
The WebACLId of the WebACL that you want to update.
WebACLId is returned by CreateWebACL and by
ListWebACLs.
String changeToken
The value returned by the most recent call to GetChangeToken.
List<E> updates
An array of updates to make to the WebACL.
An array of WebACLUpdate objects that you want to insert
into or delete from a WebACL. For more information, see the
applicable data types:
Action and
ActivatedRuleAction,
Priority, and RuleIdTypeWafAction defaultAction
String changeToken
The ChangeToken that you used to submit the
UpdateWebACL request. You can also use this value to query
the status of the request. For more information, see
GetChangeTokenStatus.
String type
Specifies how you want AWS WAF to respond to requests that match the
settings in a Rule. Valid settings include the following:
ALLOW: AWS WAF allows requestsBLOCK: AWS WAF blocks requestsCOUNT: AWS WAF increments a counter of the requests that
match all of the conditions in the rule. AWS WAF then continues to
inspect the web request based on the remaining rules in the web ACL. You
can't specify COUNT for the default action for a
WebACL.String webACLId
A unique identifier for a WebACL. You use
WebACLId to get information about a WebACL (see
GetWebACL), update a WebACL (see UpdateWebACL,
and delete a WebACL from AWS WAF (see DeleteWebACL).
WebACLId is returned by CreateWebACL and by
ListWebACLs.
String name
A friendly name or description of the WebACL. You can't
change the name of a WebACL after you create it.
String metricName
WafAction defaultAction
The action to perform if none of the Rules contained in the
WebACL match. The action is specified by the
WafAction object.
List<E> rules
An array that contains the action for each Rule in a
WebACL, the priority of the Rule, and the ID of
the Rule.
String webACLId
A unique identifier for a WebACL. You use
WebACLId to get information about a WebACL (see
GetWebACL), update a WebACL (see UpdateWebACL,
and delete a WebACL from AWS WAF (see DeleteWebACL).
WebACLId is returned by CreateWebACL and by
ListWebACLs.
String name
A friendly name or description of the WebACL. You can't change the
name of a WebACL after you create it.
String action
Specifies whether to insert a Rule into or delete a
Rule from a WebACL.
ActivatedRule activatedRule
String name
The name of the compute type for the bundle.
com.amazonaws.internal.SdkInternalList<T> workspaces
An array of structures that specify the WorkSpaces to create.
com.amazonaws.internal.SdkInternalList<T> failedRequests
An array of structures that represent the WorkSpaces that could not be created.
com.amazonaws.internal.SdkInternalList<T> pendingRequests
An array of structures that represent the WorkSpaces that were created.
Because this operation is asynchronous, the identifier in
WorkspaceId is not immediately available. If you immediately
call DescribeWorkspaces with this identifier, no information will
be returned.
Boolean enableWorkDocs
Specifies if the directory is enabled for Amazon WorkDocs.
Boolean enableInternetAccess
A public IP address will be attached to all WorkSpaces that are created or rebuilt.
String defaultOu
The organizational unit (OU) in the directory that the WorkSpace machine accounts are placed in.
String customSecurityGroupId
The identifier of any custom security groups that are applied to the WorkSpaces when they are created.
Boolean userEnabledAsLocalAdministrator
The WorkSpace user is an administrator on the WorkSpace.
com.amazonaws.internal.SdkInternalList<T> bundleIds
An array of strings that contains the identifiers of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.
String owner
The owner of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.
This contains one of the following values:
AMAZON - Retrieves the bundles that are provided by AWS.
String nextToken
The NextToken value from a previous call to this operation.
Pass null if this is the first call.
com.amazonaws.internal.SdkInternalList<T> bundles
An array of structures that contain information about the bundles.
String nextToken
If not null, more results are available. Pass this value for the
NextToken parameter in a subsequent call to this operation
to retrieve the next set of items. This token is valid for one day and
must be used within that timeframe.
com.amazonaws.internal.SdkInternalList<T> directoryIds
An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved.
String nextToken
The NextToken value from a previous call to this operation.
Pass null if this is the first call.
com.amazonaws.internal.SdkInternalList<T> directories
An array of structures that contain information about the directories.
String nextToken
If not null, more results are available. Pass this value for the
NextToken parameter in a subsequent call to this operation
to retrieve the next set of items. This token is valid for one day and
must be used within that timeframe.
com.amazonaws.internal.SdkInternalList<T> workspaceIds
An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information. This parameter cannot be combined with any other filter parameter.
Because the CreateWorkspaces operation is asynchronous, the identifier returned by CreateWorkspaces is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information will be returned.
String directoryId
Specifies the directory identifier to which to limit the WorkSpaces.
Optionally, you can specify a specific directory user with the
UserName parameter. This parameter cannot be combined with
any other filter parameter.
String userName
Used with the DirectoryId parameter to specify the directory
user for which to obtain the WorkSpace.
String bundleId
The identifier of a bundle to obtain the WorkSpaces for. All WorkSpaces that are created from this bundle will be retrieved. This parameter cannot be combined with any other filter parameter.
Integer limit
The maximum number of items to return.
String nextToken
The NextToken value from a previous call to this operation.
Pass null if this is the first call.
com.amazonaws.internal.SdkInternalList<T> workspaces
An array of structures that contain the information about the WorkSpaces.
Because the CreateWorkspaces operation is asynchronous, some of this information may be incomplete for a newly-created WorkSpace.
String nextToken
If not null, more results are available. Pass this value for the
NextToken parameter in a subsequent call to this operation
to retrieve the next set of items. This token is valid for one day and
must be used within that timeframe.
WorkspaceRequest workspaceRequest
A WorkspaceRequest object that contains the information about the WorkSpace that could not be created.
String errorCode
The error code.
String errorMessage
The textual error message.
String workspaceId
The identifier of the WorkSpace to reboot.
com.amazonaws.internal.SdkInternalList<T> rebootWorkspaceRequests
An array of structures that specify the WorkSpaces to reboot.
com.amazonaws.internal.SdkInternalList<T> failedRequests
An array of structures that represent any WorkSpaces that could not be rebooted.
String workspaceId
The identifier of the WorkSpace to rebuild.
com.amazonaws.internal.SdkInternalList<T> rebuildWorkspaceRequests
An array of structures that specify the WorkSpaces to rebuild.
com.amazonaws.internal.SdkInternalList<T> failedRequests
An array of structures that represent any WorkSpaces that could not be rebuilt.
String resourceId
The identifier of the resource that is not available.
String workspaceId
The identifier of the WorkSpace to terminate.
com.amazonaws.internal.SdkInternalList<T> terminateWorkspaceRequests
An array of structures that specify the WorkSpaces to terminate.
com.amazonaws.internal.SdkInternalList<T> failedRequests
An array of structures that represent any WorkSpaces that could not be terminated.
String capacity
The amount of user storage for the bundle.
String workspaceId
The identifier of the WorkSpace.
String directoryId
The identifier of the AWS Directory Service directory that the WorkSpace belongs to.
String userName
The user that the WorkSpace is assigned to.
String ipAddress
The IP address of the WorkSpace.
String state
The operational state of the WorkSpace.
String bundleId
The identifier of the bundle that the WorkSpace was created from.
String subnetId
The identifier of the subnet that the WorkSpace is in.
String errorMessage
If the WorkSpace could not be created, this contains a textual error message that describes the failure.
String errorCode
If the WorkSpace could not be created, this contains the error code.
String computerName
The name of the WorkSpace as seen by the operating system.
String volumeEncryptionKey
The KMS key used to encrypt data stored on your WorkSpace.
Boolean userVolumeEncryptionEnabled
Specifies whether the data stored on the user volume, or D: drive, is encrypted.
Boolean rootVolumeEncryptionEnabled
Specifies whether the data stored on the root volume, or C: drive, is encrypted.
String bundleId
The bundle identifier.
String name
The name of the bundle.
String owner
The owner of the bundle. This contains the owner's account identifier, or
AMAZON if the bundle is provided by AWS.
String description
The bundle description.
UserStorage userStorage
A UserStorage object that specifies the amount of user storage that the bundle contains.
ComputeType computeType
A ComputeType object that specifies the compute type for the bundle.
String directoryId
The directory identifier.
String alias
The directory alias.
String directoryName
The name of the directory.
String registrationCode
The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
com.amazonaws.internal.SdkInternalList<T> subnetIds
An array of strings that contains the identifiers of the subnets used with the directory.
com.amazonaws.internal.SdkInternalList<T> dnsIpAddresses
An array of strings that contains the IP addresses of the DNS servers for the directory.
String customerUserName
The user name for the service account.
String iamRoleId
The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.
String directoryType
The directory type.
String workspaceSecurityGroupId
The identifier of the security group that is assigned to new WorkSpaces.
String state
The state of the directory's registration with Amazon WorkSpaces
DefaultWorkspaceCreationProperties workspaceCreationProperties
A structure that specifies the default creation properties for all WorkSpaces in the directory.
String directoryId
The identifier of the AWS Directory Service directory to create the WorkSpace in. You can use the DescribeWorkspaceDirectories operation to obtain a list of the directories that are available.
String userName
The username that the WorkSpace is assigned to. This username must exist
in the AWS Directory Service directory specified by the
DirectoryId member.
String bundleId
The identifier of the bundle to create the WorkSpace from. You can use the DescribeWorkspaceBundles operation to obtain a list of the bundles that are available.
String volumeEncryptionKey
The KMS key used to encrypt data stored on your WorkSpace.
Boolean userVolumeEncryptionEnabled
Specifies whether the data stored on the user volume, or D: drive, is encrypted.
Boolean rootVolumeEncryptionEnabled
Specifies whether the data stored on the root volume, or C: drive, is encrypted.
Throwable cause
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.